このリファレンス ガイドでは、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 |
クエリ文字列検索のその他の例については、共有ドライブのクエリ文字列の例をご覧ください。