Method: customers.generateAudienceCompositionInsights

Renvoie une collection d'attributs représentés dans une audience d'intérêt, avec des métriques qui comparent la part d'audience de chaque attribut avec sa part d'audience de référence.

Liste des erreurs générées: AudienceInsightsError AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError RequestError

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Obligatoire. ID du client.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "audience": {
    object (InsightsAudience)
  },
  "baselineAudience": {
    object (InsightsAudience)
  },
  "dataMonth": string,
  "dimensions": [
    enum (AudienceInsightsDimension)
  ],
  "customerInsightsGroup": string
}
Champs
audience

object (InsightsAudience)

Obligatoire. Audience pour laquelle des insights sont demandés.

baselineAudience

object (InsightsAudience)

Audience de référence à laquelle l'audience qui vous intéresse est comparée.

dataMonth

string

Plage de données historiques d'un mois à utiliser pour les insights, au format "aaaa-mm". Si cette règle n'est pas configurée, les insights s'affichent pour les 30 derniers jours de données.

dimensions[]

enum (AudienceInsightsDimension)

Obligatoire. Dimensions d'audience pour lesquelles des insights sur la composition doivent être renvoyés.

customerInsightsGroup

string

Nom du client pour lequel la planification est effectuée. Il s'agit d'une valeur définie par l'utilisateur.

Corps de la réponse

Message de réponse pour AudienceInsightsService.GenerateAudienceCompositionInsights.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "sections": [
    {
      object (AudienceCompositionSection)
    }
  ]
}
Champs
sections[]

object (AudienceCompositionSection)

Contenu du rapport "Insights" organisé en sections. Chaque section est associée à l'une des valeurs "AudienceInsightsDimension" de la demande. Il peut y avoir plusieurs sections par dimension.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

AudienceCompositionSection

Ensemble d'attributs associés du même type dans un rapport d'insights sur la composition de l'audience.

Représentation JSON
{
  "dimension": enum (AudienceInsightsDimension),
  "topAttributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ],
  "clusteredAttributes": [
    {
      object (AudienceCompositionAttributeCluster)
    }
  ]
}
Champs
dimension

enum (AudienceInsightsDimension)

Type des attributs de cette section.

topAttributes[]

object (AudienceCompositionAttribute)

Segments les plus pertinents pour cette audience. Si la dimension est GENDER, AGE_RANGE ou PARENTAL_STATUS, cette liste d'attributs est exhaustive.

clusteredAttributes[]

object (AudienceCompositionAttributeCluster)

Attributs supplémentaires pour cette audience, regroupés en clusters. Renseigné uniquement si la dimension est YOUTUBE_CHANNEL.

AudienceCompositionAttribute

Attribut d'audience avec des métadonnées et des métriques.

Représentation JSON
{
  "attributeMetadata": {
    object (AudienceInsightsAttributeMetadata)
  },
  "metrics": {
    object (AudienceCompositionMetrics)
  }
}
Champs
attributeMetadata

object (AudienceInsightsAttributeMetadata)

L'attribut avec ses métadonnées.

metrics

object (AudienceCompositionMetrics)

Métriques de part et d'indice pour l'attribut.

AudienceCompositionMetrics

Métriques de part et d'index associées à un attribut dans un rapport d'insights sur la composition de l'audience.

Représentation JSON
{
  "baselineAudienceShare": number,
  "audienceShare": number,
  "index": number,
  "score": number
}
Champs
baselineAudienceShare

number

Fraction (de 0 à 1 inclus) de l'audience de référence correspondant à l'attribut.

audienceShare

number

Fraction (de 0 à 1 inclus) de l'audience spécifique correspondant à l'attribut.

index

number

Ratio entre audienceShare et baselineAudienceShare, ou zéro si ce ratio n'est pas défini ou n'est pas significatif.

score

number

Un score de pertinence compris entre 0 et 1 inclus.

AudienceCompositionAttributeCluster

Ensemble d'attributs associés, avec des métadonnées et des métriques, dans un rapport d'insights sur la composition de l'audience.

Représentation JSON
{
  "clusterDisplayName": string,
  "clusterMetrics": {
    object (AudienceCompositionMetrics)
  },
  "attributes": [
    {
      object (AudienceCompositionAttribute)
    }
  ]
}
Champs
clusterDisplayName

string

Nom de ce cluster d'attributs

clusterMetrics

object (AudienceCompositionMetrics)

Si la dimension associée à ce cluster est YOUTUBE_CHANNEL, alors les métriques clusterMetrics sont des métriques associées au cluster dans son ensemble. Pour les autres dimensions, ce champ n'est pas défini.

attributes[]

object (AudienceCompositionAttribute)

Attributs individuels qui composent ce cluster, avec les métadonnées et les métriques.