Method: customers.generateAudienceOverlapInsights

Returns a collection of audience attributes along with estimates of the overlap between their potential YouTube reach and that of a given input attribute.

List of thrown errors: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

HTTP request

POST https://googleads.googleapis.com/v17/customers/{customerId}:generateAudienceOverlapInsights

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "countryLocation": {
    object (LocationInfo)
  },
  "primaryAttribute": {
    object (AudienceInsightsAttribute)
  },
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
Fields
countryLocation

object (LocationInfo)

Required. The country in which to calculate the sizes and overlaps of audiences.
primaryAttribute

object (AudienceInsightsAttribute)

Required. The audience attribute that should be intersected with all other eligible audiences. This must be an Affinity or In-Market UserInterest, an AgeRange or a Gender.
dimensions[]

enum (AudienceInsightsDimension)

Required. The types of attributes of which to calculate the overlap with the primaryAttribute. The values must be a subset of AFFINITY_USER_INTEREST, IN_MARKET_USER_INTEREST, AGE_RANGE and GENDER.
customerInsightsGroup

string

The name of the customer being planned for. This is a user-defined value.

Response body

Response message for AudienceInsightsService.GenerateAudienceOverlapInsights.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "primaryAttributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "dimensionResults": [
    {
      object (DimensionOverlapResult)
    }
  ]
}
Fields
primaryAttributeMetadata

object (AudienceInsightsAttributeMetadata)

Metadata for the primary attribute, including potential YouTube reach.
dimensionResults[]

object (DimensionOverlapResult)

Lists of attributes and their overlap with the primary attribute, one list per requested dimension.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

DimensionOverlapResult

A list of audience attributes of a single dimension, including their overlap with a primary attribute, returned as part of a GenerateAudienceOverlapInsightsResponse.

JSON representation 
{
  "dimension": enum (AudienceInsightsDimension),
  "items": [
    {
      object (AudienceOverlapItem)
    }
  ]
}
Fields
dimension

enum (AudienceInsightsDimension)

The dimension of all the attributes in this section.
items[]

object (AudienceOverlapItem)

The attributes and their overlap with the primary attribute.

AudienceOverlapItem

An audience attribute, with metadata including the overlap between this attribute's potential YouTube reach and that of a primary attribute.

JSON representation 
{
  "attributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "potentialYoutubeReachIntersection": string
}
Fields
attributeMetadata

object (AudienceInsightsAttributeMetadata)

The attribute and its metadata, including potential YouTube reach.
potentialYoutubeReachIntersection

string (int64 format)

The estimated size of the intersection of this audience attribute with the primary attribute, that is, the number of reachable YouTube users who match BOTH the primary attribute and this one.