このリファレンス ガイドでは、 ファイル、フォルダ、共有ドライブをフィルタする Google Drive API
ファイル検索の例については、ファイルやフォルダを検索するをご覧ください。
たとえば、共有ドライブの検索については、共有ドライブを検索するをご覧ください。
クエリ文字列の構文
クエリ文字列は、次の 3 つの部分で構成されます。
query_term operator values
ここで
query_termは、検索するクエリ語句またはフィールドです。operatorには、クエリ語句の条件を指定します。valuesは、検索のフィルタに使用する特定の値です。 表示されます。
クエリ演算子
次の表に、有効なクエリ演算子を示します。
| 演算子 | 用途 |
|---|---|
contains |
一方の文字列の内容がもう一方の文字列に存在する。 |
= |
文字列またはブール値の内容が他方と同じです。 |
!= |
文字列またはブール値の内容が他方と等しくありません。 |
< |
値が他よりも小さい。 |
<= |
値が他方の値以下である。 |
> |
値が他よりも大きい。 |
>= |
値が別の値以上です。 |
in |
要素はコレクション内に含まれています。 |
and |
両方のクエリに一致する商品アイテムを返す。 |
or |
いずれかのクエリに一致するアイテムを返します。 |
not |
検索クエリを否定します。 |
has |
コレクションには、パラメータに一致する要素が含まれています。 |
ファイル固有のクエリ語句
次の表に、有効なすべてのファイルクエリ語句を示します。データの種類と
files リソースをご覧ください。
ご覧ください。
| クエリ語句 | 有効な演算子 | 用途 |
|---|---|---|
name |
contains、=、!= |
ファイルの名前。単一引用符（'）で囲みます。\' を使用してクエリ内の単一引用符をエスケープします（例: 'Valentine\'s Day'）。 |
fullText |
contains |
name、description、indexableText の各プロパティ、ファイルのコンテンツ内のテキスト、またはファイルのメタデータが一致するかどうか。単一引用符（'）で囲みます。\' を使用してクエリ内の単一引用符をエスケープします（例: 'Valentine\'s Day'）。 |
mimeType |
contains、=、!= |
ファイルの MIME タイプ。単一引用符（'）で囲みます。\' を使用してクエリ内の単一引用符をエスケープします（例: 'Valentine\'s Day'）。MIME タイプについて詳しくは、Google Workspace と Google ドライブでサポートされている MIME タイプをご覧ください。 |
modifiedTime |
<=、<、=、!=、>、>= |
ファイルの最終変更の日付。RFC 3339 形式で、デフォルトのタイムゾーンは UTC（2012-06-04T12:00:00-08:00 など）です。date 型のフィールドは、定数日付のみとの比較で、互いに比較することはできません。 |
viewedByMeTime |
<=、<、=、!=、>、>= |
ユーザーが最後にファイルを閲覧した日付。RFC 3339 形式で、デフォルトのタイムゾーンは UTC（2012-06-04T12:00:00-08:00 など）です。date 型のフィールドは、定数日付のみとの比較で、互いに比較することはできません。 |
trashed |
=、!= |
ファイルがゴミ箱にあるかどうかtrue または false のいずれかになります。 |
starred |
=、!= |
ファイルにスターが付いているかどうかtrue または false のいずれかになります。 |
parents |
in |
指定された ID が親コレクションに含まれているかどうか。 |
owners |
in |
ファイルのオーナー。 |
writers |
in |
ファイルの変更権限を持つユーザーまたはグループ。permissions リソースのリファレンスをご覧ください。 |
readers |
in |
ファイルの読み取り権限を持つユーザーまたはグループ。permissions リソースのリファレンスをご覧ください。 |
sharedWithMe |
=、!= |
ユーザーの [共有アイテム] にあるコレクション。すべてのファイル ユーザーがファイルのアクセス制御リスト（ACL）に登録されている。true または false のいずれかになります。 |
createdTime |
<=、<、=、!=、>、>= |
共有ドライブの作成日。RFC 3339 形式を使用します。デフォルトのタイムゾーンは UTC（2012-06-04T12:00:00-08:00 など）です。 |
properties |
has |
パブリック カスタム ファイルのプロパティ。 |
appProperties |
has |
非公開のカスタム ファイルのプロパティ。 |
visibility |
=、!= |
ファイルの公開設定レベル。有効な値は anyoneCanFind、anyoneWithLink、domainCanFind、domainWithLink、limited です。単一引用符（'）で囲みます。 |
shortcutDetails.targetId |
=、!= |
ショートカットが参照するアイテムの ID。 |
演算子とクエリ語句の組み合わせを以下に示します。
contains演算子は、指定した文字列に対してのみ接頭辞の照合を行います。name期間。たとえば、サーバー セキュリティに /HelloWorld。name contains 'Hello'というクエリは、name contains 'World'のクエリでは一致しません。contains演算子は、次の文字列トークン全体の照合のみを実行します。fullTextの項を結合します。たとえば、ドキュメントの全文に 文字列「HelloWorld」。クエリfullText contains 'HelloWorld'のみ 結果を返します。contains演算子は、次の場合に英数字と完全に一致するフレーズと一致します。 二重引用符で囲みます。たとえば、ドキュメントのfullTextが に文字列「Hello there world」が含まれている場合、クエリfullText contains '"Hello there"'は結果を返しますが、fullText contains '"Hello world"'クエリには返されません。また、検索は英数字であるため、 「Hello_world」という文字列が含まれていて、fullText contains '"Hello world"'は結果を返します。owners、writers、readersの各用語は、permissionsのリストを表示し、 権限に対するrole。ロールの権限の完全なリストについては、 ロールと権限。
クエリ文字列検索のその他の例については、ファイルのクエリ文字列 例をご覧ください。
共有ドライブ固有のクエリ用語
次の表に、有効な共有ドライブのクエリ語句をすべて示します。データの種類と
drives リソースをご覧ください。
ご覧ください。
| クエリ語句 | 有効な演算子 | 用途 | useDomainAdminAccess 設定 |
|---|---|---|---|
createdTime |
<=、<、=、!=、>、>= |
共有ドライブの作成日。RFC 3339 形式で、デフォルトのタイムゾーンは UTC（2012-06-04T12:00:00-08:00 など）です。 |
true |
hidden |
=、!= |
共有ドライブを非表示にするかどうかを指定します。true または false のいずれかになります。 |
false |
memberCount |
<=、<、=、!=、>、>= |
共有ドライブのメンバーであるユーザーとグループの数。数値を取ります。 | true |
name |
contains、=、!= |
共有ドライブの名前。単一引用符（'）で囲みます。\' を使用して、クエリ内の単一引用符をエスケープします（例: 'Valentine\'s Day'）。 |
true |
organizerCount |
<=、<、=、!=、>、>= |
共有ドライブの主催者であるユーザーとグループの数。数値を取ります。 | true |
orgUnitId |
=、!= |
共有ドライブの組織部門 ID。文字列値を取ります。 | true |
クエリ文字列検索のその他の例については、共有ドライブのクエリ文字列 例をご覧ください。