Method: contactGroups.update

Aktualisieren Sie den Namen einer vorhandenen Kontaktgruppe, deren Inhaber der authentifizierte Nutzer ist.

Aktualisierte Kontaktgruppennamen müssen für die Kontaktgruppen des Nutzers eindeutig sein. Wenn Sie versuchen, eine Gruppe mit einem doppelten Namen zu erstellen, wird der HTTP-Fehler 409 zurückgegeben.

Änderungsanfragen 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 Web-Cache-Validierung verwendet.
contactGroup.metadata

object (ContactGroupMetadata)

Nur Ausgabe Metadaten zur Kontaktgruppe.
contactGroup.groupType

enum (GroupType)

Nur Ausgabe Kontaktgruppentyp
contactGroup.name

string

Der vom Gruppeninhaber festgelegte Kontaktgruppenname oder ein vom System bereitgestellter Name für Systemgruppen.

Für contactGroups.create oder contactGroups.update muss der Name in den Kontaktgruppen des Nutzers eindeutig sein. Wenn Sie versuchen, eine Gruppe mit einem doppelten Namen zu erstellen, wird der HTTP-Fehler 409 zurückgegeben.
contactGroup.formattedName

string

Nur Ausgabe Der Name wird in die Sprache des Kontos des Betrachters übersetzt und formatiert oder für Systemgruppennamen die HTTP-Header-Sprache Accept-Language verwenden. Vom Eigentümer festgelegte Gruppennamen sind identisch mit Namen.
contactGroup.memberResourceNames[]

string

Nur Ausgabe Die Liste der Ressourcennamen der Kontaktpersonen, die Mitglieder der Kontaktgruppe sind. Das Feld wird nur bei GET-Anfragen gefüllt und gibt nur so viele Mitglieder wie maxMembers in der get-Anfrage 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, mit der eingeschränkt wird, welche Felder in der Gruppe aktualisiert werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Wenn die Richtlinie nicht konfiguriert oder auf „leer“ gesetzt ist, wird standardmäßig name verwendet. Aktualisierte Felder werden ersetzt. Gültige Werte sind:

  • clientData
  • name
readGroupFields

string (FieldMask format)

Optional. Eine Feldmaske, mit der eingeschränkt wird, welche Felder in der Gruppe zurückgegeben werden. Wenn die Richtlinie nicht konfiguriert oder auf „leer“ gesetzt ist, werden standardmäßig metadata, groupType und name verwendet. Gültige Felder sind:

  • clientData
  • groupType
  • memberCount
  • Metadaten
  • 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 Leitfaden zur Autorisierung.