Method: debug.datasources.items.searchByViewUrl
Stay organized with collections
Save and categorize content based on your preferences.
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.debughttps://www.googleapis.com/auth/cloud_search
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-04 UTC.
[null,null,["Last updated 2025-04-04 UTC."],[],[],null,["# Method: debug.datasources.items.searchByViewUrl\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchItemsByViewUrlResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nFetches the item whose viewUrl exactly matches that of the URL provided in the request.\n\n**Note:** This API requires an admin account to execute.\n\n### HTTP request\n\n`POST https://cloudsearch.googleapis.com/v1/debug/{name=datasources/*}/items:searchByViewUrl`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------|\n| `name` | `string` Source name, format: datasources/{sourceId} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"viewUrl\": string, \"pageToken\": string, \"debugOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/DebugOptions) } } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------|\n| `viewUrl` | `string` Specify the full view URL to find the corresponding item. The maximum length is 2048 characters. |\n| `pageToken` | `string` The nextPageToken value returned from a previous request, if any. |\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"items\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------|\n| `items[]` | `object (`[Item](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item)`)` |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.debug`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
