Method: contactGroups.get

連絡先グループのリソース名を指定して、認証されたユーザーが所有する特定の連絡先グループを取得します。

HTTP リクエスト

GET https://people.googleapis.com/v1/{resourceName=contactGroups/*}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
resourceName

string

必須。取得する連絡先グループのリソース名。

クエリ パラメータ

パラメータ
maxMembers

integer

省略可。返されるメンバーの最大数を指定します。設定しない場合のデフォルトは 0 で、0 人のメンバーが返されます。
groupFields

string (FieldMask format)

省略可。グループで返されるフィールドを制限するフィールド マスク。未設定または空に設定した場合のデフォルトは、metadata、groupType、memberCount、name です。有効なフィールドは次のとおりです。

  • clientData
  • groupType
  • memberCount
  • メタデータ
  • name

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には ContactGroup のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

詳しくは、承認ガイドをご覧ください。