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