Method: people.searchDirectoryPeople

Liefert eine Liste der Domainprofile und Domainkontakte im Domainverzeichnis des authentifizierten Nutzers, die mit der Suchanfrage übereinstimmen.

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 Feldern in der Person entspricht. Verwendet readMask NICHT, um zu bestimmen, welche Felder abgeglichen werden sollen.
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 500 (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.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] bereitgestellten Parameter mit dem ersten Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwort auf eine Anfrage für Personen im Domainverzeichnis des authentifizierten Nutzers, die der angegebenen Abfrage entsprechen.

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

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 Leitfaden zur Autorisierung.