Method: projects.locations.corpora.indexes.viewAssets

インデックス内のアセットのリストを表示します。

HTTP リクエスト

GET https://visionai.googleapis.com/v1alpha1/{index=projects/*/locations/*/corpora/*/indexes/*}:viewAssets

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

パスパラメータ

パラメータ
index

string

必須。このアセット コレクションを所有するインデックス。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

クエリ パラメータ

パラメータ
pageSize

integer

返されるアセット数の上限。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のアセットが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

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

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

string

返されたリストに適用されたフィルタ。サポートされているフィルタは、「assetId = xxxx」のみです。指定した ID のアセットが返されます。「assetId = xxxx, yyyy, zzzz」: 指定された ID のアセットを返します。

リクエストの本文

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

レスポンスの本文

indexes.viewAssets のレスポンス メッセージ。

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

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

object (IndexedAsset)

指定したインデックスのアセット。
nextPageToken

string

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

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

IAM 権限

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

  • visionai.indexes.viewAssets

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

IndexedAsset

IndexedAsset は、インデックスが構築されるアセットです。

JSON 表現 
{
  "index": string,
  "asset": string,
  "createTime": string,
  "updateTime": string
}
フィールド
index

string

必須。このインデックス登録済みアセットが属するインデックス。形式: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}
asset

string

必須。アセットのリソース名。形式: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}
createTime

string (Timestamp format)

出力専用。作成タイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。更新タイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。