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 encji HTTP zasobu. Służy do sprawdzania poprawności pamięci podręcznej w internecie.
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 nadana przez system nazwa 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 ze zduplikowaną nazwą spowoduje zwrócenie błędu HTTP 409.
formattedName

string

Tylko dane wyjściowe. Nazwa przetłumaczona i sformatowana zgodnie z językiem konta wyświetlającego lub w języku nagłówka HTTP Accept-Language w przypadku nazw grup systemowych. Nazwy grup ustawione przez właściciela są takie same jak nazwa.
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 dla żądań GET i zwraca tylko tyle elementów: 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 prośbie.
clientData[]

object (GroupClientData)

Dane klienta grupy.

ContactGroupMetadata

Metadane 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 RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
deleted

boolean

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

GroupType

Typ grupy kontaktów.

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

GroupClientData

Dane dowolnych klientów wypełniane przez klientów. Zduplikowane klucze i wartości są dozwolone.

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

string

Klient określił klucz danych klienta.
value

string

Określona przez klienta wartość danych klienta.

Metody

batchGet

 Aby uzyskać listę grup kontaktów należących do uwierzytelnionego użytkownika, podaj listę nazw zasobów grup 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, podając nazwę zasobu grupy kontaktów.

get

 Podaj nazwę zasobu grupy kontaktów, aby uzyskać określoną grupę kontaktów należącą do uwierzytelnionego użytkownika.

list

 Wyświetla wszystkie grupy kontaktów należące do uwierzytelnionego użytkownika.

update

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