クエリ文字列は、次の 3 つの部分で構成されます。
query_term operator values
ここで
query_term は、検索するクエリ語句またはフィールドです。
operator はクエリ語句の条件を指定します。
values は、検索結果をフィルタするために使用する特定の値です。
このリファレンスでは、Google Drive API で使用できるクエリ語句と演算子について説明します。
クエリ演算子
次の表に、すべての有効なクエリ演算子を示します。
| 演算子 | 使用状況 |
|---|---|
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 とドライブの 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 |
ファイルを変更する権限を持つユーザーまたはグループ。権限リソースのリファレンスをご覧ください。 |
readers |
in |
ファイルを読み取る権限を持つユーザーまたはグループ。権限リソースのリファレンスをご覧ください。 |
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 world」が含まれている場合、クエリfullText contains '"Hello there"'は結果を返しますが、クエリfullText contains '"Hello world"'は返しません。さらに、検索は英数字であるため、ドキュメントの全文に「Hello_world」という文字列が含まれている場合、クエリfullText contains '"Hello world"'が結果を返します。owners、writers、readersの用語は、権限リストに間接的に反映され、権限の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'）。 |
false |
organizerCount |
<=、<、=、!=、>、>= |
共有ドライブの主催者であるユーザーとグループの数。数値を指定します。 | true |
orgUnitId |
=、!= |
共有ドライブの組織部門 ID。文字列値を取ります。 | true |