検索クエリのキーワードと演算子

このリファレンス ガイドでは、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）。Drive API v3 でのみサポートされています。
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

クエリ文字列検索のその他の例については、共有ドライブ クエリ文字列 の例をご覧ください。