Method: contactGroups.update

認証されたユーザーが所有する既存の連絡先グループの名前を更新する。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
contactGroup.resourceName

string

サーバーによって割り当てられた連絡先グループのリソース名。contactGroups/{contactGroupId} 形式の ASCII 文字列。

リクエスト本文

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

JSON 表現 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
フィールド
contactGroup.etag

string

リソースの HTTP エンティティ タグ。ウェブ キャッシュの検証に使用されます。
contactGroup.metadata

object (ContactGroupMetadata)

出力専用。連絡先グループに関するメタデータ。
contactGroup.groupType

enum (GroupType)

出力専用。連絡先グループのタイプ。
contactGroup.name

string

グループ オーナーが設定した連絡先グループ名、またはシステム グループの名前。

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

string

出力専用。閲覧者のアカウントの言語 / 地域に翻訳およびフォーマットされた名前。システム グループ名の場合は Accept-Language HTTP ヘッダーの言語 / 地域です。オーナーが設定したグループ名は、名前と同じになります。
contactGroup.memberResourceNames[]

string

出力専用。連絡先グループのメンバーである連絡先担当者リソース名のリスト。このフィールドは GET リクエストに対してのみ入力され、get リクエストで maxMembers と同数のメンバーのみを返します。
contactGroup.memberCount

integer

出力専用。リクエストで指定されたメンバーの最大数に関係なく、グループ内の連絡先の合計数。
contactGroup.clientData[]

object (GroupClientData)

グループのクライアント データ。
updateGroupFields

string (FieldMask format)

省略可。グループのどのフィールドを更新するかを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。設定しない場合または空に設定した場合のデフォルトは name です。更新されたフィールドは置き換えられます。指定できる値は次のとおりです。

  • clientData
  • name
readGroupFields

string (FieldMask format)

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

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

レスポンスの本文

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

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。