- Ressource: Campaign
- CampaignGoal
- CampaignGoalType
- PerformanceGoal
- PerformanceGoalType
- CampaignFlight
- CampaignBudget
- ExternalBudgetSource
- PrismaConfig
- PrismaType
- PrismaCpeCode
- Méthodes
Ressource: Campaign
Une seule campagne
Représentation JSON |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "displayName": string, "entityStatus": enum ( |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de ressource de la campagne. |
advertiserId |
Uniquement en sortie. Identifiant unique de l'annonceur auquel la campagne appartient. |
campaignId |
Uniquement en sortie. Identifiant unique de la campagne. Attribué par le système. |
displayName |
Obligatoire. Nom à afficher de la campagne. Doit être encodé au format UTF-8 avec une taille maximale de 240 octets. |
entityStatus |
Obligatoire. Détermine si les ordres d'insertion de cette campagne peuvent dépenser leurs budgets et définir des enchères sur l'inventaire.
|
updateTime |
Uniquement en sortie. Code temporel de la dernière mise à jour de la campagne. Attribué par le système. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
campaignGoal |
Obligatoire. Objectif de la campagne. |
campaignFlight |
Obligatoire. les dépenses prévues et la durée de la campagne ; |
frequencyCap |
Obligatoire. Paramètre de limite de la fréquence d'exposition de la campagne. |
campaignBudgets[] |
Liste des budgets disponibles pour cette campagne. Si ce champ n'est pas défini, la campagne utilise un budget illimité. |
CampaignGoal
Paramètres qui contrôlent l'objectif d'une campagne.
Représentation JSON |
---|
{ "campaignGoalType": enum ( |
Champs | |
---|---|
campaignGoalType |
Obligatoire. Type d'objectif de la campagne. |
performanceGoal |
Obligatoire. Objectif de performances de la campagne. Les valeurs acceptables pour
|
CampaignGoalType
Types d'objectifs de campagne possibles.
Enums | |
---|---|
CAMPAIGN_GOAL_TYPE_UNSPECIFIED |
La valeur de l'objectif n'est pas spécifiée ou est inconnue dans cette version. |
CAMPAIGN_GOAL_TYPE_APP_INSTALL |
Générer des installations d'application ou des engagements |
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS |
Accroître la notoriété d'une marque ou d'un produit |
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION |
Générez des ventes hors ligne ou en magasin. |
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION |
Générer des visites ou des actions en ligne |
PerformanceGoal
Paramètres qui contrôlent l'objectif de performances d'une campagne.
Représentation JSON |
---|
{ "performanceGoalType": enum ( |
Champs | |
---|---|
performanceGoalType |
Obligatoire. Type d'objectif de performances. |
Champ d'union performance_goal_value . Obligatoire. Valeur de l'objectif de performances correspondant à un performance_goal_type donné. La performance_goal_value ne peut être qu'un des éléments suivants : |
|
performanceGoalAmountMicros |
Montant de l'objectif, en micro-unités de la devise de l'annonceur. Applicable lorsque
Par exemple, 1500000 représente 1,5 unité standard de la devise. |
performanceGoalPercentageMicros |
Représentation décimale du pourcentage visé, en micros. Applicable lorsque
Par exemple, 70 000 représente 7% (0,07 décimal). |
performanceGoalString |
Une chaîne d'indicateur clé de performance (KPI) qui peut être vide. Il doit être encodé au format UTF-8 et ne pas dépasser 100 caractères. Applicable lorsque |
PerformanceGoalType
Types d'objectifs de performances possibles.
Enums | |
---|---|
PERFORMANCE_GOAL_TYPE_UNSPECIFIED |
Le type d'objectif de performances n'est pas spécifié ou est inconnu dans cette version. |
PERFORMANCE_GOAL_TYPE_CPM |
L'objectif de performances est défini en CPM (coût pour mille impressions). |
PERFORMANCE_GOAL_TYPE_CPC |
L'objectif de performances est défini en CPC (coût par clic). |
PERFORMANCE_GOAL_TYPE_CPA |
L'objectif de performances est défini en CPA (coût par action). |
PERFORMANCE_GOAL_TYPE_CTR |
L'objectif de performances est défini en pourcentage du CTR (taux de clics). |
PERFORMANCE_GOAL_TYPE_VIEWABILITY |
L'objectif de performances est défini sur "Pourcentage de visibilité". |
PERFORMANCE_GOAL_TYPE_CPIAVC |
L'objectif de performances est défini sur CPIAVC (coût par impression audible et visible à la fin). |
PERFORMANCE_GOAL_TYPE_CPE |
L'objectif de performances est défini en CPE (coût par engagement). |
PERFORMANCE_GOAL_TYPE_CLICK_CVR |
L'objectif de performances est défini en pourcentage du taux de conversion des clics (conversions par clic). |
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR |
L'objectif de performances est défini en pourcentage du taux de conversion des impressions (conversions par impression). |
PERFORMANCE_GOAL_TYPE_VCPM |
L'objectif de performances est défini en VCPM (coût pour mille impressions visibles). |
PERFORMANCE_GOAL_TYPE_VTR |
L'objectif de performances est défini en pourcentage du taux de vue YouTube (vues par impression sur YouTube). |
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE |
L'objectif de performances est défini en pourcentage du taux de lecture complète de l'audio (écoutes audio complètes par impression). |
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE |
L'objectif de performances est défini en pourcentage du taux de lecture complète de la vidéo (visionnages de vidéos complètes par impression). |
PERFORMANCE_GOAL_TYPE_OTHER |
L'objectif de performances est défini sur "Autre". |
CampaignFlight
Paramètres permettant d'effectuer le suivi des dépenses planifiées et de la durée d'une campagne.
Représentation JSON |
---|
{
"plannedSpendAmountMicros": string,
"plannedDates": {
object ( |
Champs | |
---|---|
plannedSpendAmountMicros |
Montant que la campagne est censée dépenser pour la métrique " La quantité est exprimée en micros. La valeur doit être supérieure ou égale à 0. Par exemple, 500000000 représente 500 unités standards de la devise. |
plannedDates |
Obligatoire. Dates de diffusion prévues de la campagne. Elles sont résolues en fonction du fuseau horaire de l'annonceur parent.
|
CampaignBudget
Paramètres qui contrôlent la manière dont le budget de la campagne est alloué.
Représentation JSON |
---|
{ "budgetId": string, "displayName": string, "budgetUnit": enum ( |
Champs | |
---|---|
budgetId |
ID unique du budget de la campagne. Attribué par le système. Ne pas définir pour de nouveaux budgets. À inclure lorsque vous mettez à jour ou ajoutez des budgets à |
displayName |
Obligatoire. Nom à afficher du budget. Doit être encodé au format UTF-8 avec une taille maximale de 240 octets. |
budgetUnit |
Obligatoire. Immuable. Indique si le budget est mesuré en devise ou en impressions. |
budgetAmountMicros |
Obligatoire. Montant total que les segments d'ordre d'insertion associés peuvent budgétiser. La quantité est exprimée en micros. Doit être supérieur à 0. Par exemple, 500000000 représente 500 unités standards de la devise. |
dateRange |
Obligatoire. Plage de dates du budget de la campagne. Les segments de budget associés peuvent être associés à une plage de dates différente. Elles sont résolues en fonction du fuseau horaire de l'annonceur parent.
|
externalBudgetSource |
Obligatoire. Source externe du budget. |
externalBudgetId |
Immuable. ID permettant d'identifier ce budget pour la source externe. Si ce champ est défini et que le niveau de détail de la facture du profil de facturation correspondant est défini sur "Bon de commande au niveau du budget", toutes les impressions générées pour ce budget incluront cet ID sur la facture. Doit être unique au sein de la campagne. |
invoiceGroupingId |
Immuable. Identifiant utilisé pour regrouper les budgets à inclure dans la même facture. Si ce champ est défini et que le niveau de facturation du profil de facturation correspondant est défini sur "ID du groupe de factures liées au budget", tous les |
prismaConfig |
Métadonnées supplémentaires utilisées par l'outil Mediaocean Prisma. Obligatoire pour les budgets Mediaocean. Applicable uniquement aux annonceurs |
ExternalBudgetSource
Source externe d'un segment de budget de campagne.
Enums | |
---|---|
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED |
La valeur de la source du budget externe n'est pas spécifiée ou est inconnue dans cette version. |
EXTERNAL_BUDGET_SOURCE_NONE |
Le budget n'a pas de source externe. |
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN |
La source du budget est Mediaocean. |
PrismaConfig
Paramètres spécifiques à l'outil Mediaocean Prisma.
Représentation JSON |
---|
{ "prismaType": enum ( |
Champs | |
---|---|
prismaType |
Obligatoire. Type Prisma. |
prismaCpeCode |
Obligatoire. Codes client, produit et estimation pertinents de l'outil Mediaocean Prisma. |
supplier |
Obligatoire. L'entité a alloué ce budget (DSP, site, etc.). |
PrismaType
Types possibles pour un budget Prisma.
Enums | |
---|---|
PRISMA_TYPE_UNSPECIFIED |
Le type n'est pas spécifié ou est inconnu dans cette version. |
PRISMA_TYPE_DISPLAY |
Type d'affichage |
PRISMA_TYPE_SEARCH |
Type de recherche. |
PRISMA_TYPE_VIDEO |
Type de vidéo |
PRISMA_TYPE_AUDIO |
Type audio. |
PRISMA_TYPE_SOCIAL |
Type de réseau social. |
PRISMA_TYPE_FEE |
Type de frais. |
PrismaCpeCode
Le centre de paiement Google permet de rechercher et de filtrer les différents champs de ce code.
Représentation JSON |
---|
{ "prismaClientCode": string, "prismaProductCode": string, "prismaEstimateCode": string } |
Champs | |
---|---|
prismaClientCode |
Code client Prisma. |
prismaProductCode |
Code produit Prisma. |
prismaEstimateCode |
Code d'estimation Prisma. |
Méthodes |
|
---|---|
|
Crée une campagne. |
|
Cette option vous permet de supprimer définitivement une campagne. |
|
Récupère une campagne. |
|
Liste les campagnes d'un annonceur. |
|
Liste les options de ciblage attribuées à une campagne pour différents types de ciblage. |
|
Met à jour une campagne existante. |