Method: projects.locations.identityMappingStores.listIdentityMappings

ID マッピング ストア内の ID マッピングを一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
identityMappingStore

string

必須。ID マッピング エントリを一覧表示する ID マッピング ストアの名前。形式: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

クエリ パラメータ

パラメータ
pageSize

integer

返す IdentityMapping の最大数。指定しない場合、デフォルトは 2, 000 です。最大 10,000 です。10,000 を超える値は 10,000 に強制変換されます。
pageToken

string

前回の identityMappingStores.listIdentityMappings 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、identityMappingStores.listIdentityMappings に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

IdentityMappingStoreService.ListIdentityMappings に対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ],
  "nextPageToken": string
}
フィールド
identityMappingEntries[]

object (IdentityMappingEntry)

ID マッピング エントリ。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

identityMappingStore リソースに対する次の IAM 権限が必要です。

  • discoveryengine.identityMappingStores.listIdentityMappings

詳細については、IAM のドキュメントをご覧ください。