This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.
Changes in GA:
Name:Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
Query parameters
Parameters
userEvent
string
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
uri
string
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 third-party requests.
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
Request body
The request body must be empty.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-02-13 UTC."],[[["This API endpoint uses a GET request to collect user event data, a constraint due to browser limitations on third-party POST requests."],["The `userEvents:collect` method is specifically for the Discovery Engine API JavaScript pixel and Google Tag Manager, and should not be called directly by users."],["The request requires a parent `DataStore` resource name in the path, along with a URL-encoded `UserEvent` proto, the page `uri`, and the event timestamp `ets` as query parameters."],["The request body for this API endpoint must be empty, and successful responses will have a generic HTTP format."],["Authorization for this endpoint requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
