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 に設定すると、インデックス システムにより、nameversionqueue のフィールドのみが入力されます。metadata.hashmetadata.titlemetadata.sourceRepositoryURLmetadata.objectTypemetadata.createTimemetadata.updateTimemetadata.contentLanguagemetadata.mimeTypestructuredData.hashcontent.hashitemTypeitemStatus.codeitemStatus.processingError.codeitemStatus.repositoryError.type

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

pageToken

string

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

pageSize

integer

1 回のリクエストで取得するアイテムの最大数。basic が true の場合、最大値は 1,000 です。basic が 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

詳細については、承認ガイドをご覧ください。