このガイドでは、Google ドライブ API が共有ドライブを検索する複数の方法をサポートしていることについて説明します。
特定の共有ドライブのセットを検索するには、drives リソースの list メソッドで q クエリ文字列フィールドを使用し、1 つ以上の検索語句を組み合わせてドライブをフィルタし、返すようにします。
クエリ文字列には、次の 3 つの部分が含まれます。
query_term operator values
ここで
query_termは、検索するクエリ語句またはフィールドです。operatorは、クエリ用語の条件を指定します。valuesは、検索結果のフィルタに使用する特定の値です。
たとえば、次のクエリ文字列は、検索をフィルタして、「Google Drive API resources」という名前の共有ドライブのみを返します。
q: name = 'Google Drive API resources' & useDomainAdminAccess=false
共有ドライブのすべてのクエリ用語を表示するには、共有ドライブ固有のクエリ用語をご覧ください。
クエリの作成に使用できるすべてのクエリ演算子を表示するには、クエリ演算子をご覧ください。
クエリ文字列の例
次の表に、共有ドライブの基本的なクエリ文字列の例を示します。実際のコードは、検索に使用するクライアント ライブラリによって異なります。
クエリが正しく動作するように、ファイル名内の特殊文字をエスケープする必要もあります。たとえば、ファイル名にアポストロフィ(')とバックスラッシュ("\")の両方が含まれている場合は、バックスラッシュを使用してエスケープします(name
contains 'quinn\'s paper\\essay')。
| クエリの対象 | 例 | useDomainAdminAccess 設定 |
|---|---|---|
文字列一致演算子(contains) |
||
| ユーザーがメンバーになっているすべての共有ドライブのうち、タイトルに「confidential」という単語が含まれている共有ドライブ | name contains 'confidential' |
false |
等価演算子と不等価演算子(=、!=) |
||
| デフォルトのビューに表示される共有ドライブ | hidden = false |
false |
| デフォルトのビューで非表示になっている共有ドライブ | hidden = true |
false |
| 主催者が割り当てられていない共有ドライブ | organizerCount = 0 |
true |
| メンバーが 1 人だけの共有ドライブ | memberCount = 1 |
true |
| 組織部門 ID に属する共有ドライブ | orgUnitId = 'C03az79cb' |
true |
| 組織部門 ID を含まない共有ドライブ | orgUnitId != 'C03az79cb' |
true |
| 名前に特定の名前が含まれていない共有ドライブ | name != 'Archived Projects' |
true |
比較演算子(>、>=、<、<=) |
||
| 2017 年 6 月 1 日以降に作成された共有ドライブ | createdTime > '2017-06-01T12:00:00' |
true |
| 2023 年 1 月 1 日より前に作成された共有ドライブ | createdTime < '2023-01-01T00:00:00' |
true |
| メンバーが複数いる共有ドライブ | memberCount > 1 |
true |
| メンバーが 5 人未満の共有ドライブ | memberCount < 5 |
true |
| 共有ドライブの管理者が 3 人以下の場合 | organizerCount <= 3 |
true |
論理演算子(and、or、not) |
||
| タイトルに「機密」という単語が含まれていて、メンバーが 20 人以上の共有ドライブ | name contains 'confidential' and memberCount >= 20 |
true |
| 組織のすべての共有ドライブのうち、タイトルに「機密」という単語が含まれている共有ドライブ | name contains 'confidential' and orgUnitId = 'C03az79cb' |
true |
| 名前に「Project」または「Archive」が含まれる共有ドライブ | name contains 'Project' or name contains 'Archive' |
true |
| 名前に「下書き」が含まれていない共有ドライブ | not name contains 'Draft' |
true |
| 特定の組織部門に属しておらず、特定の日付以降に作成された共有ドライブ | orgUnitId != 'C03az79cb' and createdTime > '2023-01-01T00:00:00' |
true |
複数のキーワードを括弧で囲んでクエリする
かっこを使用して、複数のクエリ用語をグループ化できます。たとえば、特定の日付より後に作成され、5 人以上の管理者または 20 人以上のメンバーがいる共有ドライブを検索するには、次のクエリを使用します。
createdTime > '2019-01-01T12:00:00' and (organizerCount > 5 or memberCount > 20)
この検索では、2019 年 1 月 1 日以降に作成され、管理者数が 5 人以上またはメンバー数が 20 人以上のすべての共有ドライブが返されます。
Drive API は and 演算子と or 演算子を左から右に評価するため、かっこなしで同じ検索を行うと、次の結果が返されます。
- 2019 年 1 月 1 日以降に作成され、5 人以上の管理者がいる共有ドライブのみ。
- 2019 年 1 月 1 日より前に作成された共有ドライブも含め、メンバーが 20 人を超えるすべての共有ドライブ。