Method: people.searchDirectoryPeople

Enthält eine Liste von Domainprofilen und Domainkontakten im Domainverzeichnis des authentifizierten Nutzers, die der Suchanfrage entsprechen.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
query

string

Erforderlich. Präfixabfrage, die mit Feldern in der Person übereinstimmt. Verwendet NICHT die Methode „readMask“ zum Bestimmen der übereinstimmenden Felder.
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 500. 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.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] angegebenen Parameter mit dem ersten Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

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 Personen im Domainverzeichnis des authentifizierten Nutzers, die der angegebenen Abfrage entsprechen.

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

object (Person)

Die Liste der Personen im Domainverzeichnis, die der Abfrage entsprechen.
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.
totalSize

integer

Die Gesamtzahl der Elemente in der Liste ohne Paginierung.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.