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 リクエストの場合のみ入力されます。

GroupType

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

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

GroupClientData

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

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

string

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

value

string

クライアントがクライアント データの値に指定した値。

メソッド

batchGet

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

create

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

delete

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

get

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

list

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

update

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