Method: indexing.datasources.items.upload
Stay organized with collections
Save and categorize content based on your preferences.
Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline
within an index
request.
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
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*/items/*}:upload
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
The name of the Item to start a resumable upload. Format: datasources/{sourceId}/items/{itemId}. The maximum length is 1536 bytes.
|
Request body
The request body contains data with the following structure:
JSON representation |
{
"connectorName": string,
"debugOptions": {
object (DebugOptions )
}
} |
Fields |
connectorName |
string
The name of connector making this call. Format: datasources/{sourceId}/connectors/{id}
|
debugOptions |
object (DebugOptions )
Common debug options.
|
Response body
If successful, the response body contains an instance of UploadItemRef
.
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.
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: indexing.datasources.items.upload\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content [inline](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent.FIELDS.inline_content) within an [index](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items/index_#google.apps.search.v1.ItemsService.IndexItem) request.\n\nThis API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.\n\n### HTTP request\n\n`POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*/items/*}:upload`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the Item to start a resumable upload. Format: datasources/{sourceId}/items/{itemId}. The maximum length is 1536 bytes. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"connectorName\": string, \"debugOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/DebugOptions) } } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------|\n| `connectorName` | `string` The name of connector making this call. Format: datasources/{sourceId}/connectors/{id} |\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 an instance of [UploadItemRef](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#UploadItemRef).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.indexing`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]