このリファレンス ガイドでは、Google Drive API でファイル、フォルダ、共有ドライブをフィルタするために使用できるクエリ語句と演算子について説明します。
ファイル検索の例については、ファイルとフォルダを検索するをご覧ください。
たとえば、共有ドライブの検索については、共有ドライブを検索するをご覧ください。
クエリ文字列の構文
クエリ文字列には、次の 3 つの部分があります。
query_term operator values
ここで
query_termは、検索するクエリ語句またはフィールドです。operatorは、検索語句の条件を指定します。valuesは、検索結果のフィルタに使用する特定の値です。
クエリ演算子
次の表に、有効なクエリ演算子を示します。
| 演算子 | 用途 |
|---|---|
contains |
1 つの文字列の内容が別の文字列に存在する。 |
= |
文字列またはブール値の内容が他と等しい。 |
!= |
文字列またはブール値の内容が他と等しくありません。 |
< |
値がもう一方の値より小さい。 |
<= |
値が別の値以下である。 |
> |
値がもう一方の値より大きい。 |
>= |
値がもう一方の値以上である。 |
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 |
クエリ文字列検索のその他の例については、共有ドライブのクエリ文字列の例をご覧ください。