REST Resource: advertisers.insertionOrders

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

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

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

Il doit être encodé au format UTF-8 et ne doit pas dépasser 240 octets.

enum (InsertionOrderType)

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.

enum (EntityStatus)

Obligatoire. Détermine si l'ordre d'insertion peut dépenser son budget et définir des enchères 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 son état sur ENTITY_STATUS_ACTIVE après sa création.
• Impossible de rétablir l'état ENTITY_STATUS_DRAFT d'un ordre d'insertion à partir d'un autre état.
• Impossible de définir un ordre d'insertion sur ENTITY_STATUS_ACTIVE si sa campagne parente n'est pas active.

string (Timestamp format)

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

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

object (PartnerCost)

Coûts partenaires associés à l'ordre d'insertion.

Si ce champ n'est pas renseigné ou est vide dans la méthode insertionOrders.create, l'ordre d'insertion nouvellement créé hérite des coûts partenaires définis dans les paramètres de celui-ci.

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (Kpi)

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

C'est ce que l'on appelle l'"objectif" dans l'interface Display & Video 360.

object (InsertionOrderBudget)

Obligatoire. Paramètres de répartition du budget de l'ordre d'insertion.

object (BiddingStrategy)

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

enum (ReservationType)

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

{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}

enum (KpiType)

Obligatoire. Type de KPI.

string (int64 format)

Facultatif. ID d'algorithme des enchères personnalisées associé à KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Ce champ est ignoré si le KPI approprié n'est pas sélectionné.

string (int64 format)

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

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

• KPI_TYPE_CPM
• KPI_TYPE_CPC
• KPI_TYPE_CPA
• KPI_TYPE_CPIAVC
• KPI_TYPE_VCPM

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

string (int64 format)

Représentation décimale du pourcentage visé en micros.

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

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

string

Une chaîne de KPI, qui peut être vide. Il 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.

{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}

enum (BudgetUnit)

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

enum (InsertionOrderAutomationType)

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.

object (InsertionOrderBudgetSegment)

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

{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}

string (int64 format)

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

string

Description du segment de budget. Elle permet de saisir les informations de bon de commande pour chaque segment de budget et d'imprimer ces informations sur les factures.

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

object (DateRange)

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

• Lorsque vous créez un segment de budget, startDate et endDate doivent être situés dans le futur.
• Un segment de budget existant avec un startDate est associé à un endDate modifiable, mais à un startDate immuable.
• endDate doit être startDate ou une date ultérieure, antérieure à l'année 2037.

string (int64 format)

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