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

Doit être encodé au format UTF-8 avec une taille maximale de 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.

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

object (PartnerCost)

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

S'ils sont absents ou vides dans la méthode insertionOrders.create, l'ordre d'insertion nouvellement créé héritera des coûts partenaires 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.
frequencyCap

object (FrequencyCap)

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

object (IntegrationDetails)

Détails d'intégration supplémentaires 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. fixedBid est défini par défaut.
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'ordre d'insertion.

Le type d'ordre d'insertion détermine les paramètres et les options applicables, tels que 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 un nombre d'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 afin de 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. Les paramètres d'enchères ne sont pas automatisés.
INSERTION_ORDER_AUTOMATION_TYPE_NONE L'enchère ou le budget ne sont pas automatisés au niveau de l'ordre d'insertion. Vous devez configurer manuellement l'enchère et le budget au niveau de l'élément de campagne.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Autorisez le système à ajuster automatiquement les enchères et à réaffecter le budget aux éléments de campagne propriétaires afin d'optimiser les performances définies par l'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 l'élément 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

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

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

object (DateRange)

Obligatoire. Paramètres de date 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, les valeurs "startDate" et "endDate" doivent toutes deux être situées dans le futur.
  • Un segment de budget existant associé à un startDate possède un endDate modifiable, mais un startDate immuable.
  • endDate doit être la valeur startDate ou une valeur ultérieure, toutes deux antérieures à l'année 2037.
campaignBudgetId

string (int64 format)

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

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

Méthodes

create

 Crée un ordre d'insertion.

delete

 Supprime un ordre d'insertion.

get

 Récupère un ordre d'insertion.

list

 Liste les ordres d'insertion d'un annonceur.

listAssignedTargetingOptions

 Liste les options de ciblage attribuées d'un ordre d'insertion pour plusieurs types de ciblage.

patch

 Met à jour un ordre d'insertion existant.