Method: contactGroups.update

Aktualisieren Sie den Namen einer bestehenden Kontaktgruppe, die dem authentifizierten Nutzer gehört.

Die Namen der aktualisierten Kontaktgruppen müssen für die Kontaktgruppen der Nutzer eindeutig sein. Beim Versuch, eine Gruppe mit einem doppelten Namen zu erstellen, wird der HTTP-Fehler 409 zurückgegeben.

Mutate-Anfragen für denselben Nutzer sollten nacheinander gesendet werden, um erhöhte Latenz und Fehler zu vermeiden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
contactGroup.resourceName

string

Der Ressourcenname für die Kontaktgruppe, der vom Server zugewiesen wurde. Ein ASCII-String im Format contactGroups/{contactGroupId}.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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
}
Felder
contactGroup.etag

string

Das HTTP-Entitäts-Tag der Ressource. Wird für die Validierung des Webcaches verwendet.
contactGroup.metadata

object (ContactGroupMetadata)

Nur Ausgabe. Metadaten zur Kontaktgruppe.
contactGroup.groupType

enum (GroupType)

Nur Ausgabe. Typ der Kontaktgruppe.
contactGroup.name

string

Der Name der Kontaktgruppe, der vom Gruppeninhaber festgelegt wurde, oder ein vom System angegebener Name für Systemgruppen.

Bei contactGroups.create oder contactGroups.update muss der Name für die Nutzergruppen der Nutzer eindeutig sein. Beim Versuch, eine Gruppe mit einem doppelten Namen zu erstellen, wird der HTTP-Fehler 409 zurückgegeben.
contactGroup.formattedName

string

Nur Ausgabe. Der Name, der in der Sprache des Kontokontos des Betrachters übersetzt und formatiert wurde, oder der Sprache des HTTP-Headers Accept-Language für Systemgruppennamen. Der vom Inhaber festgelegte Gruppenname ist identisch mit dem Namen.
contactGroup.memberResourceNames[]

string

Nur Ausgabe. Die Liste der Ressourcennamen der Kontaktpersonen, die Mitglieder der Kontaktgruppe sind. Das Feld wird nur für GET-Anfragen ausgefüllt und gibt in der get-Anfrage nur so viele Mitglieder wie maxMembers zurück.
contactGroup.memberCount

integer

Nur Ausgabe. Die Gesamtzahl der Kontakte in der Gruppe, unabhängig von der in der Anfrage angegebenen Höchstzahl von Mitgliedern.
contactGroup.clientData[]

object (GroupClientData)

Die Kundendaten der Gruppe.
updateGroupFields

string (FieldMask format)

Optional. Eine Feldmaske zur Einschränkung der Felder in der Gruppe. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Wenn kein Wert festgelegt oder das Feld leer ist, wird standardmäßig name verwendet. Aktualisierte Felder werden ersetzt. Gültige Werte sind:

  • Kundendaten
  • name
readGroupFields

string (FieldMask format)

Optional. Eine Feldmaske zur Einschränkung der zurückgegebenen Felder in der Gruppe. Wenn kein Wert festgelegt oder das Feld leer ist, wird der Standardwert metadata, groupType und name verwendet. Gültige Felder sind:

  • Kundendaten
  • Gruppentyp
  • Anzahl der Mitglieder
  • metadata
  • name

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von ContactGroup.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.