Method: properties.audiences.archive

  • Audiences are archived on a property using a POST request to a specific URL with gRPC Transcoding syntax.

  • The request requires a 'name' path parameter in the format 'properties//audiences/'.

  • The request body must be empty, and a successful response body is an empty JSON object.

  • Archiving an audience requires the 'https://www.googleapis.com/auth/analytics.edit' authorization scope.

Archives an Audience on a property.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Example format: properties/1234/audiences/5678

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

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