連絡先グループのリソース名のリストを指定して、認証されたユーザーが所有する連絡先グループのリストを取得します。
HTTP リクエスト
GET https://people.googleapis.com/v1/contactGroups:batchGet
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
resourceNames[] |
必須。取得する連絡先グループのリソース名。 リソース名の最大数は 200 です。 |
maxMembers |
省略可。各グループについて返されるメンバーの最大数を指定します。設定しない場合のデフォルトは 0 で、0 人のメンバーが返されます。 |
groupFields |
省略可。グループで返されるフィールドを制限するフィールド マスク。未設定または空に設定した場合のデフォルトは、
|
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
連絡先グループの一括取得リクエストに対するレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"responses": [
{
object ( |
フィールド | |
---|---|
responses[] |
リクエストされた各連絡先グループ リソースに対するレスポンスのリスト。 |
承認スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
詳しくは、承認ガイドをご覧ください。
ContactGroupResponse
特定の連絡先グループに対するレスポンス。
JSON 表現 |
---|
{ "requestedResourceName": string, "status": { object ( |
フィールド | |
---|---|
requestedResourceName |
リクエストされた元のリソース名。 |
status |
レスポンスのステータス。 |
contactGroup |
連絡先グループ。 |