Method: indexing.datasources.items.list

Lists all or a subset of Item resources.

This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the Data Source to list Items. Format: datasources/{sourceId}

Query parameters

Parameters
connectorName

string

The name of connector making this call.

Format: datasources/{sourceId}/connectors/{ID}
brief

boolean

When set to true, the indexing system only populates the following fields: 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,

If this value is false, then all the fields are populated in Item.
pageToken

string

The nextPageToken value returned from a previous List request, if any.
pageSize

integer

Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false.

The default value is 10
debugOptions

object (DebugOptions)

Common debug options.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "items": [
    {
      object (Item)
    }
  ],
  "nextPageToken": string
}
Fields
items[]

object (Item)
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authorization guide.