- HTTP 请求
- 路径参数
- 请求正文
- 响应正文
- 授权范围
- InsightsAudience
- InsightsAudienceAttributeGroup
- AudienceCompositionSection
- AudienceCompositionAttribute
- AudienceCompositionMetrics
- AudienceCompositionAttributeCluster
- 试试看!
返回在相关受众群体中表示的一组属性,其中的指标用于比较每个属性在受众群体中所占的份额与在基准受众群体中所占的份额。
抛出的错误列表:AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
HTTP 请求
POST https://googleads.googleapis.com/v14/customers/{customerId}:generateAudienceCompositionInsights
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
customerId |
必需。客户的 ID。 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "audience": { object ( |
字段 | |
---|---|
audience |
必需。请求数据分析的相关受众群体。 |
baselineAudience |
与相关受众群体进行比较的基准受众群体。 |
dataMonth |
用于数据分析的历史数据的一个月范围,格式为“yyyy-mm”。如果未设置,系统将返回最近 30 天数据的数据分析。 |
dimensions[] |
必需。应返回其受众群体构成数据分析的受众群体维度。 |
customerInsightsGroup |
为其规划的客户的名称。这是用户定义的值。 |
响应正文
AudienceInsightsService.GenerateAudienceCompositionInsights
的响应消息。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"sections": [
{
object ( |
字段 | |
---|---|
sections[] |
数据分析报告的内容,分门别类列出。每个部分都与请求中的某个 AudienceInsightsDimension 值相关联。每个维度可以有多个部分。 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/adwords
有关详情,请参阅 OAuth 2.0 概览。
InsightsAudience
按各种特征进行定义的一组用户,可在 AudienceInsightsService 中请求对其的数据分析。
JSON 表示法 |
---|
{ "countryLocations": [ { object ( |
字段 | |
---|---|
countryLocations[] |
必需。受众群体所在的国家/地区。 |
subCountryLocations[] |
国家/地区下级地理位置属性。如果存在,则每个元素必须包含在此受众群体的某个国家/地区中。如果缺少,则受众群体从地理位置上到 countryLocations,不再提供。 |
gender |
观众的性别。如果不包含,则受众群体不会按性别进行限制。 |
ageRanges[] |
受众群体的年龄段。如果不包含,该受众群体表示所有年满 18 周岁且符合其他特征的用户。 |
parentalStatus |
受众群体的育儿状况。如果不包含,受众群体不会受到育儿状况的限制。 |
incomeRanges[] |
相应受众群体的家庭收入百分位范围。如果不包含,受众群体不会受家庭收入范围的限制。 |
dynamicLineups[] |
动态频道组,代表观众观看过的 YouTube 内容。 |
topicAudienceCombinations[] |
用于定义受众群体的实体、类别和用户兴趣属性的组合。组合采用 AND/OR 逻辑结构:每个 InsightsAudienceAttributeGroup 中的属性使用 OR 组合,组合本身使用 AND 组合在一起。例如,表达式“(Entity OR 兴趣相似的受众群体) AND (有购买意向 OR 类别)”可以使用两个 InsightsAudienceAttributeGroup(各自包含两个属性)形成。 |
InsightsAudienceAttributeGroup
AudienceInsightsAttributes 列表。
JSON 表示法 |
---|
{
"attributes": [
{
object ( |
字段 | |
---|---|
attributes[] |
必需。一组将用逻辑“或”组合在一起的受众群体属性。属性不必全部是相同的维度。在此上下文中,仅支持知识图谱实体、产品和服务类别,以及兴趣相似的受众群体和有购买意向的受众群体。 |
AudienceCompositionSection
受众群体构成分析报告中同一类型的相关属性集合。
JSON 表示法 |
---|
{ "dimension": enum ( |
字段 | |
---|---|
dimension |
此部分中的属性类型。 |
topAttributes[] |
与此受众群体最相关的细分受众群。如果维度为 GENDER、AGE_RANGE 或 PARENTAL_STATUS,则此属性列表是详尽的。 |
clusteredAttributes[] |
此受众群体的其他属性,按组分组。仅当维度为 YOUTUBE_CHANNEL 时填充。 |
AudienceCompositionAttribute
包含元数据和指标的受众群体属性。
JSON 表示法 |
---|
{ "attributeMetadata": { object ( |
字段 | |
---|---|
attributeMetadata |
属性及其元数据。 |
metrics |
共享特性的指标并将其编入索引。 |
AudienceCompositionMetrics
与受众群体构成分析报告中的属性相关联的份额指标和指数指标。
JSON 表示法 |
---|
{ "baselineAudienceShare": number, "audienceShare": number, "index": number, "score": number } |
字段 | |
---|---|
baselineAudienceShare |
与该属性匹配的基准受众群体所占的比例(介于 0 到 1 之间,包括 0 和 1)。 |
audienceShare |
与属性匹配的特定受众群体所占的比例(介于 0 到 1 之间,包括 0 和 1)。 |
index |
audienceShare 与 BaselineAudienceShare 的比率;如果此比率未定义或无意义,则为零。 |
score |
相关性得分,介于 0 到 1 之间(包括 0 和 1)。 |
AudienceCompositionAttributeCluster
受众群体构成分析报告中的相关属性集合,包含元数据和指标。
JSON 表示法 |
---|
{ "clusterDisplayName": string, "clusterMetrics": { object ( |
字段 | |
---|---|
clusterDisplayName |
此特性集群的名称 |
clusterMetrics |
如果与此集群关联的维度是 YOUTUBE_CHANNEL,则 clusterMetrics 是与整个集群相关联的指标。对于其他维度,未设置此字段。 |
attributes[] |
构成此集群的各个属性,包含元数据和指标。 |