Discovery Engine API (discoveryengine:v1alpha)

2024-06-08

2 new methods

Additions

    Methods
  • discoveryengine.projects.locations.requirements.checkRequirement

      Path: v1alpha/{+location}/requirements:checkRequirement

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/requirements:checkRequirement

      HTTP Method: POST

      Parameters:

        location

          Description: Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}`

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: location

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Check a particular requirement.

  • discoveryengine.projects.locations.userEvents.collect

      Path: v1alpha/{+parent}/userEvents:collect

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        userEvent

          Description: Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

          Location: query

          Type: string

        uri

          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 third-party requests.

          Location: query

          Type: string

        ets

          Description: The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

          Location: query

          Type: string

          Format: int64

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-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.