Method: properties.audiences.get

  • Retrieve a specific Audience resource using its unique name, formatted as properties/{propertyId}/audiences/{audienceId}.

  • Request requires authorization using either analytics.readonly or analytics.edit scope.

  • Only audiences created after 2020 and non-default audiences can be successfully retrieved.

  • Response includes the Audience object if found, otherwise an error.

Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Audience to get. Example format: properties/1234/audiences/5678

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Audience.

Authorization scopes

Requires one of the following OAuth scopes:

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