REST Resource: advertisers.campaigns

Ressource: Campaign

Une seule campagne.

Représentation JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
Champs
name

string

Uniquement en sortie. Nom de ressource de la campagne.
advertiserId

string (int64 format)

Uniquement en sortie. Référence unique de l'annonceur auquel la campagne appartient.
campaignId

string (int64 format)

Uniquement en sortie. Identifiant unique de la campagne. Attribué par le système.
displayName

string

Obligatoire. Nom à afficher de la campagne.

Doit être encodé au format UTF-8 avec une taille maximale de 240 octets.
entityStatus

enum (EntityStatus)

Obligatoire. Détermine si les ordres d'insertion de cette campagne peuvent dépenser leurs budgets et enchérir sur l'inventaire.

  • Les valeurs acceptées sont ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED et ENTITY_STATUS_PAUSED.
  • Pour la méthode campaigns.create, ENTITY_STATUS_ARCHIVED n'est pas autorisé.
updateTime

string (Timestamp format)

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 : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
campaignGoal

object (CampaignGoal)

Obligatoire. Objectif de la campagne.
campaignFlight

object (CampaignFlight)

Obligatoire. Dépenses prévues et durée de la campagne.
frequencyCap

object (FrequencyCap)

Obligatoire. Paramètre de limite de la fréquence d'exposition de la campagne.
campaignBudgets[]

object (CampaignBudget)

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 (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Champs
campaignGoalType

enum (CampaignGoalType)

Obligatoire. Type d'objectif de la campagne.
performanceGoal

object (PerformanceGoal)

Obligatoire. Objectif de performances de la campagne.

Les valeurs acceptables pour performanceGoalType sont:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

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

PerformanceGoal

Paramètres qui contrôlent l'objectif de performances d'une campagne.

Représentation JSON 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
Champs
performanceGoalType

enum (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

string (int64 format)

Montant de l'objectif, exprimé en unités de la devise de l'annonceur.

Applicable lorsque performanceGoalType correspond à l'une des valeurs suivantes:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

Par exemple, 1 500 000 représente 1,5 unité standard de la devise.
performanceGoalPercentageMicros

string (int64 format)

Représentation décimale du pourcentage de l'objectif en micros.

Applicable lorsque performanceGoalType correspond à l'une des valeurs suivantes:

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

Par exemple, 70 000 représente 7% (0,07 décimal).
performanceGoalString

string

Une chaîne d'indicateur clé de performance (KPI), qui peut être vide. Doit être encodé au format UTF-8 avec une longueur maximale de 100 caractères.

Applicable lorsque performanceGoalType est défini sur PERFORMANCE_GOAL_TYPE_OTHER.

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 en 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 YouTube par impression).
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 complètes de l'audio 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 de suivi des dépenses planifiées et de la durée d'une campagne.

Représentation JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
Champs
plannedSpendAmountMicros

string (int64 format)

Montant que la campagne est censée dépenser pour son plannedDates donné. Cette opération ne limitera pas la diffusion, mais permettra de suivre les dépenses dans l'interface utilisateur de DV360.

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

object (DateRange)

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.

  • Les dates spécifiées ici n'ont aucune incidence sur la diffusion. Ils permettent de générer des alertes et des avertissements. Par exemple, si la période de diffusion d'un ordre d'insertion enfant se situe en dehors de la plage de ces dates, l'interface utilisateur affiche un avertissement.
  • Le champ startDate est obligatoire et doit correspondre à la date du jour ou à une date ultérieure.
  • endDate est facultatif. S'il est spécifié, il doit s'agir de startDate ou d'une version ultérieure.
  • Toute date spécifiée doit être antérieure à l'année 2037.

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 (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
Champs
budgetId

string (int64 format)

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 campaignBudgets. Sinon, un nouvel identifiant sera généré et attribué.
displayName

string

Obligatoire. Nom à afficher du budget.

Doit être encodé au format UTF-8 avec une taille maximale de 240 octets.
budgetUnit

enum (BudgetUnit)

Obligatoire. Immuable. Indique si le budget est mesuré en devise ou en impressions.
budgetAmountMicros

string (int64 format)

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

object (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.

startDate et endDate doivent tous deux être antérieurs à l'année 2037.
externalBudgetSource

enum (ExternalBudgetSource)

Obligatoire. Source externe du budget.
externalBudgetId

string

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

string

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 externalBudgetId partageant le même invoiceGroupingId seront regroupés dans la même facture.
prismaConfig

object (PrismaConfig)

Métadonnées supplémentaires à utiliser par l'outil Mediaocean Prisma.

Obligatoire pour les budgets Mediaocean.

Uniquement applicable aux annonceurs prismaEnabled.

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 (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Champs
prismaType

enum (PrismaType)

Obligatoire. Le type Prisma.
prismaCpeCode

object (PrismaCpeCode)

Obligatoire. Codes client, produit et d'estimation pertinents de l'outil Mediaocean Prisma.
supplier

string

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_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

string

Le code du client Prisma.
prismaProductCode

string

Le code produit Prisma.
prismaEstimateCode

string

Le code d'estimation Prisma.

Méthodes

create

 Crée une campagne.

delete

 Supprime définitivement une campagne.

get

 Permet d'obtenir une campagne.

list

 Liste les campagnes d'un annonceur.

listAssignedTargetingOptions

 Liste les options de ciblage attribuées d'une campagne en fonction des différents types de ciblage.

patch

 Met à jour une campagne existante.