Google Analytics Admin API (analyticsadmin:v1alpha)

2023-02-07

18 new methods

Additions

    Methods
  • analyticsadmin.accounts.accessBindings.get

      Description: Gets information about an access binding.

      HTTP Method: GET

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings/{accessBindingsId}

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/analytics.manage.users
    • https://www.googleapis.com/auth/analytics.manage.users.readonly
    • Path: v1alpha/{+name}

      Parameters:

        name

          Pattern: ^accounts/[^/]+/accessBindings/[^/]+$

          Type: string

          Required: Yes

          Location: path

          Description: Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

  • analyticsadmin.accounts.accessBindings.patch

      Parameters:

        name

          Description: Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"

          Pattern: ^accounts/[^/]+/accessBindings/[^/]+$

          Type: string

          Required: Yes

          Location: path

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings/{accessBindingsId}

      Parameter Order: name

      Path: v1alpha/{+name}

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      HTTP Method: PATCH

      Description: Updates an access binding on an account or property.

  • analyticsadmin.accounts.accessBindings.batchCreate

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Path: v1alpha/{+parent}/accessBindings:batchCreate

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings:batchCreate

      Parameter Order: parent

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

          Type: string

          Location: path

          Required: Yes

          Pattern: ^accounts/[^/]+$

      Description: Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

  • analyticsadmin.accounts.accessBindings.batchDelete

      Parameter Order: parent

      Parameters:

        parent

          Pattern: ^accounts/[^/]+$

          Required: Yes

          Description: Required. The account or property that owns the access bindings. The parent field in the DeleteAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

          Location: path

          Type: string

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Description: Deletes information about multiple users' links to an account or property.

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings:batchDelete

      Path: v1alpha/{+parent}/accessBindings:batchDelete

  • analyticsadmin.accounts.accessBindings.batchGet

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings:batchGet

      Parameters:

        parent

          Description: Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats: - accounts/{account} - properties/{property}

          Required: Yes

          Location: path

          Pattern: ^accounts/[^/]+$

          Type: string

        names

          Location: query

          Repeated: Yes

          Type: string

          Description: Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

      Scopes:

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

      Path: v1alpha/{+parent}/accessBindings:batchGet

      Description: Gets information about multiple access bindings to an account or property.

      Parameter Order: parent

  • analyticsadmin.accounts.accessBindings.batchUpdate

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings:batchUpdate

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      HTTP Method: POST

      Parameters:

        parent

          Location: path

          Pattern: ^accounts/[^/]+$

          Required: Yes

          Type: string

          Description: Required. The account or property that owns the access bindings. The parent field in the UpdateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

      Parameter Order: parent

      Description: Updates information about multiple access bindings to an account or property.

      Path: v1alpha/{+parent}/accessBindings:batchUpdate

  • analyticsadmin.accounts.accessBindings.list

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings

      Scopes:

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

      Parameter Order: parent

      Parameters:

        pageToken

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

          Type: string

          Location: query

        pageSize

          Location: query

          Type: integer

          Format: int32

          Description: The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.

        parent

          Pattern: ^accounts/[^/]+$

          Location: path

          Type: string

          Description: Required. Formats: - accounts/{account} - properties/{property}

          Required: Yes

      Description: Lists all access bindings on an account or property.

      Path: v1alpha/{+parent}/accessBindings

  • analyticsadmin.accounts.accessBindings.delete

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings/{accessBindingsId}

      Parameters:

        name

          Type: string

          Required: Yes

          Pattern: ^accounts/[^/]+/accessBindings/[^/]+$

          Location: path

          Description: Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

      Description: Deletes an access binding on an account or property.

      Parameter Order: name

      HTTP Method: DELETE

      Path: v1alpha/{+name}

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

  • analyticsadmin.accounts.accessBindings.create

      HTTP Method: POST

      Parameters:

        parent

          Required: Yes

          Description: Required. Formats: - accounts/{account} - properties/{property}

          Location: path

          Pattern: ^accounts/[^/]+$

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Flat Path: v1alpha/accounts/{accountsId}/accessBindings

      Path: v1alpha/{+parent}/accessBindings

      Description: Creates an access binding on an account or property.

  • analyticsadmin.properties.accessBindings.batchUpdate

      Description: Updates information about multiple access bindings to an account or property.

      Path: v1alpha/{+parent}/accessBindings:batchUpdate

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Parameter Order: parent

      Flat Path: v1alpha/properties/{propertiesId}/accessBindings:batchUpdate

      Parameters:

        parent

          Required: Yes

          Type: string

          Description: Required. The account or property that owns the access bindings. The parent field in the UpdateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

          Location: path

          Pattern: ^properties/[^/]+$

  • analyticsadmin.properties.accessBindings.get

      Scopes:

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

        name

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

          Required: Yes

          Type: string

          Location: path

          Description: Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

      Flat Path: v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}

      Description: Gets information about an access binding.

      Path: v1alpha/{+name}

      Parameter Order: name

      HTTP Method: GET

  • analyticsadmin.properties.accessBindings.list

      Parameter Order: parent

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

      Path: v1alpha/{+parent}/accessBindings

      HTTP Method: GET

      Description: Lists all access bindings on an account or property.

      Parameters:

        pageToken

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

          Type: string

          Location: query

        pageSize

          Description: The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.

          Format: int32

          Type: integer

          Location: query

        parent

          Required: Yes

          Location: path

          Pattern: ^properties/[^/]+$

          Description: Required. Formats: - accounts/{account} - properties/{property}

          Type: string

      Scopes:

    • https://www.googleapis.com/auth/analytics.manage.users
    • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • analyticsadmin.properties.accessBindings.delete

      Parameter Order: name

      Parameters:

        name

          Description: Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

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

          Type: string

          Required: Yes

          Location: path

      Path: v1alpha/{+name}

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Flat Path: v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}

      Description: Deletes an access binding on an account or property.

  • analyticsadmin.properties.accessBindings.create

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

      Parameter Order: parent

      Description: Creates an access binding on an account or property.

      Path: v1alpha/{+parent}/accessBindings

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Parameters:

        parent

          Pattern: ^properties/[^/]+$

          Required: Yes

          Type: string

          Description: Required. Formats: - accounts/{account} - properties/{property}

          Location: path

  • analyticsadmin.properties.accessBindings.batchCreate

      Path: v1alpha/{+parent}/accessBindings:batchCreate

      Description: Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.

      Parameter Order: parent

      Flat Path: v1alpha/properties/{propertiesId}/accessBindings:batchCreate

      Parameters:

        parent

          Pattern: ^properties/[^/]+$

          Required: Yes

          Type: string

          Location: path

          Description: Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      HTTP Method: POST

  • analyticsadmin.properties.accessBindings.patch

      Parameters:

        name

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

          Location: path

          Type: string

          Required: Yes

          Description: Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Flat Path: v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}

      Path: v1alpha/{+name}

      HTTP Method: PATCH

      Description: Updates an access binding on an account or property.

      Parameter Order: name

  • analyticsadmin.properties.accessBindings.batchDelete

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Location: path

          Required: Yes

          Pattern: ^properties/[^/]+$

          Description: Required. The account or property that owns the access bindings. The parent field in the DeleteAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}

      Path: v1alpha/{+parent}/accessBindings:batchDelete

      Description: Deletes information about multiple users' links to an account or property.

      Scopes: https://www.googleapis.com/auth/analytics.manage.users

      Flat Path: v1alpha/properties/{propertiesId}/accessBindings:batchDelete

      HTTP Method: POST

  • analyticsadmin.properties.accessBindings.batchGet

      Parameter Order: parent

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/analytics.manage.users
    • https://www.googleapis.com/auth/analytics.manage.users.readonly
    • Flat Path: v1alpha/properties/{propertiesId}/accessBindings:batchGet

      Description: Gets information about multiple access bindings to an account or property.

      Parameters:

        names

          Location: query

          Repeated: Yes

          Description: Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

          Type: string

        parent

          Pattern: ^properties/[^/]+$

          Type: string

          Description: Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats: - accounts/{account} - properties/{property}

          Required: Yes

          Location: path

      Path: v1alpha/{+parent}/accessBindings:batchGet