返回一系列受众群体属性,以及其潜在 YouTube 覆盖面与给定输入属性的覆盖面之间的重叠程度估算值。
抛出的错误列表:AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
HTTP 请求
POST https://googleads.googleapis.com/v17/customers/{customerId}:generateAudienceOverlapInsights
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
customer |
必需。客户的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "countryLocation": { object ( |
字段 | |
---|---|
country |
必需。用于计算受众群体规模和重叠情况的国家/地区。 |
primary |
必需。应与所有其他符合条件的受众群体相交集的受众群体属性。必须是“兴趣相似的受众群体”或“有购买意向的用户兴趣”“AgeRange”或“性别”。 |
dimensions[] |
必需。要与 primaryAttribute 计算重叠的属性类型。这些值必须是 AFFINITY_USER_INTEREST、IN_MARKET_USER_INTEREST、AGE_RANGE 和 GENDER 的子集。 |
customer |
要为其制定方案的客户的名称。这是用户定义的值。 |
响应正文
AudienceInsightsService.GenerateAudienceOverlapInsights
的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "primaryAttributeMetadata": { object ( |
字段 | |
---|---|
primary |
主要属性的元数据,包括潜在的 YouTube 覆盖面。 |
dimension |
属性列表及其与主属性重叠,每个请求的维度一个列表。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/adwords
如需了解详情,请参阅 OAuth 2.0 概览。
DimensionOverlapResult
单个维度的受众群体属性列表,包括与主要属性的重叠部分,作为 GenerateAudienceOverlapInsightsResponse
的一部分返回。
JSON 表示法 |
---|
{ "dimension": enum ( |
字段 | |
---|---|
dimension |
此部分中所有属性的维度。 |
items[] |
属性及其与主要属性的重叠情况。 |
AudienceOverlapItem
受众群体属性,其中包含元数据,包括此属性的潜在 YouTube 覆盖面与主要属性的潜在 YouTube 覆盖面之间的重叠部分。
JSON 表示法 |
---|
{
"attributeMetadata": {
object ( |
字段 | |
---|---|
attribute |
属性及其元数据,包括潜在的 YouTube 覆盖面。 |
potential |
此受众群体属性与主要属性的交集的估算大小,即同时符合主要属性和此属性的可触达 YouTube 用户数。 |