Method: customers.generateAudienceCompositionInsights

返回在相关受众群体中代表的一系列属性，其中的指标用于将每个属性的受众群体份额与其基准受众群体份额进行比较。

抛出的错误的列表：AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
customerId

string

必需。客户的 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
字段
audience

object (InsightsAudience)

必需。请求数据分析的兴趣受众群体。
baselineAudience

object (InsightsAudience)

将感兴趣的受众群体与之进行比较的基准受众群体。
dataMonth

string

要用于数据分析的历史数据的一个月范围，格式为“yyyy-mm”。如果未设置，系统会返回过去 30 天数据的数据分析。
dimensions[]

enum (AudienceInsightsDimension)

必需。应返回构成数据分析的受众群体维度。
customerInsightsGroup

string

目标客户的名称。这是用户定义的值。

响应正文

AudienceInsightsService.GenerateAudienceCompositionInsights 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "sections": [
    {
      object (AudienceCompositionSection)
    }
  ]
}
字段
sections[]

object (AudienceCompositionSection)

数据分析报告的内容，分为以下几个部分。每个部分都与请求中的某个 AudienceInsightsDimension 值相关联。每个维度可能有多个版块。

授权范围

需要以下 OAuth 范围：

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

如需了解详情，请参阅 OAuth 2.0 概览。

AudienceCompositionSection

受众群体构成分析报告中同一类型的一系列相关属性。

JSON 表示法 
{
  "dimension": enum (AudienceInsightsDimension),
  "topAttributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ],
  "clusteredAttributes": [
    {
      object (AudienceCompositionAttributeCluster)
    }
  ]
}
字段
dimension

enum (AudienceInsightsDimension)

此部分中的属性类型。
topAttributes[]

object (AudienceCompositionAttribute)

与此受众群体最相关的细分受众群。如果维度是 GENDER、AGE_RANGE 或 PARENTAL_STATUS，则该属性列表是详尽的。
clusteredAttributes[]

object (AudienceCompositionAttributeCluster)

此受众群体的其他属性，按聚类分组。仅当维度为 YOUTUBE_CHANNEL 时填充。

AudienceCompositionAttribute

包含元数据和指标的受众群体属性。

JSON 表示法 
{
  "attributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "metrics": {
    object (AudienceCompositionMetrics)
  }
}
字段
attributeMetadata

object (AudienceInsightsAttributeMetadata)

属性及其元数据。
metrics

object (AudienceCompositionMetrics)

特性的份额指标和索引指标。

AudienceCompositionMetrics

受众群体构成分析报告中与属性相关联的份额和指数指标。

JSON 表示法 
{
  "baselineAudienceShare": number,
  "audienceShare": number,
  "index": number,
  "score": number
}
字段
baselineAudienceShare

number

与该属性匹配的基准受众群体所占的比例（介于 0 和 1 之间，包括 0 和 1）。
audienceShare

number

与该属性匹配的特定受众群体所占的比例（介于 0 和 1 之间，包括 0 和 1）。
index

number

audienceShare 与 BaselineAudienceShare 的比率，如果该比率未定义或无意义，则为 0。
score

number

相关性得分，介于 0 到 1 之间（包括 0 和 1）。

AudienceCompositionAttributeCluster

受众群体构成分析报告中的一系列相关属性，包含元数据和指标。

JSON 表示法 
{
  "clusterDisplayName": string,
  "clusterMetrics": {
    object (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
字段
clusterDisplayName

string

此特性集群的名称
clusterMetrics

object (AudienceCompositionMetrics)

如果与此集群相关联的维度是 YOUTUBE_CHANNEL，则 clusterMetrics 是与整个集群相关联的指标。对于其他维度，此字段未设置。
attributes[]

object (AudienceCompositionAttribute)

构成此集群的各个属性，以及元数据和指标。