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),
  "optimizationObjective": enum (OptimizationObjective)
}

string

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

string (int64 format)

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

string (int64 format)

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

string (int64 format)

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

string

Obbligatoria. Il nome visualizzato dell'ordine di inserzione.

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

enum (InsertionOrderType)

Il tipo di ordine di inserzione.

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

enum (EntityStatus)

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

string (Timestamp format)

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

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

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.

object (Pacing)

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

object (FrequencyCap)

Obbligatoria. L'impostazione della quota limite dell'ordine di inserzione.

object (IntegrationDetails)

Ulteriori dettagli sull'integrazione dell'ordine di inserzione.

object (Kpi)

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

Questo è rappresentato come "Obiettivo" nell'interfaccia di Display & Video 360.

object (InsertionOrderBudget)

Obbligatoria. Le impostazioni di allocazione del budget dell'ordine di inserzione.

object (BiddingStrategy)

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

enum (ReservationType)

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

enum (OptimizationObjective)

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

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

Obbligatoria. Il tipo di KPI.

string (int64 format)

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

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.

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

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.

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

enum (BudgetUnit)

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

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.

object (InsertionOrderBudgetSegment)

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

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

string (int64 format)

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

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.

object (DateRange)

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

string (int64 format)

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