Method: people.listDirectoryPeople

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

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

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

Schreibvorgänge können bei Synchronisierungsanfragen eine Verzögerung bei der Weitergabe von mehreren Minuten haben. Inkrementelle Synchronisierungen sind nicht für Anwendungsfälle mit Lese-/Schreibzugriff vorgesehen.

Ein Anwendungsbeispiel finden Sie unter Verzeichnis der Personen auflisten, deren Daten geändert wurden.

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 für jede Person zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Gültige Werte sind:

  • addresses
  • ageRanges
  • biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • 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 die 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 die Antwort aufgenommen werden sollen. Gültige Werte liegen zwischen 1 und 1.000 (einschließlich). Wenn die Richtlinie nicht konfiguriert oder auf „0“ festgelegt ist, ist die Standardeinstellung 100.
pageToken

string

Optional. Ein Seitentoken, das von einer vorherigen Antwort nextPageToken empfangen 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. Gibt an, ob die Antwort nextSyncToken zurückgeben soll. Sie kann verwendet werden, um inkrementelle Änderungen seit der letzten Anfrage abzurufen, indem Sie sie in der Anfrage syncToken festlegen.

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

string

Optional. Ein von einer vorherigen Antwort erhaltenes Synchronisierungstoken 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 für people.listDirectoryPeople bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, über den das Synchronisierungstoken bereitgestellt wurde.

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 werden, 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.