Method: projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata

Document のインデックスの更新頻度メタデータを取得します。ウェブサイト検索でのみサポートされます。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata

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

パスパラメータ

パラメータ
parent

string

必須。親ブランチのリソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch} など）。

クエリ パラメータ

パラメータ
matcher

object (Matcher)

必須。Document のマッチャー。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には BatchGetDocumentsMetadataResponse のインスタンスが含まれます。

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.documents.batchGetDocumentsMetadata

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