REST Resource: advertisers.insertionOrders

Ressource : InsertionOrder

Un seul ordre d'insertion.

Représentation JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'ordre d'insertion.
advertiserId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'annonceur auquel appartient l'ordre d'insertion.
campaignId

string (int64 format)

Obligatoire. Immuable. Identifiant unique de la campagne à laquelle appartient l'ordre d'insertion.
insertionOrderId

string (int64 format)

Uniquement en sortie. Identifiant unique de l'ordre d'insertion. Attribué par le système.
displayName

string

Obligatoire. Nom à afficher de l'ordre d'insertion.

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

enum (InsertionOrderType)

Facultatif. Type d'ordre d'insertion.

Si ce champ n'est pas spécifié lors de la création, la valeur par défaut est RTB.
entityStatus

enum (EntityStatus)

Obligatoire. Détermine si l'ordre d'insertion peut dépenser son budget et enchérir sur l'inventaire.

  • Pour la méthode insertionOrders.create, seul ENTITY_STATUS_DRAFT est autorisé. Pour activer un ordre d'insertion, utilisez la méthode insertionOrders.patch et définissez l'état sur ENTITY_STATUS_ACTIVE après la création.
  • Un ordre d'insertion ne peut pas repasser à l'état ENTITY_STATUS_DRAFT à partir d'un autre état.
  • Un ordre d'insertion ne peut pas être défini sur ENTITY_STATUS_ACTIVE si sa campagne parente n'est pas active.
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'ordre d'insertion. Attribué par le système.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
partnerCosts[]

object (PartnerCost)

Facultatif. Coûts associés au partenaire pour l'ordre d'insertion.

Si ce champ est absent ou vide dans la méthode insertionOrders.create, l'ordre d'insertion nouvellement créé héritera des coûts associés au partenaire définis dans les paramètres du partenaire.
pacing

object (Pacing)

Obligatoire. Paramètre de vitesse de dépense du budget de l'ordre d'insertion.

pacingType PACING_TYPE_ASAP n'est pas compatible avec pacingPeriod PACING_PERIOD_FLIGHT.
frequencyCap

object (FrequencyCap)

Obligatoire. Paramètre de limitation de la fréquence d'exposition de l'ordre d'insertion.
integrationDetails

object (IntegrationDetails)

Facultatif. Informations d'intégration supplémentaires de l'ordre d'insertion.
kpi

object (Kpi)

Obligatoire. Indicateur clé de performance (KPI) de l'ordre d'insertion.

Il est représenté par l'option "Objectif" dans l'interface Display & Video 360.
budget

object (InsertionOrderBudget)

Obligatoire. Paramètres d'allocation du budget de l'ordre d'insertion.
bidStrategy

object (BiddingStrategy)

Facultatif. Stratégie d'enchères de l'ordre d'insertion. Par défaut, fixedBid est défini.

Si le champ automationType de budget est défini sur INSERTION_ORDER_AUTOMATION_TYPE_BUDGET ou INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET, l'ordre d'insertion imposera cette stratégie d'enchères à ses éléments de campagne. Si une stratégie d'enchères imposée n'est pas compatible avec le paramètre enableOptimizedTargeting d'un élément de campagne, le paramètre de ciblage optimisé sera mis à jour.
reservationType

enum (ReservationType)

Uniquement en sortie. Type de réservation de l'ordre d'insertion.
optimizationObjective

enum (OptimizationObjective)

Obligatoire. Objectif d'optimisation de l'ordre d'insertion.

InsertionOrderType

Types possibles d'un ordre d'insertion.

Le type d'ordre d'insertion détermine les paramètres et les options applicables, comme le format des annonces ou les options de ciblage.

Enums
INSERTION_ORDER_TYPE_UNSPECIFIED Le type d'ordre d'insertion n'est pas spécifié ou est inconnu.
RTB Enchères en temps réel.
OVER_THE_TOP Over-the-top.
OUT_OF_HOME Publicité extérieure.

KPI (indicateur clé de performance)

Paramètres qui contrôlent l'indicateur clé de performance (KPI) d'un ordre d'insertion.

Représentation JSON 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of mutually exclusive fields.
}
Champs
kpiType

enum (KpiType)

Obligatoire. Type de KPI.
kpiAlgorithmId

string (int64 format)

Facultatif. ID de l'algorithme d'enchères personnalisées associé à KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Ce champ est ignoré si le KPI approprié n'est pas sélectionné.
Obligatoire. Valeur du KPI. Le champ pertinent correspond à kpi_type. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
kpiAmountMicros

string (int64 format)

Montant de l'objectif, en micros de la devise de l'annonceur.

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

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Par exemple, 1500000 représente 1,5 unité standard de la devise.
kpiPercentageMicros

string (int64 format)

Représentation décimale du pourcentage de l'objectif en micro-unités.

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

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

Par exemple, 70000 représente 7% (décimale 0,07).
kpiString

string

Chaîne de KPI, qui peut être vide. Doit être encodé au format UTF-8 et ne pas dépasser 100 caractères.

Applicable lorsque kpiType est défini sur KPI_TYPE_OTHER.
Fin des champs mutuellement exclusifs.

KpiType

Types d'indicateurs clés de performance (KPI) possibles.

Enums
KPI_TYPE_UNSPECIFIED Le type de KPI n'est pas spécifié ou est inconnu dans cette version.
KPI_TYPE_CPM Le KPI est le CPM (coût pour mille impressions).
KPI_TYPE_CPC Le KPI est le CPC (coût par clic).
KPI_TYPE_CPA Le KPI est le CPA (coût par action).
KPI_TYPE_CTR Le KPI est le pourcentage de CTR (taux de clics).
KPI_TYPE_VIEWABILITY Le KPI est le pourcentage de visibilité.
KPI_TYPE_CPIAVC Le KPI est le CPIAVC (coût par impression audible et visible à la fin).
KPI_TYPE_CPE Le KPI est le CPE (coût par engagement).
KPI_TYPE_CPV Le KPI est défini en CPV (coût par vue).
KPI_TYPE_CLICK_CVR Le KPI est le pourcentage du taux de conversion des clics (conversions par clic).
KPI_TYPE_IMPRESSION_CVR Le KPI est le pourcentage du taux de conversion des impressions (conversions par impression).
KPI_TYPE_VCPM Le KPI est le vCPM (coût pour mille impressions visibles).
KPI_TYPE_VTR Le KPI est le pourcentage du taux de vue YouTube (vues YouTube par impression).
KPI_TYPE_AUDIO_COMPLETION_RATE Le KPI est le pourcentage du taux de lecture complète du contenu audio (lectures complètes de l'audio par impression).
KPI_TYPE_VIDEO_COMPLETION_RATE Le KPI est le pourcentage du taux de lecture complète de la vidéo (nombre de vues complètes de la vidéo par impression).
KPI_TYPE_CPCL Le KPI est défini en CPCL (coût par lecture complète de l'audio).
KPI_TYPE_CPCV Le KPI est défini en CPCV (coût par vue complète de la vidéo).
KPI_TYPE_TOS10 Le KPI est défini en fonction du taux de temps à l'écran de 10 secondes ou plus (pourcentage d'impressions mesurables et non désactivables qui ont été affichées à l'écran pendant au moins 10 secondes).
KPI_TYPE_MAXIMIZE_PACING Le KPI est défini pour maximiser l'impact sur la marque tout en dépensant le budget total en priorité.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST Le KPI est défini en fonction de la valeur d'impression personnalisée divisée par le coût.
KPI_TYPE_OTHER Le KPI est une autre valeur.

InsertionOrderBudget

Paramètres qui contrôlent la façon dont le budget de l'ordre d'insertion est alloué.

Représentation JSON 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Champs
budgetUnit

enum (BudgetUnit)

Obligatoire. Immuable. L'unité budgétaire indique si le budget est basé sur une devise ou sur des impressions.
automationType

enum (InsertionOrderAutomationType)

Facultatif. Type d'automatisation utilisé pour gérer l'enchère et le budget de l'ordre d'insertion.

Si ce champ n'est pas spécifié lors de la création, la valeur par défaut est INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Obligatoire. Liste des segments de budget. Utilisez un segment de budget pour spécifier un budget donné pour une période d'exécution déterminée de l'ordre d'insertion.

InsertionOrderAutomationType

Options possibles pour automatiser les enchères et le budget d'un ordre d'insertion.

Enums
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED L'option d'automatisation de l'ordre d'insertion n'est pas spécifiée ou est inconnue dans cette version.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Répartition automatique du budget. Autorisez le système à transférer automatiquement le budget vers les éléments de campagne propriétaires afin d'optimiser les performances définies par kpi. Aucune automatisation des paramètres d'enchères.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Aucune automatisation des enchères ni du budget au niveau de l'ordre d'insertion. L'enchère et le budget doivent être configurés manuellement au niveau de l'élément de campagne.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Autorisez le système à ajuster automatiquement les enchères et à transférer le budget vers les éléments de campagne propriétaires afin d'optimiser les performances définies par bidStrategy.

InsertionOrderBudgetSegment

Paramètres qui contrôlent le budget d'un seul segment de budget.

Représentation JSON 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Champs
budgetAmountMicros

string (int64 format)

Obligatoire. Montant du budget que l'ordre d'insertion dépensera pour le dateRange donné. Le montant est exprimé en micros. Doit être supérieur à 0. Par exemple, 500000000 représente 500 unités standards de la devise.
description

string

Facultatif. Description du segment de budget. Il peut être utilisé pour saisir les informations du bon de commande pour chaque segment de budget et les faire figurer sur les factures.

Le fichier doit être encodé au format UTF-8.
dateRange

object (DateRange)

Obligatoire. Paramètres des dates de début et de fin du segment de budget. Elles sont résolues par rapport au fuseau horaire de l'annonceur parent.

  • Lorsque vous créez un segment de budget, startDate et endDate doivent être dans le futur.
  • Un segment de budget existant avec une startDate dans le passé a une endDate modifiable, mais une startDate immuable.
  • endDate doit être défini sur startDate ou une date ultérieure, avant l'année 2037.
campaignBudgetId

string (int64 format)

Facultatif. budgetId du budget de la campagne dont fait partie ce segment de budget de l'ordre d'insertion.

OptimizationObjective

Types possibles d'objectifs d'optimisation.

Enums
OPTIMIZATION_OBJECTIVE_UNSPECIFIED La valeur du type n'est pas spécifiée ou est inconnue dans cette version.
CONVERSION Privilégiez les impressions qui augmentent les ventes et les conversions.
CLICK Privilégiez les impressions qui augmentent le trafic vers le site Web, les applications et les magasins d'applications.
BRAND_AWARENESS Privilégiez les impressions d'une qualité spécifique.
CUSTOM L'objectif est défini par l'algorithme d'enchères personnalisées attribué.
NO_OBJECTIVE L'objectif n'est pas défini. Vous pouvez utiliser n'importe quel KPI ou stratégie d'enchères.

Méthodes

create

 Crée un ordre d'insertion.

delete

 Supprime un ordre d'insertion.

get

 Récupère un ordre d'insertion.

list

 Répertorie les ordres d'insertion d'un annonceur.

patch

 Met à jour un ordre d'insertion existant.