2022-11-05
▼ ▲ discoveryengine.projects.locations.operations.get
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
HTTP Method: GET
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Required: Yes
Type: string
Path: v1alpha/{+name}
▼ ▲ discoveryengine.projects.locations.operations.list
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Type: integer
Format: int32
Description: The standard list page size.
Location: query
name
Required: Yes
Location: path
Description: The name of the operation's parent resource.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Location: query
Description: The standard list page token.
Type: string
filter
Type: string
Location: query
Description: The standard list filter.
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameter Order: name
HTTP Method: GET
Path: v1alpha/{+name}/operations
▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.recommend
Parameters:
servingConfig
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$
Type: string
Description: Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.
Parameter Order: servingConfig
HTTP Method: POST
Path: v1alpha/{+servingConfig}:recommend
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend
Description: Makes a recommendation, which requires a contextual user event.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.patch
Parameters:
name
Description: Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Required: Yes
Type: string
Location: path
allowMissing
Location: query
Description: If set to true, and the Document is not found, a new Document will be created.
Type: boolean
Path: v1alpha/{+name}
Description: Updates a Document.
Parameter Order: name
HTTP Method: PATCH
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Path: v1alpha/{+parent}/documents
Description: Creates a Document.
Parameters:
parent
Location: path
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Type: string
Required: Yes
documentId
Location: query
Type: string
Description: Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.import
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import
Description: Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Type: string
Required: Yes
Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.
Location: path
Path: v1alpha/{+parent}/documents:import
HTTP Method: POST
Parameter Order: parent
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.list
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
pageSize
Description: Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
Type: integer
Location: query
Format: int32
pageToken
Description: A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
Type: string
Location: query
Parameter Order: parent
Path: v1alpha/{+parent}/documents
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
Description: Gets a list of Documents.
HTTP Method: GET
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.delete
Description: Deletes a Document.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Path: v1alpha/{+name}
Parameters:
name
Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
Parameter Order: name
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.get
Description: Gets a Document.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Required: Yes
Location: path
Type: string
Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}/operations
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations
HTTP Method: GET
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Description: The name of the operation's parent resource.
Required: Yes
Location: path
filter
Description: The standard list filter.
Location: query
Type: string
pageToken
Type: string
Location: query
Description: The standard list page token.
pageSize
Location: query
Type: integer
Format: int32
Description: The standard list page size.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.get
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource.
Type: string
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}
Path: v1alpha/{+name}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
▼ ▲ discoveryengine.projects.locations.dataStores.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}/operations
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations
HTTP Method: GET
Parameters:
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
pageToken
Description: The standard list page token.
Type: string
Location: query
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Description: The name of the operation's parent resource.
Type: string
filter
Description: The standard list filter.
Type: string
Location: query
▼ ▲ discoveryengine.projects.locations.dataStores.operations.get
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
HTTP Method: GET
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+$
Type: string
Location: path
Description: The name of the operation resource.
Required: Yes
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}
▼ ▲ discoveryengine.projects.locations.dataStores.models.operations.get
Parameter Order: name
HTTP Method: GET
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource.
Required: Yes
Path: v1alpha/{+name}
▼ ▲ discoveryengine.projects.locations.dataStores.models.operations.list
Path: v1alpha/{+name}/operations
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
filter
Type: string
Location: query
Description: The standard list filter.
pageToken
Location: query
Type: string
Description: The standard list page token.
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+$
Description: The name of the operation's parent resource.
Location: path
Type: string
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.write
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write
Parameter Order: parent
Parameters:
parent
Type: string
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Path: v1alpha/{+parent}/userEvents:write
HTTP Method: POST
Description: Writes a single user event.
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.collect
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect
Path: v1alpha/{+parent}/userEvents:collect
HTTP Method: GET
Description: Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`.
Location: path
Required: Yes
Type: string
ets
Location: query
Format: int64
Description: The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
Type: string
uri
Type: string
Description: The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.
Location: query
userEvent
Location: query
Type: string
Description: Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.import
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
Path: v1alpha/{+parent}/userEvents:import
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import
Parameter Order: parent
Parameters:
parent
Type: string
Required: Yes
Description: Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}`
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
▼ ▲ discoveryengine.projects.operations.get
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/operations/{operationsId}
Parameters:
name
Pattern: ^projects/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Required: Yes
Type: string
Location: path
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
HTTP Method: GET
▼ ▲ discoveryengine.projects.operations.list
HTTP Method: GET
Parameter Order: name
Path: v1alpha/{+name}/operations
Flat Path: v1alpha/projects/{projectsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: The name of the operation's parent resource.
Location: path
Pattern: ^projects/[^/]+$
Type: string
filter
Location: query
Description: The standard list filter.
Type: string
pageToken
Location: query
Type: string
Description: The standard list page token.
pageSize
Format: int32
Type: integer
Description: The standard list page size.
Location: query
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.