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.

Audience

Stay organized with collections Save and categorize content based on your preferences.

Audience is an effective targeting option that allows you to intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

JSON representation
{
  "resourceName": string,
  "id": string,
  "status": enum (AudienceStatus),
  "name": string,
  "description": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "exclusionDimension": {
    object (AudienceExclusionDimension)
  }
}
Fields
resourceName

string

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

customers/{customerId}/audiences/{audience_id}

id

string (int64 format)

Output only. ID of the audience.

status

enum (AudienceStatus)

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

name

string

Required. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.

description

string

Description of this audience.

dimensions[]

object (AudienceDimension)

Positive dimensions specifying the audience composition.

exclusionDimension

object (AudienceExclusionDimension)

Negative dimension specifying the audience composition.

AudienceStatus

Enum containing possible audience status types.

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

AudienceDimension

Positive dimension specifying user's audience.

JSON representation
{

  // Union field dimension can be only one of the following:
  "age": {
    object (AgeDimension)
  },
  "gender": {
    object (GenderDimension)
  },
  "householdIncome": {
    object (HouseholdIncomeDimension)
  },
  "parentalStatus": {
    object (ParentalStatusDimension)
  },
  "audienceSegments": {
    object (AudienceSegmentDimension)
  }
  // End of list of possible types for union field dimension.
}
Fields
Union field dimension. Dimension specifying users who belong to the audience. dimension can be only one of the following:
age

object (AgeDimension)

Dimension specifying users by their age.

gender

object (GenderDimension)

Dimension specifying users by their gender.

householdIncome

object (HouseholdIncomeDimension)

Dimension specifying users by their household income.

parentalStatus

object (ParentalStatusDimension)

Dimension specifying users by their parental status.

audienceSegments

object (AudienceSegmentDimension)

Dimension specifying users by their membership in other audience segments.

AgeDimension

Dimension specifying users by their age.

JSON representation
{
  "ageRanges": [
    {
      object (AgeSegment)
    }
  ],
  "includeUndetermined": boolean
}
Fields
ageRanges[]

object (AgeSegment)

Contiguous age range to be included in the dimension.

includeUndetermined

boolean

Include users whose age is not determined.

AgeSegment

Contiguous age range.

JSON representation
{
  "minAge": integer,
  "maxAge": integer
}
Fields
minAge

integer

Minimum age to include. A minimum age must be specified and must be at least 18. Allowed values are 18, 25, 35, 45, 55, and 65.

maxAge

integer

Maximum age to include. A maximum age need not be specified. If specified, maxAge must be greater than minAge, and allowed values are 24, 34, 44, 54, and 64.

GenderDimension

Dimension specifying users by their gender.

JSON representation
{
  "genders": [
    enum (GenderType)
  ],
  "includeUndetermined": boolean
}
Fields
genders[]

enum (GenderType)

Included gender demographic segments.

includeUndetermined

boolean

Include users whose gender is not determined.

HouseholdIncomeDimension

Dimension specifying users by their household income.

JSON representation
{
  "incomeRanges": [
    enum (IncomeRangeType)
  ],
  "includeUndetermined": boolean
}
Fields
incomeRanges[]

enum (IncomeRangeType)

Included household income demographic segments.

includeUndetermined

boolean

Include users whose household income is not determined.

ParentalStatusDimension

Dimension specifying users by their parental status.

JSON representation
{
  "parentalStatuses": [
    enum (ParentalStatusType)
  ],
  "includeUndetermined": boolean
}
Fields
parentalStatuses[]

enum (ParentalStatusType)

Included parental status demographic segments.

includeUndetermined

boolean

Include users whose parental status is undetermined.

AudienceSegmentDimension

Dimension specifying users by their membership in other audience segments.

JSON representation
{
  "segments": [
    {
      object (AudienceSegment)
    }
  ]
}
Fields
segments[]

object (AudienceSegment)

Included audience segments. Users are included if they belong to at least one segment.

AudienceSegment

Positive audience segment.

JSON representation
{

  // Union field segment can be only one of the following:
  "userList": {
    object (UserListSegment)
  },
  "userInterest": {
    object (UserInterestSegment)
  },
  "lifeEvent": {
    object (LifeEventSegment)
  },
  "detailedDemographic": {
    object (DetailedDemographicSegment)
  },
  "customAudience": {
    object (CustomAudienceSegment)
  }
  // End of list of possible types for union field segment.
}
Fields
Union field segment. Positive segment. segment can be only one of the following:
userList

object (UserListSegment)

User list segment.

userInterest

object (UserInterestSegment)

Affinity or In-market segment.

lifeEvent

object (LifeEventSegment)

Live-event audience segment.

detailedDemographic

object (DetailedDemographicSegment)

Detailed demographic segment.

customAudience

object (CustomAudienceSegment)

Custom audience segment.

UserListSegment

User list segment.

JSON representation
{
  "userList": string
}
Fields
userList

string

The user list resource.

UserInterestSegment

User interest segment.

JSON representation