REST Resource: advertisers.campaigns

{
  "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)
    }
  ]
}

string

Uniquement en sortie. Nom de ressource de la campagne.

string (int64 format)

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

string (int64 format)

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

string

Obligatoire. Nom à afficher de la campagne.

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

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é.

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".

object (CampaignGoal)

Obligatoire. Objectif de la campagne.

object (CampaignFlight)

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

object (FrequencyCap)

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

object (CampaignBudget)

Liste des budgets disponibles pour cette campagne.

Si ce champ n'est pas défini, la campagne utilise un budget illimité.

{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}

enum (CampaignGoalType)

Obligatoire. Type d'objectif de la campagne.

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

{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}

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.

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.
• startDate est obligatoire et doit correspondre à la date du jour ou à une date ultérieure.
• endDate est facultatif. Si 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.

{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}

string (int64 format)

Identifiant unique du budget de la campagne. Attribué par le système. Ne pas définir pour les 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é.

string

Obligatoire. Nom à afficher du budget.

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

enum (BudgetUnit)

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

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.

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.

enum (ExternalBudgetSource)

Obligatoire. Source externe du budget.

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.

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.

object (PrismaConfig)

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

Obligatoire pour les budgets Mediaocean.

Uniquement applicable aux annonceurs prismaEnabled.

{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}

enum (PrismaType)

Obligatoire. Le type Prisma.

object (PrismaCpeCode)

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

string

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

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

Le code du client Prisma.

string

Le code produit Prisma.

string

Le code d'estimation Prisma.