Method: contactGroups.members.modify

認証されたユーザーが所有する連絡先グループのメンバーを変更します。

メンバーを追加できるシステムの連絡先グループは、contactGroups/myContacts と contactGroups/starred のみです。他のシステム連絡先グループは非推奨となっており、削除できるのは連絡先のみです。

HTTP リクエスト

POST https://people.googleapis.com/v1/{resourceName=contactGroups/*}/members:modify

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

パスパラメータ

パラメータ
resourceName

string

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

リクエスト本文

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

JSON 表現 
{
  "resourceNamesToAdd": [
    string
  ],
  "resourceNamesToRemove": [
    string
  ]
}
フィールド
resourceNamesToAdd[]

string

（省略可）追加する連絡先のリソース名。people/{person_id} の形式で指定します。resourceNamesToAdd と resourceNamesToRemove のリソース名の合計数は 1,000 以下にする必要があります。
resourceNamesToRemove[]

string

（省略可）削除する連絡先のリソース名。people/{person_id} の形式で指定します。resourceNamesToAdd と resourceNamesToRemove のリソース名の合計数は 1,000 以下にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

連絡先グループのメンバーの変更リクエストに対するレスポンス。

JSON 表現 
{
  "notFoundResourceNames": [
    string
  ],
  "canNotRemoveLastContactGroupResourceNames": [
    string
  ]
}
フィールド
notFoundResourceNames[]

string

連絡先のリソース名が見つかりませんでした。
canNotRemoveLastContactGroupResourceNames[]

string

最後の連絡先グループから削除できない連絡先のリソース名。

認可スコープ

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

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

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