REST Resource: advertisers.insertionOrders

Risorsa: Agreement Order

Un singolo ordine di inserzione.

Rappresentazione 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)
}
Campi
name

string

Solo output. Il nome della risorsa dell'ordine di inserzione.
advertiserId

string (int64 format)

Solo output. L'ID univoco dell'inserzionista a cui appartiene l'ordine di inserzione.
campaignId

string (int64 format)

Obbligatorio. Immutabile. L'ID univoco della campagna a cui appartiene l'ordine di inserzione.
insertionOrderId

string (int64 format)

Solo output. L'ID univoco dell'ordine di inserzione. Assegnato dal sistema.
displayName

string

Obbligatorio. Il nome visualizzato dell'ordine di inserzione.

Deve essere codificata in UTF-8 con una dimensione massima di 240 byte.
insertionOrderType

enum (InsertionOrderType)

Il tipo di ordine di inserzione.

Se questo campo non è specificato durante la creazione, il valore predefinito è RTB.
entityStatus

enum (EntityStatus)

Obbligatorio. Controlla se l'ordine di inserzione può spendere il budget e fare offerte per l'inventario.

  • Per il metodo insertionOrders.create, è consentito solo ENTITY_STATUS_DRAFT. Per attivare un ordine di inserzione, utilizza il metodo insertionOrders.patch e aggiorna lo stato in ENTITY_STATUS_ACTIVE dopo la creazione.
  • Non è possibile ripristinare lo stato ENTITY_STATUS_DRAFT di un ordine di inserzione passando da qualsiasi altro stato.
  • Un ordine di inserzione non può essere impostato su ENTITY_STATUS_ACTIVE se la relativa campagna principale non è attiva.
updateTime

string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento dell'ordine di inserzione. Assegnato dal sistema.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

I costi dei partner associati all'ordine di inserzione.

Se il metodo insertionOrders.create non è presente o è vuoto, l'ordine di inserzione appena creato erediterà i costi partner dalle impostazioni del partner.
pacing

object (Pacing)

Obbligatorio. L'impostazione della velocità di spesa del budget dell'ordine di inserzione.
frequencyCap

object (FrequencyCap)

Obbligatorio. L'impostazione della quota limite dell'ordine di inserzione.
integrationDetails

object (IntegrationDetails)

Ulteriori dettagli sull'integrazione dell'ordine di inserzione.
kpi

object (Kpi)

Obbligatorio. L'indicatore chiave di prestazione (KPI) dell'ordine di inserzione.

È rappresentato come "Obiettivo" nella sezione Display & Interfaccia di Video 360.
budget

object (InsertionOrderBudget)

Obbligatorio. Le impostazioni di allocazione del budget dell'ordine di inserzione.
bidStrategy

object (BiddingStrategy)

La strategia di offerta dell'ordine di inserzione. Per impostazione predefinita, è impostata l'opzione fixedBid.
reservationType

enum (ReservationType)

Solo output. Il tipo di prenotazione dell'ordine di inserzione.
optimizationObjective

enum (OptimizationObjective)

(Facoltativo) L'obiettivo di ottimizzazione dell'ordine di inserzione.

Questo campo è disponibile solo per i clienti inclusi nella lista consentita. Se un cliente non è incluso nella lista consentita, questo campo sarà nullo e i tentativi di impostazione restituiranno un errore.

InsertionOrderType

Possibili tipi di ordine di inserzione.

Il tipo di ordine di inserzione determina le impostazioni e le opzioni applicabili, come il formato degli annunci o le opzioni di targeting.

Enum
INSERTION_ORDER_TYPE_UNSPECIFIED Il tipo di ordine di inserzione non è specificato o è sconosciuto.
RTB Offerte in tempo reale.
OVER_THE_TOP Over-the-top.

KPI

Impostazioni che controllano l'indicatore chiave di prestazione (KPI) di un ordine di inserzione.

Rappresentazione JSON 
{
  "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.
}
Campi
kpiType

enum (KpiType)

Obbligatorio. Il tipo di KPI.
kpiAlgorithmId

string (int64 format)

(Facoltativo) ID algoritmo di offerte personalizzate associato a KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. Questo campo viene ignorato se non viene selezionato il KPI corretto.
Campo unione kpi_value. Obbligatorio. Il valore del KPI. Il campo pertinente corrisponde al kpi_type. kpi_value può essere solo uno dei seguenti:
kpiAmountMicros

string (int64 format)

L'importo dell'obiettivo, in micro della valuta dell'inserzionista.

Applicabile quando kpiType è uno tra:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

Ad esempio: 1500000 rappresenta 1,5 unità standard della valuta.
kpiPercentageMicros

string (int64 format)

La rappresentazione decimale della percentuale dell'obiettivo in micro.

Applicabile quando kpiType è uno tra:

  • 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

Ad esempio: 70000 rappresenta il 7% (0,07 decimale).
kpiString

string

Una stringa KPI, che può essere vuota. Deve avere codifica UTF-8 con una lunghezza massima di 100 caratteri.

Applicabile quando kpiType è KPI_TYPE_OTHER.

KpiType

Possibili tipi di indicatori chiave di prestazione (KPI).

Enum
KPI_TYPE_UNSPECIFIED Il tipo di KPI non è specificato o è sconosciuto in questa versione.
KPI_TYPE_CPM Il KPI è il CPM (costo per mille).
KPI_TYPE_CPC Il KPI è il CPC (costo per clic).
KPI_TYPE_CPA Il KPI è il CPA (costo per azione).
KPI_TYPE_CTR Il KPI è la percentuale di CTR (percentuale di clic).
KPI_TYPE_VIEWABILITY Il KPI è Percentuale di visibilità.
KPI_TYPE_CPIAVC Il KPI è il CPIAVC (costo per impressione udibile e visibile al completamento).
KPI_TYPE_CPE Il KPI è il CPE (cost per engagement).
KPI_TYPE_CPV Il KPI è impostato nel CPV (costo per visualizzazione).
KPI_TYPE_CLICK_CVR Il KPI è la percentuale del tasso di conversione dei clic (conversioni per clic).
KPI_TYPE_IMPRESSION_CVR Il KPI è la percentuale del tasso di conversione delle impressioni (conversioni per impressione).
KPI_TYPE_VCPM Il KPI è il VCPM (costo per mille impressioni visibili).
KPI_TYPE_VTR Il KPI è la percentuale di tasso di visualizzazione di YouTube (visualizzazioni di YouTube per impressione).
KPI_TYPE_AUDIO_COMPLETION_RATE Il KPI è la percentuale di percentuale di completamento audio (ascolto audio completo per impressione).
KPI_TYPE_VIDEO_COMPLETION_RATE Il KPI è la percentuale di completamento video (visualizzazioni video complete per impressione).
KPI_TYPE_CPCL Il KPI è impostato in CPCL (costo per ascolto audio completo).
KPI_TYPE_CPCV Il KPI è impostato in CPCV (costo per visualizzazione di video completa).
KPI_TYPE_TOS10 Il KPI viene impostato in termini di frequenza di tempo sullo schermo superiore a 10 secondi (percentuale di impressioni misurabili e non ignorabili che sono rimaste sullo schermo per almeno 10 secondi).
KPI_TYPE_MAXIMIZE_PACING Il KPI è impostato per massimizzare l'impatto del brand dando la priorità all'utilizzo dell'intero budget.
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST Il KPI viene impostato come valore delle impressioni personalizzate diviso per il costo.
KPI_TYPE_OTHER Il KPI è un altro valore.

InsertionOrderBudget

Impostazioni che controllano la modalità di allocazione del budget dell'ordine di inserzione.

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

enum (BudgetUnit)

Obbligatorio. Immutabile. L'unità budget specifica se il budget è basato sulla valuta o sull'impressione.
automationType

enum (InsertionOrderAutomationType)

Il tipo di automazione utilizzato per gestire l'offerta e il budget per l'ordine di inserzione.

Se questo campo non è specificato durante la creazione, il valore predefinito è INSERTION_ORDER_AUTOMATION_TYPE_NONE.
budgetSegments[]

object (InsertionOrderBudgetSegment)

Obbligatorio. L'elenco dei segmenti di budget. Utilizza un segmento di budget per specificare un budget specifico per un determinato periodo di tempo in cui un ordine di inserzione è in esecuzione.

InsertionOrderAutomationType

Possibili opzioni per l'automazione dell'offerta e del budget dell'ordine di inserzione.

Enum
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED L'opzione di automazione degli ordini di inserzione non è specificata o è sconosciuta in questa versione.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Allocazione automatica del budget. Consenti al sistema di spostare automaticamente il budget sugli elementi pubblicitari proprietari per ottimizzare il rendimento definito da kpi. Nessuna automazione nelle impostazioni delle offerte.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Nessuna automazione dell'offerta o del budget a livello di ordine di inserzione. Offerta e budget devono essere configurati manualmente a livello di elemento pubblicitario.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Consenti al sistema di aggiustare automaticamente le offerte e spostare il budget negli elementi pubblicitari proprietari per ottimizzare il rendimento definito da kpi.

InsertionOrderBudgetSegment

Impostazioni che controllano il budget di un singolo segmento di budget.

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

string (int64 format)

Obbligatorio. L'importo del budget che l'ordine di inserzione spenderà per un determinato dateRange. L'importo è in micro. Deve essere maggiore di 0. Ad esempio, 500000000 rappresenta 500 unità standard della valuta.
description

string

La descrizione del segmento di budget. Può essere utilizzato per inserire le informazioni sugli ordini di acquisto per ciascun segmento di budget e farle stampare sulle fatture.

Deve avere la codifica UTF-8.
dateRange

object (DateRange)

Obbligatorio. Le impostazioni delle date di inizio e di fine del segmento di budget. Vengono risolti in base al fuso orario dell'inserzionista principale.

  • Quando crei un nuovo segmento di budget, sia startDate sia endDate devono essere nel futuro.
  • Un segmento di budget esistente con startDate in passato ha un endDate modificabile, ma uno startDate immutabile.
  • endDate deve essere startDate o successiva, entrambe prima dell'anno 2037.
campaignBudgetId

string (int64 format)

Il budgetId del budget della campagna a cui fa parte questo segmento di budget dell'ordine di inserzione.

OptimizationObjective

Possibili tipi di obiettivi di ottimizzazione.

Enum
OPTIMIZATION_OBJECTIVE_UNSPECIFIED Il valore del tipo non è specificato o è sconosciuto in questa versione.
CONVERSION Dai la priorità alle impressioni che aumentano le vendite e le conversioni.
CLICK Dai la priorità alle impressioni che aumentano il traffico del sito web, le app e gli store.
BRAND_AWARENESS Dai la priorità alle impressioni di una qualità specifica.
CUSTOM Lo scopo è definito dall'algoritmo delle offerte personalizzate assegnato.
NO_OBJECTIVE L'obiettivo non è definito. È possibile utilizzare qualsiasi KPI o strategia di offerta.

Metodi

create

 Crea un nuovo ordine di inserzione.

delete

 Consente di eliminare un ordine di inserzione.

get

 Riceve un ordine di inserzione.

list

 Elenca gli ordini di inserzione in un inserzionista.

listAssignedTargetingOptions

 Elenca le opzioni di targeting assegnate a un ordine di inserzione tra i vari tipi di targeting.

patch

 Consente di aggiornare un ordine di inserzione esistente.