- Ressource: Campagne
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CampaignGoal
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CampaignGoalType
- CampaignFlight
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CampaignBudget
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ExternalBudgetSource
- PrismaConfig
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- PrismaType
- PrismaCpeCode
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- 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. Référence 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 enchérir sur l'inventaire.
|
updateTime |
Uniquement en sortie. Code temporel de la dernière mise à jour de la campagne. Attribué par le système. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
campaignGoal |
Obligatoire. Objectif de la campagne. |
campaignFlight |
Obligatoire. Dépenses prévues et 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'applications ou des engagements. |
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS |
Renforcer la notoriété d'une marque ou d'un produit |
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION |
Générez des ventes hors connexion ou en magasin. |
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION |
Générer des visites ou des actions en ligne |
CampaignFlight
Paramètres de 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 son Le montant est exprimé 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. Les dates auxquelles la campagne est censée être diffusée. 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 |
Identifiant unique du budget de la campagne. Attribué par le système. Ne pas définir pour de nouveaux budgets. Doit être inclus lorsque vous modifiez ou ajoutez des budgets à la campagne |
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 pouvant être budgété par les segments d'ordre d'insertion associés. Le montant est exprimé en micros. Doit être supérieur à 0. Par exemple, 500000000 représente 500 unités standards de la devise. |
dateRange |
Obligatoire. Période associée au budget de la campagne. Les segments de budget associés peuvent avoir 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 auprès de 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 avec ce budget incluent cet ID sur la facture. Doit être unique dans la campagne. |
invoiceGroupingId |
Immuable. ID 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 regroupement de factures liées au budget", tous les |
prismaConfig |
Métadonnées supplémentaires à utiliser par l'outil Mediaocean Prisma. Obligatoire pour les budgets Mediaocean. Uniquement applicable aux annonceurs |
ExternalBudgetSource
Source externe pour un segment de budget de campagne.
Enums | |
---|---|
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED |
La valeur de la source de budget externe n'est pas spécifiée ou est inconnue dans cette version. |
EXTERNAL_BUDGET_SOURCE_NONE |
Le budget ne comporte aucune 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. Le type Prisma. |
prismaCpeCode |
Obligatoire. Codes client, produit et d'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 champs de composants de ce code.
Représentation JSON |
---|
{ "prismaClientCode": string, "prismaProductCode": string, "prismaEstimateCode": string } |
Champs | |
---|---|
prismaClientCode |
Le code du client Prisma. |
prismaProductCode |
Le code produit Prisma. |
prismaEstimateCode |
Le code d'estimation Prisma. |
Méthodes |
|
---|---|
|
Crée une campagne. |
|
Supprime définitivement une campagne. |
|
Permet d'obtenir une campagne. |
|
Liste les campagnes d'un annonceur. |
|
Liste les options de ciblage attribuées d'une campagne en fonction des différents types de ciblage. |
|
Met à jour une campagne existante. |