Google Analytics Admin API (analyticsadmin:v1alpha)

2023-10-03

11 new methods

Additions

    Methods
  • analyticsadmin.properties.createSubproperty

      Path : v1alpha/properties:createSubproperty

      Description : Create a subproperty and a subproperty event filter that applies to the created subproperty.

      HTTP Method : POST

      Flat Path : v1alpha/properties:createSubproperty

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

  • analyticsadmin.properties.createRollupProperty

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

      Flat Path : v1alpha/properties:createRollupProperty

      HTTP Method : POST

      Path : v1alpha/properties:createRollupProperty

      Description : Create a roll-up property and all roll-up property source links.

  • analyticsadmin.properties.subpropertyEventFilters.get

      Flat Path : v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}

      Parameters :

        name

          Location : path

          Description : Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

          Required : Yes

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

          Type : string

      Scopes :

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

      Parameter Order : name

      Path : v1alpha/{+name}

      Description : Lookup for a single subproperty Event Filter.

  • analyticsadmin.properties.subpropertyEventFilters.create

      Parameter Order : parent

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

      Description : Creates a subproperty Event Filter.

      Flat Path : v1alpha/properties/{propertiesId}/subpropertyEventFilters

      HTTP Method : POST

      Path : v1alpha/{+parent}/subpropertyEventFilters

      Parameters :

        parent

          Type : string

          Description : Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123

          Required : Yes

          Pattern : ^properties/[^/]+$

          Location : path

  • analyticsadmin.properties.subpropertyEventFilters.list

      Parameter Order : parent

      Path : v1alpha/{+parent}/subpropertyEventFilters

      Description : List all subproperty Event Filters on a property.

      HTTP Method : GET

      Flat Path : v1alpha/properties/{propertiesId}/subpropertyEventFilters

      Parameters :

        pageSize

          Location : query

          Description : Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

          Format : int32

          Type : integer

        pageToken

          Location : query

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

          Type : string

        parent

          Description : Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123

          Pattern : ^properties/[^/]+$

          Required : Yes

          Location : path

          Type : string

      Scopes :

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
  • analyticsadmin.properties.subpropertyEventFilters.patch

      Description : Updates a subproperty Event Filter.

      Parameters :

        updateMask

          Location : query

          Type : string

          Description : Required. The list of fields to update. Field names must be in snake case (for example, "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

        name

          Description : Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678

          Type : string

          Location : path

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

          Required : Yes

      Path : v1alpha/{+name}

      Parameter Order : name

      HTTP Method : PATCH

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

      Flat Path : v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}

  • analyticsadmin.properties.subpropertyEventFilters.delete

      Flat Path : v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}

      HTTP Method : DELETE

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

      Parameter Order : name

      Path : v1alpha/{+name}

      Description : Deletes a subproperty event filter.

      Parameters :

        name

          Description : Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456

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

          Location : path

          Required : Yes

          Type : string

  • analyticsadmin.properties.rollupPropertySourceLinks.create

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

      Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

          Description : Required. Format: properties/{property_id} Example: properties/1234

          Pattern : ^properties/[^/]+$

      Description : Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

      Parameter Order : parent

      HTTP Method : POST

      Path : v1alpha/{+parent}/rollupPropertySourceLinks

      Flat Path : v1alpha/properties/{propertiesId}/rollupPropertySourceLinks

  • analyticsadmin.properties.rollupPropertySourceLinks.get

      HTTP Method : GET

      Path : v1alpha/{+name}

      Description : Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

      Parameter Order : name

      Scopes :

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

        name

          Location : path

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

          Description : Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456

          Required : Yes

          Type : string

      Flat Path : v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}

  • analyticsadmin.properties.rollupPropertySourceLinks.delete

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

      Description : Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

      Parameters :

        name

          Location : path

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

          Description : Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678

          Type : string

          Required : Yes

      Parameter Order : name

      HTTP Method : DELETE

      Flat Path : v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}

      Path : v1alpha/{+name}

  • analyticsadmin.properties.rollupPropertySourceLinks.list

      Flat Path : v1alpha/properties/{propertiesId}/rollupPropertySourceLinks

      HTTP Method : GET

      Description : Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.

      Parameters :

        parent

          Required : Yes

          Location : path

          Type : string

          Description : Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234

          Pattern : ^properties/[^/]+$

        pageToken

          Location : query

          Type : string

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

        pageSize

          Type : integer

          Description : Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

          Location : query

          Format : int32

      Scopes :

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
    • Path : v1alpha/{+parent}/rollupPropertySourceLinks

      Parameter Order : parent