REST Resource: contactGroups

Zasób: ContactGroup

Grupa kontaktów.

Zapis JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Pola
resourceName

string

Nazwa zasobu grupy kontaktów przypisana przez serwer. Ciąg ASCII w formacie contactGroups/{contactGroupId}.
etag

string

Tag jednostki HTTP zasobu. Służy do sprawdzania poprawności pamięci podręcznej.
metadata

object (ContactGroupMetadata)

Tylko dane wyjściowe. Metadane dotyczące grupy kontaktów.
groupType

enum (GroupType)

Tylko dane wyjściowe. Typ grupy kontaktów.
name

string

Nazwa grupy kontaktów ustawiona przez właściciela grupy lub nazwa systemu podana dla grup systemowych.

W przypadku contactGroups.create lub contactGroups.update nazwa musi być niepowtarzalna dla grup kontaktów użytkowników. Próba utworzenia grupy o zduplikowanej nazwie zwróci błąd HTTP 409.
formattedName

string

Tylko dane wyjściowe. Nazwa została przetłumaczona i sformatowana w ustawieniach regionalnych konta przeglądarki lub w nagłówku HTTP Accept-Language w przypadku nazw grup systemowych. Nazwy grup ustawione przez właściciela są takie same jak nazwy.
memberResourceNames[]

string

Tylko dane wyjściowe. Lista nazw zasobów osób kontaktowych, które są członkami grupy kontaktów. Pole jest wypełniane tylko w przypadku żądań GET i zwraca tylko tyle członków co maxMembers w żądaniu get.
memberCount

integer

Tylko dane wyjściowe. Łączna liczba kontaktów w grupie, niezależnie od maksymalnej liczby członków określonej w żądaniu.
clientData[]

object (GroupClientData)

Dane klienta z grupy.

Metadane grupy kontaktów

Metadane dotyczące grupy kontaktów.

Zapis JSON 
{
  "updateTime": string,
  "deleted": boolean
}
Pola
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji grupy.

Sygnatura czasowa w formacie „Zulu” UTC3339, z rozdzielczością nanosekundą i maksymalnie 9 cyframi. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Tylko dane wyjściowe. Wartość „prawda”, jeśli zasób grupy kontaktów został usunięty. Wartość wypełniana tylko w przypadku żądań contactGroups.list zawierających token synchronizacji.

Typ grupy

Typ grupy kontaktów.

Wartości w polu enum
GROUP_TYPE_UNSPECIFIED Nie określono.
USER_CONTACT_GROUP Zdefiniowana przez użytkownika grupa kontaktów.
SYSTEM_CONTACT_GROUP Grupa kontaktów zdefiniowana przez system.

Daneklientagrupowego

Dowolne dane klienta, które są wypełniane przez klientów. Zduplikowane klucze i wartości są dozwolone.

Zapis JSON 
{
  "key": string,
  "value": string
}
Pola
key

string

Klucz klienta określony przez klienta.
value

string

Określona przez klienta wartość danych klienta.

Metody

batchGet

 Uzyskaj listę grup kontaktów należących do uwierzytelnionego użytkownika, określając listę nazw zasobów grupy kontaktów.

create

 Utwórz nową grupę kontaktów należącą do uwierzytelnionego użytkownika.

delete

 Usuń istniejącą grupę kontaktów należącą do uwierzytelnionego użytkownika, określając nazwę zasobu grupy kontaktów.

get

 Określ grupę kontaktów należącą do uwierzytelnionego użytkownika, podając nazwę zasobu grupy kontaktów.

list

 Lista wszystkich grup kontaktów należących do uwierzytelnionego użytkownika.

update

 Zaktualizuj nazwę istniejącej grupy kontaktów należącej do uwierzytelnionego użytkownika.