Method: contactGroups.update

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

Aktualisierte Kontaktgruppennamen müssen für die Kontaktgruppen des Nutzers eindeutig sein. Beim Versuch, eine Gruppe mit einem bereits vorhandenen Namen zu erstellen, wird der HTTP-Fehler 409 zurückgegeben.

Änderungsanfragen für denselben Nutzer sollten sequenziell 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 vom Server zugewiesene Ressourcenname für die Kontaktgruppe. 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. Der Typ der Kontaktgruppe.
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 für die Kontaktgruppen des Nutzers eindeutig sein. Beim Versuch, eine Gruppe mit einem bereits vorhandenen Namen zu erstellen, wird der HTTP-Fehler 409 zurückgegeben.
contactGroup.formattedName

string

Nur Ausgabe. Der Name wurde in der Sprache des Zuschauerkontos oder in der Accept-Language-HTTP-Header-Sprache für Systemgruppennamen übersetzt und formatiert. Vom Inhaber festgelegte Gruppennamen sind identisch mit Namen.
contactGroup.memberResourceNames[]

string

Nur Ausgabe. Die Liste der Ressourcennamen der Kontaktperson, 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 maximalen Anzahl von Mitgliedern.
contactGroup.clientData[]

object (GroupClientData)

Die Kundendaten der Gruppe.
updateGroupFields

string (FieldMask format)

Optional. Eine Feldmaske, um einzuschränken, welche Felder in der Gruppe aktualisiert werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Wenn kein Wert festgelegt oder ein leerer Wert festgelegt wird, ist die Standardeinstellung name. Aktualisierte Felder werden ersetzt. Gültige Werte sind:

  • clientData
  • Name
readGroupFields

string (FieldMask format)

Optional. Eine Feldmaske, um einzuschränken, welche Felder für die Gruppe zurückgegeben werden. Wenn kein Wert festgelegt oder ein leerer Wert festgelegt wird, 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.