Method: customers.generateAudienceCompositionInsights

Renvoie un ensemble d'attributs représentés dans une audience qui vous intéresse, avec des métriques qui comparent la part d'audience pour chaque attribut à sa part dans une 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/v14/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 qui vous intéresse 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 d'un mois de données historiques à utiliser pour les insights, au format "aaaa-mm". Si cette règle n'est pas configurée, les insights sur les données des 30 derniers jours s'affichent.
dimensions[]

enum (AudienceInsightsDimension)

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

string

Nom du client pour lequel effectuer la planification. Cette valeur est 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" dans la demande. Chaque dimension peut comporter plusieurs sections.

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.

InsightsAudience

Ensemble d'utilisateurs, défini par différentes caractéristiques, pour lesquels des insights peuvent être demandés dans AudienceInsightsService.

Représentation 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)
    }
  ]
}
Champs
countryLocations[]

object (LocationInfo)

Obligatoire. Pays de l'audience.
subCountryLocations[]

object (LocationInfo)

Attributs d'emplacement géographique au sein d'un autre pays. S'il est présent, chacun d'entre eux doit être inclus dans l'un des pays de ce type d'audience. Si cette valeur n'est pas renseignée, l'audience est géographiquement définie par rapport aux countryLocations.
gender

object (GenderInfo)

Genre de l'audience Si aucune valeur n'est spécifiée, l'audience n'est pas limitée en fonction du genre.
ageRanges[]

object (AgeRangeInfo)

Tranches d'âge de l'audience Si aucune valeur n'est spécifiée, l'audience représente toutes les personnes de plus de 18 ans qui correspondent aux autres attributs.
parentalStatus

object (ParentalStatusInfo)

Statut parental pour l'audience. Si aucune valeur n'est spécifiée, l'audience n'est pas limitée en fonction du statut parental.
incomeRanges[]

object (IncomeRangeInfo)

Plages de centiles des revenus du foyer pour l'audience. Si cette valeur n'est pas renseignée, l'audience n'est pas limitée par la plage de revenus du foyer.
dynamicLineups[]

object (AudienceInsightsDynamicLineup)

Lineups dynamiques représentant le contenu YouTube visionné par l'audience.
topicAudienceCombinations[]

object (InsightsAudienceAttributeGroup)

Combinaison d'attributs d'entité, de catégorie et d'intérêt de l'utilisateur définissant l'audience. La combinaison présente une structure logique AND de OR: les attributs de chaque InsightsAudienceAttributeGroup sont combinés avec OR, et les combinaisons elles-mêmes sont combinées avec AND. Par exemple, l'expression (Entité OR Affinité) AND (Sur le marché OR Catégorie) peut être formée à l'aide de deux InsightsAudienceAttributeGroups comportant deux attributs chacun.

InsightsAudienceAttributeGroup

Liste d'AudienceInsightsAttributes.

Représentation JSON 
{
  "attributes": [
    {
      object (AudienceInsightsAttribute)
    }
  ]
}
Champs
attributes[]

object (AudienceInsightsAttribute)

Obligatoire. Ensemble d'attributs d'audience à combiner avec un opérateur logique "OR". Les attributs ne doivent pas nécessairement avoir la même dimension. Seules les entités Knowledge Graph, les catégories de produits et services, ainsi que les audiences d'affinité et sur le marché sont prises en charge dans ce contexte.

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 dans 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ée 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 et ses métadonnées.
metrics

object (AudienceCompositionMetrics)

Métriques de part et d'index 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

Il s'agit du ratio entre la part d'audience et la part de référence de l'audience, ou zéro si ce ratio n'est pas défini ou n'est pas significatif.
score

number

Score de pertinence compris entre 0 et 1.

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 clusterMetrics correspond à 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.