Method: contactGroups.create

認証されたユーザーが所有する新しい連絡先グループを作成します。

作成する連絡先グループ名は、ユーザーの連絡先グループに対して一意である必要があります。重複する名前でグループを作成しようとすると、HTTP 409 エラーが返されます。

レイテンシやエラーの増加を避けるため、同じユーザーに対する変更リクエストは順番に送信する必要があります。

HTTP リクエスト

POST https://people.googleapis.com/v1/contactGroups

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

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "contactGroup": {
    object (ContactGroup)
  },
  "readGroupFields": string
}
フィールド
contactGroup

object (ContactGroup)

必須。作成する連絡先グループ。

readGroupFields

string (FieldMask format)

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

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

レスポンスの本文

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

承認スコープ

次の OAuth スコープが必要です。

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

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