REST Resource: advertisers.campaigns

Ressource: Campagne

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 la ressource de la campagne.
advertiserId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'annonceur auquel appartient la campagne.
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é en UTF-8 et ne pas dépasser 240 octets.
entityStatus

enum (EntityStatus)

Obligatoire. Détermine si les ordres d'insertion de cette campagne peuvent dépenser leur budget et définir des enchères 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.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
campaignGoal

object (CampaignGoal)

Obligatoire. Objectif de la campagne.
campaignFlight

object (CampaignFlight)

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

object (FrequencyCap)

Obligatoire. Paramètre de la 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 de l'objectif de la campagne.
performanceGoal

object (PerformanceGoal)

Obligatoire. Objectif de performances de la campagne.

Les valeurs acceptées pour performanceGoalType sont les suivantes:

  • 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'application 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 de l'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 micros de la devise de l'annonceur.

Applicable lorsque performanceGoalType est l'un des éléments suivants:

  • 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 micro-unités.

Applicable lorsque performanceGoalType est l'un des éléments suivants:

  • 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, 70000 représente 7% (nombre décimal 0,07).
performanceGoalString

string

Chaîne d'indicateur clé de performance (KPI), qui peut être vide. Doit être encodé au format UTF-8 et ne pas dépasser 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).
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 termes de CPA (coût par action).
PERFORMANCE_GOAL_TYPE_CTR L'objectif de performances est défini en pourcentage de CTR (taux de clics).
PERFORMANCE_GOAL_TYPE_VIEWABILITY L'objectif de performances est défini dans "Pourcentage de visibilité".
PERFORMANCE_GOAL_TYPE_CPIAVC L'objectif de performances est défini sur le 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_CPV L'objectif de performances est défini en CPV (coût par vue).
PERFORMANCE_GOAL_TYPE_CLICK_CVR L'objectif de performances est défini en pourcentage de taux de conversion par clic (conversions par clic).
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR L'objectif de performances est défini en pourcentage de taux de conversion par impression (conversions par impression).
PERFORMANCE_GOAL_TYPE_VCPM L'objectif de performances est défini en vCPM (coût par mille impressions visibles).
PERFORMANCE_GOAL_TYPE_VTR L'objectif de performances est défini en pourcentage de taux de vue YouTube (vues YouTube par impression).
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE L'objectif de performances est défini en pourcentage de taux de lecture complète du contenu audio (lectures audio complètes par impression).
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE L'objectif de performances est défini en pourcentage de taux de lecture complète de la vidéo (vues complètes de la vidéo par impression).
PERFORMANCE_GOAL_TYPE_OTHER L'objectif de performances est défini sur "Autre".

CampaignFlight

Paramètres permettant de suivre les dépenses et la durée planifiées d'une campagne.

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

string (int64 format)

Montant que la campagne devrait dépenser pour son plannedDates donné. Cette opération ne limite pas la diffusion, mais permet 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. Dates de diffusion prévues de la campagne. 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 date du vol d'un ordre d'insertion enfant ne se trouve pas dans cette plage, un avertissement s'affiche dans l'interface utilisateur.
  • startDate est obligatoire et doit être la date actuelle ou une date ultérieure.
  • endDate est facultatif. Si elle est spécifiée, elle doit être startDate ou une version ultérieure.
  • Toute date spécifiée doit être antérieure à l'année 2037.

CampaignBudget

Paramètres qui contrôlent la répartition du budget de la campagne.

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 définissez pas cette valeur pour les nouveaux budgets.

Doit être inclus lorsque vous mettez à jour ou ajoutez des budgets à campaignBudgets. Sinon, un nouvel ID sera généré et attribué.
displayName

string

Obligatoire. Nom à afficher du budget.

Doit être encodé en UTF-8 et ne pas dépasser 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 que les segments d'ordres d'insertion associés peuvent budgétiser.

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. Plage de dates du budget de la campagne. La période des segments de budget associés peut être différente. Elles sont résolues en fonction du fuseau horaire de l'annonceur parent.

Les valeurs startDate et endDate doivent être antérieures à 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 diffusées pour ce budget incluront cet ID sur la facture.

Doit être unique dans la campagne.
invoiceGroupingId

string

Immuable. ID utilisé pour regrouper les budgets à inclure sur 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 externalBudgetId partageant le même invoiceGroupingId seront regroupés sur la même facture.
prismaConfig

object (PrismaConfig)

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

Obligatoire pour les budgets Mediaocean.

Uniquement applicable aux annonceurs prismaEnabled.

ExternalBudgetSource

Source externe d'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 n'a aucune source externe.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN La source du budget est Mediaocean.

PrismaConfig

Paramètres spécifiques à l'outil Prisma de Mediaocean.

Représentation JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
Champs
prismaType

enum (PrismaType)

Obligatoire. Type Prisma.
prismaCpeCode

object (PrismaCpeCode)

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

string

Obligatoire. L'entité qui a alloué ce budget (DSP, site, etc.).

PrismaType

Types de budgets Prisma possibles.

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

Google Payments Center 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

Code client Prisma.
prismaProductCode

string

Code produit Prisma.
prismaEstimateCode

string

Code d'estimation Prisma.

Méthodes

create

 Crée une campagne.

delete

 Supprime définitivement une campagne.

get

 Récupère une campagne.

list

 Liste les campagnes d'un annonceur.

listAssignedTargetingOptions

 Répertorie les options de ciblage attribuées à une campagne pour différents types de ciblage.

patch

 Met à jour une campagne existante.