Google Analytics Admin API (analyticsadmin:v1beta)

2024-04-04

5 new methods

Additions

    Methods
  • analyticsadmin.properties.keyEvents.create

      HTTP Method : POST

      Path : v1beta/{+parent}/keyEvents

      Description : Creates a Key Event.

      Flat Path : v1beta/properties/{propertiesId}/keyEvents

      Scopes : https://www.googleapis.com/auth/analytics.edit

      Parameters :

        parent

          Pattern : ^properties/[^/]+$

          Location : path

          Type : string

          Description : Required. The resource name of the parent property where this Key Event will be created. Format: properties/123

          Required : Yes

      Parameter Order : parent

  • analyticsadmin.properties.keyEvents.get

      Parameters :

        name

          Type : string

          Required : Yes

          Pattern : ^properties/[^/]+/keyEvents/[^/]+$

          Location : path

          Description : Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

      Scopes :

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
    • Flat Path : v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}

      Parameter Order : name

      HTTP Method : GET

      Path : v1beta/{+name}

      Description : Retrieve a single Key Event.

  • analyticsadmin.properties.keyEvents.patch

      HTTP Method : PATCH

      Parameters :

        name

          Type : string

          Description : Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

          Required : Yes

          Location : path

          Pattern : ^properties/[^/]+/keyEvents/[^/]+$

        updateMask

          Location : query

          Type : string

          Description : Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

          Format : google-fieldmask

      Path : v1beta/{+name}

      Description : Updates a Key Event.

      Parameter Order : name

      Flat Path : v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}

      Scopes : https://www.googleapis.com/auth/analytics.edit

  • analyticsadmin.properties.keyEvents.delete

      Path : v1beta/{+name}

      Parameters :

        name

          Type : string

          Required : Yes

          Description : Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"

          Pattern : ^properties/[^/]+/keyEvents/[^/]+$

          Location : path

      Flat Path : v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}

      HTTP Method : DELETE

      Description : Deletes a Key Event.

      Scopes : https://www.googleapis.com/auth/analytics.edit

      Parameter Order : name

  • analyticsadmin.properties.keyEvents.list

      Path : v1beta/{+parent}/keyEvents

      Description : Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

      Flat Path : v1beta/properties/{propertiesId}/keyEvents

      HTTP Method : GET

      Parameter Order : parent

      Parameters :

        parent

          Pattern : ^properties/[^/]+$

          Description : Required. The resource name of the parent property. Example: 'properties/123'

          Type : string

          Required : Yes

          Location : path

        pageToken

          Location : query

          Type : string

          Description : A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.

        pageSize

          Type : integer

          Location : query

          Format : int32

          Description : The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

      Scopes :

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly