REST Resource: guaranteedOrders

Risorsa: GuaranteedOrder

Un ordine garantito.

Gli ordini garantiti sono l'entità principale delle origini dell'inventario garantito. Quando crei un'origine dell'inventario garantito, devi assegnarle un ID ordine garantito.

Rappresentazione JSON 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
Campi
name

string

Solo output. Il nome della risorsa dell'ordine garantito.
legacyGuaranteedOrderId

string

Solo output. L'ID legacy dell'ordine garantito. Assegnato dalla borsa originale. L'ID legacy è univoco all'interno di una piattaforma di scambio pubblicitario, ma non è garantito che sia univoco per tutti gli ordini garantiti. Questo ID viene utilizzato nei file SDF e nell'interfaccia utente.
exchange

enum (Exchange)

Obbligatorio. Immutabile. La piattaforma di scambio pubblicitario da cui ha avuto origine l'ordine garantito.
guaranteedOrderId

string

Solo output. L'identificatore univoco dell'ordine garantito. Gli ID ordine garantito hanno il formato {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Obbligatorio. Il nome visualizzato dell'ordine garantito.

Deve avere codifica UTF-8 e una dimensione massima di 240 byte.
status

object (GuaranteedOrderStatus)

Le impostazioni dello stato dell'ordine garantito.
updateTime

string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento dell'ordine con pubblicità garantita. Assegnato dal sistema.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
publisherName

string

Obbligatorio. Il nome del publisher dell'ordine garantito.

Deve avere codifica UTF-8 e una dimensione massima di 240 byte.
readAccessInherited

boolean

Indica se tutti gli inserzionisti di readWritePartnerId hanno accesso in lettura all'ordine garantito. Applicabile solo se readWritePartnerId è impostato. Se True, esegue l'override di readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Gli ID degli inserzionisti con accesso in lettura all'ordine garantito.

Questo campo non deve includere l'inserzionista assegnato a readWriteAdvertiserId, se impostato. Tutti gli inserzionisti in questo campo devono appartenere a readWritePartnerId o allo stesso partner di readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Solo output. L'ID dell'inserzionista predefinito dell'ordine garantito.

L'inserzionista predefinito è readWriteAdvertiserId o, se non è impostato, il primo inserzionista elencato in readAdvertiserIds. In caso contrario, non esiste un inserzionista predefinito.
defaultCampaignId

string (int64 format)

L'ID della campagna predefinita assegnata all'ordine garantito.

La campagna predefinita deve appartenere all'inserzionista predefinito.

Obbligatorio.

Il partner o l'inserzionista con accesso in lettura/scrittura all'ordine garantito. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
readWritePartnerId

string (int64 format)

Il partner con accesso in lettura/scrittura all'ordine garantito.
readWriteAdvertiserId

string (int64 format)

L'inserzionista con accesso in lettura/scrittura all'ordine garantito. Questo è anche l'inserzionista predefinito dell'ordine garantito.
Fine dei campi che si escludono a vicenda.

GuaranteedOrderStatus

Le impostazioni dello stato dell'ordine garantito.

Rappresentazione JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Campi
entityStatus

enum (EntityStatus)

Indica se l'ordine garantito è pubblicabile o meno.

I valori accettati sono ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED e ENTITY_STATUS_PAUSED. Il valore predefinito è ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Il motivo fornito dall'utente per mettere in pausa questo ordine garantito.

Deve essere codificato in UTF-8 con una lunghezza massima di 100 byte.

Applicabile solo quando entityStatus è impostato su ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Solo output. Lo stato della configurazione dell'ordine garantito.

I valori accettati sono PENDING e COMPLETED.

Un ordine garantito deve essere configurato (compila i campi obbligatori, scegli le creatività e seleziona una campagna predefinita) prima di poter essere pubblicato. Al momento l'azione di configurazione può essere eseguita solo tramite l'interfaccia utente.

GuaranteedOrderConfigStatus

Possibili stati di configurazione per un ordine garantito.

Enum
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Lo stato di approvazione non è specificato o è sconosciuto in questa versione.
PENDING Lo stato iniziale di un ordine garantito. L'ordine garantito in questo stato deve essere configurato prima di poter essere pubblicato.
COMPLETED Lo stato dopo che l'acquirente ha configurato un ordine garantito.

Metodi

create

 Crea un nuovo ordine garantito.

editGuaranteedOrderReadAccessors

 Modifica gli inserzionisti di lettura di un ordine garantito.

get

 Recupera un ordine con pubblicità garantita.

list

 Elenca gli ordini garantiti accessibili all'utente corrente.

patch

 Aggiorna un ordine garantito esistente.