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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
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. ID unique de la campagne à laquelle appartient l'ordre d'insertion.
insertionOrderId

string (int64 format)

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

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

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

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

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".
partnerCosts[]

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

object (Pacing)

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

object (FrequencyCap)

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

object (IntegrationDetails)

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

object (PerformanceGoal)

Obligatoire. Objectif de performances de l'ordre d'insertion.
budget

object (InsertionOrderBudget)

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

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (BillableOutcome)

Immuable. Résultat facturable de l'ordre d'insertion.

Les achats en fonction du résultat sont obsolètes. BILLABLE_OUTCOME_PAY_PER_IMPRESSION est la seule valeur valide.

InsertionOrderType

Types possibles d'un ordre d'insertion.

Le type d'ordre d'insertion détermine les paramètres et les options applicables (par exemple, 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 Service de distribution par contournement

InsertionOrderBudget

Paramètres qui contrôlent la manière 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)

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 spécifique pour une période donnée d'exécution d'un ordre d'insertion.

InsertionOrderAutomationType

Options possibles pour automatiser l'enchère et le budget de l'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 performanceGoal. Aucune automatisation des paramètres d'enchères.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Aucune automatisation des enchères ou 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 aux éléments de campagne propriétaires afin d'optimiser les performances définies par performanceGoal.

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é. La quantité est exprimée en micros. Doit être supérieur à 0. Par exemple, 500000000 représente 500 unités standards de la devise.
description

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

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

string (int64 format)

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

BillableOutcome

Résultats facturables possibles pour un ordre d'insertion.

Enums
BILLABLE_OUTCOME_UNSPECIFIED Résultat facturable non spécifié.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Paiement par impression.
BILLABLE_OUTCOME_PAY_PER_CLICK

Paiement par clic.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Payez par vue active.

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.

listAssignedTargetingOptions

 Répertorie les options de ciblage attribuées à un ordre d'insertion pour tous les types de ciblage.

patch

 Met à jour un ordre d'insertion existant.