REST Resource: contactGroups

リソース: ContactGroup

連絡先グループ。

JSON 表現 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
フィールド
resourceName

string

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

string

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

object (ContactGroupMetadata)

出力のみ。連絡先グループに関するメタデータ。
groupType

enum (GroupType)

出力のみ。連絡先グループのタイプ。
name

string

グループ オーナーが設定した連絡先グループ名、またはシステム グループで指定された名前

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

string

出力のみ。視聴者のアカウント ロケール、またはシステム グループ名の Accept-Language HTTP ヘッダー ロケールで翻訳およびフォーマットされた名前。オーナーが設定したグループ名は同じ名前です。
memberResourceNames[]

string

出力のみ。連絡先グループのメンバーである担当者のリソース名のリスト。このフィールドには GET リクエストのみが入力されます。get リクエストでは、最大数の maxMembers が返されます。
memberCount

integer

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

object (GroupClientData)

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

ContactGroupMetadata

連絡先グループに関するメタデータ。

JSON 表現 
{
  "updateTime": string,
  "deleted": boolean
}
フィールド
updateTime

string (Timestamp format)

出力のみ。グループが最後に更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。解像度はナノ秒で、小数点以下 9 桁まで指定できます。（例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"）。
deleted

boolean

出力のみ。連絡先グループ リソースが削除された場合は true。同期トークンを含む contactGroups.list リクエストに対してのみデータが入力されます。

グループの種類

連絡先グループのタイプ。

列挙型
GROUP_TYPE_UNSPECIFIED （指定なし）
USER_CONTACT_GROUP ユーザー定義の連絡先グループ。
SYSTEM_CONTACT_GROUP システム定義の連絡先グループ。

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

クライアントによって入力される任意のクライアント データ。重複するキーと値は指定できます。

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string

クライアントがクライアント データのキーを指定しました。
value

string

クライアント データで指定されたクライアントのデータ。

Methods

batchGet

 連絡先グループのリソース名のリストを指定して、認証済みユーザーが所有する連絡先グループのリストを取得します。

create

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

delete

 連絡先グループのリソース名を指定して、認証済みユーザーが所有する既存の連絡先グループを削除します。

get

 連絡先グループのリソース名を指定して、認証済みのユーザーが所有する特定の連絡先グループを取得します。

list

 認証済みユーザーが所有するすべての連絡先グループを一覧表示します。

update

 認証済みユーザーが所有する既存の連絡先グループの名前を更新します。