Method: indexing.datasources.items.list

Item resources のすべてまたはサブセットを一覧表示します。

この API を実行するには、管理者またはサービス アカウントが必要です。使用されるデータソースは、対応するデータソースのホワイトリストに登録されているアカウントです。

HTTP リクエスト

GET https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items

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

パスパラメータ

パラメータ
name

string

アイテムを一覧表示するデータソースの名前。形式: datasources/{sourceId}

クエリ パラメータ

パラメータ
connectorName

string

この呼び出しを行うコネクタの名前。

形式: datasources/{sourceId}/connectors/{ID}
brief

boolean

true に設定すると、インデックス システムにより name、version、queue の各フィールドのみが入力されます。metadata.hash、metadata.title、metadata.sourceRepositoryURL、metadata.objectType、metadata.createTime、metadata.updateTime、metadata.contentLanguage、metadata.mimeType、structuredData.hash、content.hash、itemType、itemStatus.code、itemStatus.processingError.code、itemStatus.repositoryError.type、

この値が false の場合、すべてのフィールドが [Item] に入力されます。
pageToken

string

前の List リクエストから返された nextPageToken 値（存在する場合）。
pageSize

integer

リクエストで取得するアイテムの最大数。ブリーフが true の場合、最大値は 1,000 です。ブリーフが false の場合、最大値は 10 です。

デフォルト値は 10 です。
debugOptions

object (DebugOptions)

一般的なデバッグ オプション。

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (Item)
nextPageToken

string

結果の次のページを取得するためのトークン。リストにそれ以上の結果がない場合は空です。

承認スコープ

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

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

詳しくは、認可ガイドをご覧ください。