Method: contactGroups.members.modify

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

メンバーを追加できるシステム連絡先グループは contactGroups/myContactscontactGroups/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} の形式で指定します。resourceNamesToAddresourceNamesToRemove のリソース名の合計数は 1,000 以下にする必要があります。

resourceNamesToRemove[]

string

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

レスポンスの本文

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

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

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

string

見つからなかった連絡先担当者のリソース名。

canNotRemoveLastContactGroupResourceNames[]

string

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

承認スコープ

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

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

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