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)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
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 non è presente o è vuoto nel metodo insertionOrders.create, 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.
performanceGoal

object (PerformanceGoal)

Obbligatorio. Obiettivo di rendimento dell'ordine di inserzione.
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.
billableOutcome

enum (BillableOutcome)

Immutabile. Il risultato fatturabile dell'ordine di inserzione.

L'acquisto basato sui risultati è stato ritirato. BILLABLE_OUTCOME_PAY_PER_IMPRESSION è l'unico valore valido.

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.

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 performanceGoal. 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 regolare automaticamente le offerte e di spostare il budget agli elementi pubblicitari proprietari per ottimizzare il rendimento definito dal performanceGoal.

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.

BillableOutcome

Possibili risultati fatturabili per un ordine di inserzione.

Enum
BILLABLE_OUTCOME_UNSPECIFIED Risultato fatturabile non specificato.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Pagamento in base alle impressioni.
BILLABLE_OUTCOME_PAY_PER_CLICK

Pay-per-click.
BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Pagamento per Visualizzazione attiva.

Metodi

bulkListInsertionOrderAssignedTargetingOptions

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

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.

patch

 Consente di aggiornare un ordine di inserzione esistente.