- Ressource: InsertionOrder
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- InsertionOrderType
- InsertionOrderBudget
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- InsertionOrderAutomationType
- InsertionOrderBudgetSegment
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- BillableOutcome
- Méthodes
Ressource: InsertionOrder
Un seul ordre d'insertion.
Représentation JSON |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "displayName": string, "insertionOrderType": enum ( |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de ressource de l'ordre d'insertion. |
advertiserId |
Uniquement en sortie. ID unique de l'annonceur auquel appartient l'ordre d'insertion. |
campaignId |
Obligatoire. Immuable. ID unique de la campagne à laquelle appartient l'ordre d'insertion. |
insertionOrderId |
Uniquement en sortie. ID unique de l'ordre d'insertion. Attribué par le système. |
displayName |
Obligatoire. Nom à afficher de l'ordre d'insertion. Doit être encodé au format UTF-8 avec une taille maximale de 240 octets. |
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 |
entityStatus |
Obligatoire. Détermine si l'ordre d'insertion peut dépenser son budget et définir des enchères sur l'inventaire.
|
updateTime |
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 : |
partnerCosts[] |
Coûts associés au partenaire pour l'ordre d'insertion. S'ils sont absents ou vides dans la méthode |
pacing |
Obligatoire. Paramètre de vitesse de dépense du budget de l'ordre d'insertion. |
frequencyCap |
Obligatoire. Paramètre de limitation de la fréquence d'exposition de l'ordre d'insertion. |
integrationDetails |
Détails d'intégration supplémentaires de l'ordre d'insertion. |
performanceGoal |
Obligatoire. Objectif de performances de l'ordre d'insertion. |
budget |
Obligatoire. Paramètres de répartition du budget de l'ordre d'insertion. |
bidStrategy |
Stratégie d'enchères de l'ordre d'insertion. |
reservationType |
Uniquement en sortie. Type de réservation de l'ordre d'insertion. |
billableOutcome |
Immuable. Résultat facturable de l'ordre d'insertion. Les achats en fonction du résultat sont obsolètes. |
InsertionOrderType
Types possibles d'ordres 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 ( |
Champs | |
---|---|
budgetUnit |
Obligatoire. Immuable. L'unité budgétaire indique si le budget est basé sur une devise ou sur un nombre d'impressions. |
automationType |
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 |
budgetSegments[] |
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 ( |
Champs | |
---|---|
budgetAmountMicros |
Obligatoire. Montant du budget que l'ordre d'insertion dépensera pour l'élément |
description |
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 |
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.
|
campaignBudgetId |
|
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 |
|
---|---|
|
Crée un ordre d'insertion. |
|
Supprime un ordre d'insertion. |
|
Récupère un ordre d'insertion. |
|
Liste les ordres d'insertion d'un annonceur. |
|
Liste les options de ciblage attribuées d'un ordre d'insertion pour plusieurs types de ciblage. |
|
Met à jour un ordre d'insertion existant. |