認証されたユーザーが所有する既存の連絡先グループの名前を更新します。
更新された連絡先グループ名は、ユーザーの連絡先グループに固有のものである必要があります。重複する名前でグループを作成しようとすると、HTTP 409 エラーが返されます。
レイテンシやエラーの増加を避けるため、同じユーザーに対する変更リクエストは順番に送信する必要があります。
HTTP リクエスト
PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
contactGroup.resourceName |
サーバーによって割り当てられた連絡先グループのリソース名。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{
"contactGroup": {
"resourceName": string,
"etag": string,
"metadata": {
"updateTime": string,
"deleted": boolean
},
"groupType": enum ( |
フィールド | |
---|---|
contactGroup.etag |
リソースの HTTP エンティティ タグ。ウェブ キャッシュの検証に使用されます。 |
contactGroup.metadata |
出力のみ。連絡先グループに関するメタデータ。 |
contactGroup.groupType |
出力のみ。連絡先グループの種類。 |
contactGroup.name |
グループ オーナーが設定した連絡先グループ名、またはシステム グループの名前。
|
contactGroup.formattedName |
出力のみ。閲覧者のアカウントの言語 / 地域またはシステム グループ名の |
contactGroup.memberResourceNames[] |
出力のみ。連絡先グループのメンバーである連絡先担当者のリソース名のリスト。このフィールドは、GET リクエストに対してのみ値が入力され、GET リクエストで |
contactGroup.memberCount |
出力のみ。グループ内の連絡先の合計数。リクエストで指定されたメンバーの最大数は考慮されません。 |
contactGroup.clientData[] |
グループのクライアント データ。 |
updateGroupFields |
省略可。グループで更新するフィールドを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。未設定または空に設定した場合のデフォルトは
|
readGroupFields |
省略可。グループで返されるフィールドを制限するフィールド マスク。未設定または空に設定した場合のデフォルトは、
|
レスポンスの本文
成功した場合、レスポンスの本文には ContactGroup
のインスタンスが含まれます。
承認スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/contacts
詳しくは、承認ガイドをご覧ください。