如何進行檔案搜尋 - Drive and Photo Service

說明

目前支援標準模式，不支援託管模式。使用者可以通過/file/search介面搜尋有列舉許可權的drive下的檔案，不支援搜尋資源回收筒中的檔案。

請求

POST /v2/file/search

請求參數欄位說明：

名稱	位置	類型	必選	說明
Authorization	header	string	是	access_token
drive_id	body	string	否	待搜尋的drive ID
drive_id_list	body	string array	否	待搜尋的drive ID數組，如["1","2"]
query	body	string	是	查詢文法字串，詳細說明見下文。最大長度4096字元
order_by	body	string	是	搜尋結果排序的文法，詳細說明見下文。最大長度128字元
limit	body	integer (int32)	否	返回資料最大條數,範圍：[1-100]，預設：50
marker	body	string	否	查詢起始標識，下發了marker參數則忽略query
url_expire_sec	body	integer (int64)	否	請求返回URL的有效期間時間，單位秒，範圍：[10,14400]

說明

drive_id和drive_id_list，兩個參數需要傳遞其中一個，參數drive_id不為空白時，忽略drive_id_list。

query規則說明：

支援的資料類型：
a. 基本類型：long、string、bool、double
b. 複合類型：array，date（時間類型，用雙引號或單引號括起來，與字串類型一致。格式"2006-01-02T00:00:00"，只支援零時區）
基本類型支援的搜尋：
a. long: =, <, >, <=, >=
b. string: = （精確搜尋）, prefix（首碼搜尋，name欄位不支援）, match（模糊搜尋，只有name欄位支援）
c. bool: =
d. double: =, <, >, <=, >=
複合類型支援的搜尋：
a. array: in（多條件的=）
b. date: =, <, >, <=, >=
邏輯操作支援：not、and、or
支援括弧，優先順序為：括弧 > not > and > or

query舉例：

精確查詢

// 查詢檔案名稱為 “彙報材料.ppt” 的檔案
name = "彙報材料.ppt"

範圍查詢

// 查詢2019年1月14日前建立的檔案（時間為零時區）
created_at < "2019-01-14T00:00:00"

模糊比對

// 查詢檔案名稱包含 “彙報” 的檔案
name match "彙報"

邏輯組合查詢

// 查詢2019年1月14號建立的檔案（時間為零時區）
created_at > "2019-01-14T00:00:00" and created_at < "2019-01-15T00:00:00"

複雜邏輯查詢

// 查詢檔案size大於1024並且hidden為false並且file_extension不等於“mp4”的檔案
size > 1024 and hidden = false and not file_extension = 'mp4'

數組查詢

// 查詢尾碼名為jpg、png或者gif的檔案
file_extension in ["jpg", "png", "gif"]

order_by規則：

order_by舉例：

單個規則逆序

// 按建立時間逆序
created_at DESC

多個定序

// 先按建立時間逆序，如果建立時間相同，則按名稱正序
created_at DESC,name ASC

支援搜尋和排序的欄位：

欄位名	類型	可搜尋	可排序	描述
parent_file_id	STRING	✔️	—	固定目錄搜尋，只搜尋一級
name	STRING	✔️	✔️	檔案名稱（模糊分詞），可模糊搜尋
type	STRING	✔️	✔️	檔案類型file、folder
file_extension	STRING	✔️	—	檔案尾碼名
description	STRING	✔️	—	描述（single_word分詞），可短語匹配
mime_type	STRING	✔️	—	檔案mimeType搜尋
starred	BOOL	✔️	—	是否收藏
created_at	DATE	✔️	✔️	建立時間
updated_at	DATE	✔️	✔️	修改時間
status	STRING	✔️	—	檔案狀態
hidden	BOOL	✔️	—	是否隱藏檔案
size	LONG	✔️	✔️	檔案大小
image_time	DATE	✔️	✔️	照片拍攝時間
last_access_at	DATE	✔️	✔️	最近擷取時間
category	STRING	✔️	—	檔案類型，image、video、doc、audio、app、others
label	STRING	✔️	—	系統標籤名稱
face_group_id	STRING	✔️	—	人臉分組ID, 由分組列表介面擷取，通過該欄位進行查詢分組下的照片
address	STRING	✔️	—	地址，如國家（中國）、省份（浙江省）、城市（杭州市）、地區（西湖區）、城鎮（西湖街道）