Method: customers.generateAudienceCompositionInsights

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/v14/customers/{customerId}:generateAudienceCompositionInsights

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

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 (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
Campos
audience

object (InsightsAudience)

Obrigatório. O público-alvo de interesse para o qual os insights estão sendo solicitados.
baselineAudience

object (InsightsAudience)

O público-alvo de referência com o qual o público-alvo de interesse está sendo comparado.
dataMonth

string

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[]

enum (AudienceInsightsDimension)

Obrigatório. As dimensões de público-alvo para as quais os insights de composição devem ser retornados.
customerInsightsGroup

string

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 (AudienceCompositionSection)
    }
  ]
}
Campos
sections[]

object (AudienceCompositionSection)

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.

InsightsAudience

Um conjunto de usuários, definido por várias características, para os quais insights podem ser solicitados no AudienceInsightsService.

Representação JSON 
{
  "countryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "subCountryLocations": [
    {
      object (LocationInfo)
    }
  ],
  "gender": {
    object (GenderInfo)
  },
  "ageRanges": [
    {
      object (AgeRangeInfo)
    }
  ],
  "parentalStatus": {
    object (ParentalStatusInfo)
  },
  "incomeRanges": [
    {
      object (IncomeRangeInfo)
    }
  ],
  "dynamicLineups": [
    {
      object (AudienceInsightsDynamicLineup)
    }
  ],
  "topicAudienceCombinations": [
    {
      object (InsightsAudienceAttributeGroup)
    }
  ]
}
Campos
countryLocations[]

object (LocationInfo)

Obrigatório. Os países do público.
subCountryLocations[]

object (LocationInfo)

Atributos de localização geográfica de sub-países. Caso esteja presente, cada um deles precisa estar em um dos países desse público-alvo. Se ausente, o público-alvo estará geograficamente em countryLocations e não mais.
gender

object (GenderInfo)

Gênero para o público-alvo. Se ausente, o público-alvo não vai fazer a restrição por gênero.
ageRanges[]

object (AgeRangeInfo)

Faixas etárias do público-alvo. Se ausente, o público-alvo vai representar todas as pessoas maiores de 18 anos que correspondem aos outros atributos.
parentalStatus

object (ParentalStatusInfo)

Status parental para o público-alvo. Se ausente, o público-alvo não vai restringir por status parental.
incomeRanges[]

object (IncomeRangeInfo)

Faixas percentuais da renda familiar para o público-alvo. Se ausente, o público-alvo não restringirá por faixa de renda familiar.
dynamicLineups[]

object (AudienceInsightsDynamicLineup)

Lineups dinâmicos que representam o conteúdo do YouTube assistido pelo público.
topicAudienceCombinations[]

object (InsightsAudienceAttributeGroup)

Uma combinação de atributos de entidade, categoria e interesse do usuário que definem o público. A combinação tem uma estrutura lógica "E" de "OU": os atributos em cada InsightsAudienceAttributeGroup são combinados com "OU", e as próprias combinações são combinadas com "E". Por exemplo, a expressão (Entidade OU Afinidade) AND (No mercado OU Categoria) pode ser formada usando dois InsightsAudienceAttributeGroups com dois atributos cada.

InsightsAudienceAttributeGroup

Uma lista de AudienceInsightsAttributes.

Representação JSON 
{
  "attributes": [
    {
      object (AudienceInsightsAttribute)
    }
  ]
}
Campos
attributes[]

object (AudienceInsightsAttribute)

Obrigatório. Um conjunto de atributos de público-alvo a serem combinados com "OR" lógico. Os atributos não precisam ser todos da mesma dimensão. Somente entidades do "Mapa de informações", categorias de produtos e serviços, públicos-alvo de afinidade e no mercado são compatíveis nesse contexto.

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 (AudienceInsightsDimension),
  "topAttributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ],
  "clusteredAttributes": [
    {
      object (AudienceCompositionAttributeCluster)
    }
  ]
}
Campos
dimension

enum (AudienceInsightsDimension)

O tipo dos atributos nesta seção.
topAttributes[]

object (AudienceCompositionAttribute)

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[]

object (AudienceCompositionAttributeCluster)

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 (AudienceInsightsAttributeMetadata)
  },
  "metrics": {
    object (AudienceCompositionMetrics)
  }
}
Campos
attributeMetadata

object (AudienceInsightsAttributeMetadata)

O atributo com os metadados.
metrics

object (AudienceCompositionMetrics)

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

number

Fração (de 0 a 1) do público-alvo de referência que corresponde ao atributo.
audienceShare

number

Fração (de 0 a 1) do público-alvo específico que corresponde ao atributo.
index

number

É a proporção de "audienceShare" para "BaselineAudienceShare", ou zero se essa proporção for indefinida ou não for significativa.
score

number

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 (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
Campos
clusterDisplayName

string

O nome deste cluster de atributos
clusterMetrics

object (AudienceCompositionMetrics)

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[]

object (AudienceCompositionAttribute)

Os atributos individuais que compõem o cluster, com metadados e métricas.