Method: debug.datasources.items.searchByViewUrl

Fetches the item whose viewUrl exactly matches that of the URL provided in the request.

Note: This API requires an admin account to execute.

HTTP request

POST https://cloudsearch.googleapis.com/v1/debug/{name=datasources/*}/items:searchByViewUrl

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Source name, format: datasources/{sourceId}

Request body

The request body contains data with the following structure:

JSON representation
{
  "viewUrl": string,
  "pageToken": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Fields
viewUrl

string

Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.

pageToken

string

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

debugOptions

object (DebugOptions)

Common debug options.

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.debug
  • https://www.googleapis.com/auth/cloud_search

For more information, see the Authorization guide.