Google Analytics Admin API (analyticsadmin:v1alpha)

2022-01-20

13 new methods

Additions

    Methods
  • analyticsadmin.properties.androidAppDataStreams.delete

      Flat Path: v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}

      Path: v1alpha/{+name}

      Parameter Order: name

      Parameters:

        name

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

          Description: Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/123/androidAppDataStreams/456"

          Type: string

          Required: Yes

          Location: path

      Description: Deletes an android app stream on a property.

      HTTP Method: DELETE

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

  • analyticsadmin.properties.androidAppDataStreams.list

      Parameter Order: parent

      HTTP Method: GET

      Description: Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.

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

      Path: v1alpha/{+parent}/androidAppDataStreams

      Parameters:

        pageToken

          Location: query

          Type: string

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

        pageSize

          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)

          Type: integer

          Location: query

          Format: int32

        parent

          Pattern: ^properties/[^/]+$

          Description: Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: "properties/123"

          Type: string

          Location: path

          Required: Yes

      Scopes:

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
  • analyticsadmin.properties.androidAppDataStreams.get

      Description: Lookup for a single AndroidAppDataStream

      Scopes:

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
    • Flat Path: v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}

      Path: v1alpha/{+name}

      Parameter Order: name

      HTTP Method: GET

      Parameters:

        name

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

          Required: Yes

          Type: string

          Description: Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/123/androidAppDataStreams/456"

          Location: path

  • analyticsadmin.properties.androidAppDataStreams.patch

      Parameter Order: name

      Parameters:

        name

          Description: Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"

          Type: string

          Required: Yes

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

          Location: path

        updateMask

          Format: google-fieldmask

          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.

          Location: query

      Description: Updates an android app stream on a property.

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

      Path: v1alpha/{+name}

      Flat Path: v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}

      HTTP Method: PATCH

  • analyticsadmin.properties.iosAppDataStreams.delete

      Description: Deletes an iOS app stream on a property.

      HTTP Method: DELETE

      Parameter Order: name

      Parameters:

        name

          Description: Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/123/iosAppDataStreams/456"

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

          Location: path

          Type: string

          Required: Yes

      Path: v1alpha/{+name}

      Flat Path: v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}

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

  • analyticsadmin.properties.iosAppDataStreams.list

      Scopes:

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
    • Description: Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.

      HTTP Method: GET

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

      Parameter Order: parent

      Path: v1alpha/{+parent}/iosAppDataStreams

      Parameters:

        pageSize

          Format: int32

          Location: query

          Type: integer

          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)

        parent

          Description: Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: "properties/123"

          Type: string

          Location: path

          Required: Yes

          Pattern: ^properties/[^/]+$

        pageToken

          Location: query

          Type: string

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

  • analyticsadmin.properties.iosAppDataStreams.patch

      Flat Path: v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}

      Parameters:

        updateMask

          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.

          Type: string

          Format: google-fieldmask

          Location: query

        name

          Location: path

          Description: Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"

          Type: string

          Required: Yes

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

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

      Description: Updates an iOS app stream on a property.

      Path: v1alpha/{+name}

      HTTP Method: PATCH

      Parameter Order: name

  • analyticsadmin.properties.iosAppDataStreams.get

      HTTP Method: GET

      Parameters:

        name

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

          Required: Yes

          Location: path

          Type: string

          Description: Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/123/iosAppDataStreams/456"

      Parameter Order: name

      Flat Path: v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}

      Path: v1alpha/{+name}

      Scopes:

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
    • Description: Lookup for a single IosAppDataStream

  • analyticsadmin.properties.webDataStreams.patch

      HTTP Method: PATCH

      Path: v1alpha/{+name}

      Flat Path: v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}

      Parameter Order: name

      Parameters:

        updateMask

          Format: google-fieldmask

          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.

          Location: query

          Type: string

        name

          Location: path

          Required: Yes

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

          Description: Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

          Type: string

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

      Description: Updates a web stream on a property.

  • analyticsadmin.properties.webDataStreams.list

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/analytics.edit
    • https://www.googleapis.com/auth/analytics.readonly
    • Description: Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.

      Parameters:

        pageToken

          Type: string

          Location: query

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

        pageSize

          Type: integer

          Format: int32

          Location: query

          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)

        parent

          Type: string

          Location: path

          Description: Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123"

          Required: Yes

          Pattern: ^properties/[^/]+$

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

      Path: v1alpha/{+parent}/webDataStreams

      HTTP Method: GET

  • analyticsadmin.properties.webDataStreams.delete

      Path: v1alpha/{+name}

      Parameters:

        name

          Description: Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"

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

          Type: string

          Location: path

          Required: Yes

      Description: Deletes a web stream on a property.

      HTTP Method: DELETE

      Parameter Order: name

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

      Flat Path: v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}

  • analyticsadmin.properties.webDataStreams.create

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

      HTTP Method: POST

      Path: v1alpha/{+parent}/webDataStreams

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Location: path

          Required: Yes

          Description: Required. The parent resource where this web data stream will be created. Format: properties/123

          Pattern: ^properties/[^/]+$

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

      Description: Creates a web stream with the specified location and attributes.

  • analyticsadmin.properties.webDataStreams.get

      HTTP Method: GET

      Flat Path: v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}

      Scopes:

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

      Parameters:

        name

          Type: string

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

          Required: Yes

          Description: Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456"

          Location: path

      Parameter Order: name

      Description: Lookup for a single WebDataStream