Method: contactGroups.update

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

Zaktualizowane nazwy grup kontaktów muszą być unikalne dla grup kontaktów użytkowników. Próba utworzenia grupy ze zduplikowaną nazwą spowoduje zwrócenie błędu HTTP 409.

Żądania mutacji dotyczące tego samego użytkownika powinny być wysyłane po kolei, aby uniknąć wydłużenia czasu oczekiwania i błędów.

Żądanie HTTP

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
contactGroup.resourceName

string

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Pola
contactGroup.etag

string

Tag encji HTTP zasobu. Służy do sprawdzania poprawności pamięci podręcznej w internecie.
contactGroup.metadata

object (ContactGroupMetadata)

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

enum (GroupType)

Tylko dane wyjściowe. Typ grupy kontaktów.
contactGroup.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.
contactGroup.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.
contactGroup.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.
contactGroup.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.
contactGroup.clientData[]

object (GroupClientData)

Dane klienta grupy.
updateGroupFields

string (FieldMask format)

Opcjonalnie: Maska pola ograniczająca, które pola w grupie są aktualizowane. Można określić wiele pól, rozdzielając je przecinkami. Jeśli nie jest ustawiona lub jest pusta, domyślna wartość to name. Zaktualizowane pola są zastępowane. Prawidłowe wartości to:

  • clientData
  • nazwa
readGroupFields

string (FieldMask format)

Opcjonalnie: Maska pola ograniczająca, które pola w grupie są zwracane. Jeśli nie jest ustawiona lub jest pusta, domyślna wartość to metadata, groupType i name. Prawidłowe pola to:

  • clientData
  • groupType
  • memberCount
  • metadane
  • nazwa

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu ContactGroup.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.