REST Resource: contactGroups

Ressource: ContactGroup

Kontaktgruppe

JSON-Darstellung 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Felder
resourceName

string

Der vom Server zugewiesene Ressourcenname für die Kontaktgruppe. Ein ASCII-String im Format contactGroups/{contactGroupId}.
etag

string

Das HTTP-Entitäts-Tag der Ressource. Wird für die Web-Cache-Validierung verwendet.
metadata

object (ContactGroupMetadata)

Nur Ausgabe. Metadaten zur Kontaktgruppe.
groupType

enum (GroupType)

Nur Ausgabe. Der Typ der Kontaktgruppe.
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.
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.
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.
memberCount

integer

Nur Ausgabe. Die Gesamtzahl der Kontakte in der Gruppe, unabhängig von der in der Anfrage angegebenen maximalen Anzahl von Mitgliedern.
clientData[]

object (GroupClientData)

Die Kundendaten der Gruppe.

ContactGroupMetadata

Die Metadaten einer Kontaktgruppe.

JSON-Darstellung 
{
  "updateTime": string,
  "deleted": boolean
}
Felder
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Gruppe zuletzt aktualisiert wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Nur Ausgabe. "True", wenn die Kontaktgruppenressource gelöscht wurde. Wird nur für contactGroups.list-Anfragen ausgefüllt, die ein Synchronisierungstoken enthalten.

GroupType

Ein Kontaktgruppentyp.

Enums
GROUP_TYPE_UNSPECIFIED Nicht angegeben
USER_CONTACT_GROUP Benutzerdefinierte Kontaktgruppe.
SYSTEM_CONTACT_GROUP Systemdefinierte Kontaktgruppe.

GroupClientData

Beliebige Kundendaten, die von Kunden eingegeben werden. Doppelte Schlüssel und Werte sind zulässig.

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string

Der vom Kunden angegebene Schlüssel der Kundendaten.
value

string

Der vom Kunden angegebene Wert für die Kundendaten.

Methoden

batchGet

 Rufen Sie eine Liste der Kontaktgruppen ab, die dem authentifizierten Nutzer gehören, indem Sie eine Liste mit Kontaktgruppen-Ressourcennamen angeben.

create

 Erstellen Sie eine neue Kontaktgruppe, die dem authentifizierten Nutzer gehört.

delete

 Löschen Sie eine vorhandene Kontaktgruppe, die dem authentifizierten Nutzer gehört, indem Sie einen Ressourcennamen für die Kontaktgruppe angeben.

get

 Rufen Sie eine bestimmte Kontaktgruppe des authentifizierten Nutzers ab, indem Sie den Ressourcennamen einer Kontaktgruppe angeben.

list

 Hiermit werden alle Kontaktgruppen des authentifizierten Nutzers aufgelistet.

update

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