Method: people.listDirectoryPeople

Enthält eine Liste von Domainprofilen und Domainkontakten im Domainverzeichnis des authentifizierten Nutzers.

Wenn syncToken angegeben ist, werden Ressourcen, die seit der letzten Synchronisierung gelöscht wurden, als Person zurückgegeben, wobei PersonMetadata.deleted auf „true“ gesetzt ist.

Wenn pageToken oder syncToken angegeben ist, müssen alle anderen Anfrageparameter mit dem ersten Aufruf übereinstimmen.

Bei Schreibvorgängen kann die Übertragungsverzögerung für Synchronisierungsanfragen mehrere Minuten betragen. Inkrementelle Synchronisierungen sind nicht für Anwendungsfälle „Lesen nach Schreiben“ gedacht.

Unter Verzeichnis der Personen, die geändert wurden finden Sie ein Anwendungsbeispiel.

HTTP-Anfrage

GET https://people.googleapis.com/v1/people:listDirectoryPeople

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
readMask

string (FieldMask format)

Erforderlich. Eine Feldmaske zur Einschränkung der zurückgegebenen Felder für jede Person. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • addresses
  • Altersbereiche
  • Biografien
  • Geburtstage
  • calendarUrls
  • Kundendaten
  • Cover Photos
  • emailAddresses
  • Veranstaltungen
  • Externe IDs
  • geschlechter
  • Kunden
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • metadata
  • Sonstige Keywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • phoneNumbers
  • fotos
  • Beziehungen
  • sipAdressen
  • skills
  • URLs
  • Benutzerdefiniert
sources[]

enum (DirectorySourceType)

Erforderlich. Verzeichnisquellen, die zurückgegeben werden sollen.
mergeSources[]

enum (DirectoryMergeSourceType)

Optional. Zusätzliche Daten, die in die Verzeichnisquellen zusammengeführt werden, wenn sie über bestätigte Join-Schlüssel wie E-Mail-Adressen oder Telefonnummern verbunden sind.
pageSize

integer

Optional. Die Anzahl der Personen, die in die Antwort aufgenommen werden sollen. Gültige Werte liegen im Bereich von 1 bis 1.000. Der Standardwert ist 100, wenn nicht oder 0 festgelegt.
pageToken

string

Optional. Ein Seitentoken, das von einer vorherigen Antwort empfangen wurde: nextPageToken. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für people.listDirectoryPeople bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
requestSyncToken

boolean

Optional. Gibt an, ob die Antwort nextSyncToken zurückgeben soll. Damit können inkrementelle Änderungen seit der letzten Anfrage durch Festlegen der Anfrage syncToken abgerufen werden.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter people.listDirectoryPeople.
syncToken

string

Optional. Ein Synchronisierungstoken, das von einer vorherigen Antwort empfangen wurde nextSyncToken Geben Sie dieses an, um nur die Ressourcen abzurufen, die seit der letzten Anfrage geändert wurden.

Bei der Synchronisierung müssen alle anderen Parameter, die für people.listDirectoryPeople bereitgestellt werden, mit dem ersten Aufruf übereinstimmen, der das Synchronisierungstoken bereitgestellt hat.

Weitere Informationen zum Synchronisierungsverhalten finden Sie unter people.listDirectoryPeople.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Die Antwort auf eine Anfrage für das Domainverzeichnis des authentifizierten Nutzers.

JSON-Darstellung 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Felder
people[]

object (Person)

Die Liste der Personen im Domainverzeichnis.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
nextSyncToken

string

Ein Token, das als syncToken gesendet werden kann, um Änderungen seit der letzten Anfrage abzurufen. In der Anfrage muss requestSyncToken festgelegt sein, um das Synchronisierungstoken zurückzugeben.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/directory.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.