- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- AudienceCompositionSection
- AudienceCompositionAttribute
- AudienceCompositionMetrics
- AudienceCompositionAttributeCluster
- Faça um teste
Retorna uma coleção de atributos representados em um público-alvo de interesse, com métricas que comparam a parcela de cada atributo do público com a parcela de um público-alvo de referência.
Lista de erros gerados: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError
Solicitação HTTP
POST https://googleads.googleapis.com/v15/customers/{customerId}:generateAudienceCompositionInsights
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
customerId |
Obrigatório. O ID do cliente. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "audience": { object ( |
Campos | |
---|---|
audience |
Obrigatório. O público-alvo de interesse para o qual os insights estão sendo solicitados. |
baselineAudience |
O público-alvo de referência com o qual o público-alvo de interesse está sendo comparado. |
dataMonth |
O intervalo de um mês de dados históricos a serem usados para insights, no formato "aaaa-mm". Se ela não for definida, serão retornados insights referentes aos últimos trinta dias de dados. |
dimensions[] |
Obrigatório. As dimensões de público-alvo para as quais os insights de composição devem ser retornados. |
customerInsightsGroup |
O nome do cliente para quem está sendo planejado. Esse é um valor definido pelo usuário. |
Corpo da resposta
Mensagem de resposta para AudienceInsightsService.GenerateAudienceCompositionInsights
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"sections": [
{
object ( |
Campos | |
---|---|
sections[] |
O conteúdo do relatório de insights, organizado em seções. Cada seção está associada a um dos valores de AudienceInsightsDimension na solicitação. Pode haver mais de uma seção por dimensão. |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/adwords
Para mais informações, consulte a Visão geral do OAuth 2.0.
AudienceCompositionSection
Uma coleção de atributos relacionados do mesmo tipo em um relatório de insights de composição do público-alvo.
Representação JSON |
---|
{ "dimension": enum ( |
Campos | |
---|---|
dimension |
O tipo dos atributos nesta seção. |
topAttributes[] |
Os segmentos mais relevantes para esse público-alvo. Se a dimensão for GENDER, AGE_RANGE ou PARENTAL_STATUS, a lista de atributos está completa. |
clusteredAttributes[] |
São os atributos adicionais para esse público-alvo, agrupados em clusters. Preenchido somente se a dimensão for YOUTUBE_CHANNEL. |
AudienceCompositionAttribute
Um atributo de público com metadados e métricas.
Representação JSON |
---|
{ "attributeMetadata": { object ( |
Campos | |
---|---|
attributeMetadata |
O atributo com os metadados. |
metrics |
Métricas de compartilhamento e indexação do atributo. |
AudienceCompositionMetrics
As métricas de compartilhamento e índice associadas a um atributo em um relatório de insights sobre composição do público-alvo.
Representação JSON |
---|
{ "baselineAudienceShare": number, "audienceShare": number, "index": number, "score": number } |
Campos | |
---|---|
baselineAudienceShare |
Fração (de 0 a 1) do público-alvo de referência que corresponde ao atributo. |
audienceShare |
Fração (de 0 a 1) do público-alvo específico que corresponde ao atributo. |
index |
É a proporção de "audienceShare" para "BaselineAudienceShare", ou zero se essa proporção for indefinida ou não for significativa. |
score |
Uma pontuação de relevância de 0 a 1, inclusive. |
AudienceCompositionAttributeCluster
Uma coleção de atributos relacionados, com metadados e métricas, em um relatório de insights sobre composição do público-alvo.
Representação JSON |
---|
{ "clusterDisplayName": string, "clusterMetrics": { object ( |
Campos | |
---|---|
clusterDisplayName |
O nome deste cluster de atributos |
clusterMetrics |
Se a dimensão associada a esse cluster for YOUTUBE_CHANNEL, as métricas clusterMetrics serão associadas ao cluster como um todo. Para outras dimensões, esse campo não é definido. |
attributes[] |
Os atributos individuais que compõem o cluster, com metadados e métricas. |