Method: people.listDirectoryPeople

Stellt eine Liste der Domainprofile und Domainkontakte im Domainverzeichnis des authentifizierten Nutzers bereit.

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 es bei Synchronisierungsanfragen zu einer Verzögerung von mehreren Minuten kommen. Inkrementelle Synchronisierungen sind nicht für Lese-nach-Schreib-Anwendungsfälle vorgesehen.

Eine Beispielanwendung finden Sie unter Liste der Personen im Verzeichnis auflisten, die sich geändert haben.

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, mit der eingeschränkt wird, welche Felder zu den einzelnen Personen zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • Adressen
  • ageRanges
  • Biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • Interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • Namen
  • Aliasse
  • Berufe
  • Organisationen
  • phoneNumbers
  • Fotos
  • Beziehungen
  • sipAddresses
  • skills
  • URLs
  • userDefined
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

Optional. Zusätzliche Daten, die in den Verzeichnisquellen zusammengeführt werden sollen, 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 der Antwort enthalten sein sollen. Gültige Werte liegen im Bereich von 1 bis 1.000. Wenn kein Wert festgelegt ist oder der Wert 0 ist, wird der Standardwert 100 verwendet.
pageToken

string

Optional. Ein Seitentoken, das von einer vorherigen Antwort nextPageToken erhalten wurde. 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. Ob die Antwort nextSyncToken zurückgeben soll. Sie können damit inkrementelle Änderungen seit der letzten Anfrage abrufen, indem Sie sie in der Anfrage syncToken festlegen.

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 sich seit der letzten Anfrage geändert haben.

Bei der Synchronisierung müssen alle anderen für people.listDirectoryPeople bereitgestellten Parameter 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

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

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

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 so festgelegt sein, dass das Synchronisierungstoken zurückgegeben wird.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.