Method: properties.audienceLists.get

  • The properties.audienceLists.get method retrieves configuration metadata for a specific audience list.

  • The HTTP request uses a GET method to the specified URL with a required name path parameter.

  • The request body should be empty.

  • The response body contains an instance of AudienceList if successful.

  • This method requires specific OAuth authorization scopes.

Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created.

See Creating an Audience List for an introduction to Audience Lists with examples.

This method is available at beta stability at audienceExports.get. To give your feedback on this API, complete the Google Analytics Audience Export API Feedback form.

HTTP request

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The audience list resource name. Format: properties/{property}/audienceLists/{audienceList}

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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