REST Resource: contactGroups

Ressource: ContactGroup

Eine 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 Ressourcenname für die Kontaktgruppe, der vom Server zugewiesen wurde. Ein ASCII-String im Format contactGroups/{contactGroupId}.

etag

string

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

metadata

object (ContactGroupMetadata)

Nur Ausgabe. Metadaten zur Kontaktgruppe.

groupType

enum (GroupType)

Nur Ausgabe. Typ der Kontaktgruppe.

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.

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.

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.

memberCount

integer

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

clientData[]

object (GroupClientData)

Die Kundendaten der Gruppe.

Kontaktgruppenmetadaten

Die Metadaten einer Kontaktgruppe.

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

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der letzten Aktualisierung der Gruppe.

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

deleted

boolean

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

Gruppentyp

Typ einer Kontaktgruppe

Enums
GROUP_TYPE_UNSPECIFIED Nicht angegeben
USER_CONTACT_GROUP Benutzerdefinierte Kontaktgruppe
SYSTEM_CONTACT_GROUP Systemdefinierte Kontaktgruppe.

Gruppenkundendaten

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

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

string

Der vom Client angegebene Schlüssel der Clientdaten.

value

string

Der vom Client angegebene Wert der Clientdaten.

Methoden

batchGet

Sie können eine Liste der Kontaktgruppen abrufen, deren Inhaber der authentifizierte Nutzer ist, indem Sie eine Liste der Ressourcennamen der Kontaktgruppen angeben.

create

Erstellen Sie eine neue Kontaktgruppe, deren Inhaber der authentifizierte Nutzer ist.

delete

Löschen Sie eine vorhandene Kontaktgruppe, die dem authentifizierten Nutzer gehört, indem Sie den Ressourcennamen einer Kontaktgruppe angeben.

get

Sie können eine bestimmte Kontaktgruppe abrufen, deren Inhaber der authentifizierte Nutzer ist, indem Sie den Ressourcennamen einer Kontaktgruppe angeben.

list

Hiermit werden alle Kontaktgruppen des authentifizierten Nutzers aufgelistet.

update

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