認証されたユーザーのドメイン ディレクトリ内にある、検索クエリに一致するドメイン プロフィールとドメインの連絡先のリストを提供します。
HTTP リクエスト
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
query |
必須。人のフィールドに一致するクエリを接頭辞にします。照合するフィールドの決定に readMask を使用しません。 |
readMask |
必須。各人物のどのフィールドが返されるかを制限するフィールド マスク。複数のフィールドを指定する場合は、フィールドをカンマで区切ります。指定できる値は次のとおりです。
|
sources[] |
必須。返されるディレクトリ ソース。 |
mergeSources[] |
省略可。メールアドレスや電話番号などの確認済みの結合キーを介して接続されている場合、ディレクトリ ソースに統合する追加データ。 |
pageSize |
省略可。回答に含める人数。有効な値は 1 ~ 500 です。設定しない場合、または 0 に設定した場合、デフォルトは 100 です。 |
pageToken |
省略可。前のレスポンス ページ分割の際には、[ |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
認証されたユーザーのドメイン ディレクトリ内で、指定されたクエリに一致するユーザーに対するリクエストに対するレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"people": [
{
object ( |
フィールド | |
---|---|
people[] |
クエリに一致するドメイン ディレクトリ内のユーザーのリスト。 |
nextPageToken |
次のページを取得するために |
totalSize |
ページ分けなしのリスト内のアイテムの合計数。 |
承認スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/directory.readonly
詳しくは、承認ガイドをご覧ください。