- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- DimensionOverlapResult
- AudienceOverlapItem
- Try it!
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 | |
---|---|
customer |
Required. The ID of the customer. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "countryLocation": { object ( |
Fields | |
---|---|
country |
Required. The country in which to calculate the sizes and overlaps of audiences. |
primary |
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[] |
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. |
customer |
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 ( |
Fields | |
---|---|
primary |
Metadata for the primary attribute, including potential YouTube reach. |
dimension |
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 ( |
Fields | |
---|---|
dimension |
The dimension of all the attributes in this section. |
items[] |
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 ( |
Fields | |
---|---|
attribute |
The attribute and its metadata, including potential YouTube reach. |
potential |
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. |