特定の属性に一致するグループを検索するには、Directory API の groups.list メソッドを使用します。このメソッドは、1 つ以上の検索句を組み合わせた検索クエリである query パラメータを受け入れます。各検索句は、次の 3 つの部分で構成されます。
- 項目
- 検索対象のグループ属性。例:
name - 演算子
- 一致を確定するためにデータに対して実行されるテスト。たとえば、
=演算子は、テキスト属性が値と一致するかどうかをテストします。 - 値
- テスト対象の属性の内容。例:
groupName
複数の句は空白文字で区切られ、AND 演算子で暗黙的に結合されます。
フィールド
| 項目 | 値の型 | 演算子 | 説明 |
|---|---|---|---|
email |
string | =、:{PREFIX}* |
グループのメールアドレス。注: 同じクエリ内で memberKey パラメータと併用することはできません。 |
name |
string | =、:{PREFIX}* |
グループの表示名。注: 同じクエリ内で memberKey パラメータと併用することはできません。 |
memberKey |
string | =, |
memberKey クエリ パラメータは、ユーザーまたはグループにメンバーシップがあるすべてのグループを返します。この値は、ユーザーのプライマリまたはエイリアスのメールアドレス、グループのプライマリまたはエイリアスのメールアドレス、ユーザーの一意の ID のいずれかになります。注: 同じクエリ内で email パラメータまたは name パラメータと併用することはできません。 |
値の型
| 値の型 | メモ |
|---|---|
| string | クエリに空白文字が含まれている場合は、単一引用符 ' で囲みます。クエリ内で単一引用符をエスケープするには、\' を使用します（例: 'Valentine\'s Day'）。 |
演算子
| 演算子 | サポートされている値の型 | メモ |
|---|---|---|
= |
string, boolean, number, date | フィールドと値が正確に一致している。たとえば、name=contact は、name 属性が "contact" のすべてのグループと一致しますが、"contactgroup" には一致しません。ほとんどの文字列フィールドでサポートされています（上記参照）。 |
:{PREFIX}* |
string | フィールドは値から始まります。たとえば、email:support* を含むクエリは、email の値が "supportgroup@" と "support@" のグループに一致しますが、"contactsupport" には一致しません。一部の文字列フィールドでのみサポートされます（上記を参照）。 |
例
すべてのクエリで groups.list メソッドを使用します。このメソッドには、次のような HTTP リクエストが含まれています（読みやすくするために改行が挿入されています）。
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
query パラメータは URL エンコードする必要があります。たとえば、クエリ query=email:support* は query=email%3Asupport* として URL エンコードされます。このページの例はすべて、エンコードされていない query パラメータを示しています。クライアント ライブラリは、この URL エンコードを自動的に処理します。
表示名でグループを検索する
name='contact'
メールアドレスの接頭辞に一致するグループを検索する
email:admin*
ユーザーのすべてのグループを検索する
memberKey=user@company.com
名前とメールアドレスが「contact」で始まるグループを検索する
name:contact* email:contact*