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

object (ContactGroupMetadata)

Nur Ausgabe. Metadaten zur Kontaktgruppe.
groupType

enum (GroupType)

Nur Ausgabe. Kontaktgruppentyp
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.
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.
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.
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.

ContactGroupMetadata

Die Metadaten zu 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 Nanosekundenauflösung 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 Eine vom System definierte Kontaktgruppe.

GroupClientData

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 Kundendaten.

Methoden

batchGet

 Rufen Sie eine Liste der Kontaktgruppen des authentifizierten Nutzers ab, indem Sie eine Liste mit Ressourcennamen für Kontaktgruppen angeben.

create

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

delete

 Geben Sie einen Ressourcennamen für eine Kontaktgruppe an, um eine vorhandene Kontaktgruppe zu löschen, die dem authentifizierten Nutzer gehört.

get

 Geben Sie den Ressourcennamen einer Kontaktgruppe an, um eine bestimmte Kontaktgruppe abzurufen, die dem authentifizierten Nutzer gehört.

list

 Listet alle Kontaktgruppen auf, deren Inhaber der authentifizierte Nutzer ist.

update

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