Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.combinedAudiences

Resource: CombinedAudience

Describe a resource for combined audiences which includes different audiences.

JSON representation
{
  "resourceName": string,
  "id": string,
  "status": enum (CombinedAudienceStatus),
  "name": string,
  "description": string
}
Fields
resourceName

string

Immutable. The resource name of the combined audience. Combined audience names have the form:

customers/{customerId}/combinedAudience/{combined_audience_id}

id

string (int64 format)

Output only. ID of the combined audience.

status

enum (CombinedAudienceStatus)

Output only. Status of this combined audience. Indicates whether the combined audience is enabled or removed.

name

string

Output only. Name of the combined audience. It should be unique across all combined audiences.

description

string

Output only. Description of this combined audience.

CombinedAudienceStatus

Enum containing possible combined audience status types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Enabled status - combined audience is enabled and can be targeted.
REMOVED Removed status - combined audience is removed and cannot be used for targeting.

Methods

get

Returns the requested combined audience in full detail.