REST Resource: exchanges.orders.products

Risorsa: Product

Prodotto

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "program": string,
  "buyerCustomParameters": {
    string: string,
    ...
  },
  "etag": string
}
Campi
name

string

Nome della risorsa relativo al prodotto. Generato dal server. Esempio: "exchanges/1234/orders/5678/products/abc". Solo output.

displayName

string

Il nome visualizzato del prodotto.

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

externalDealId

string

ID esterno. Questo è l'ID deal nel sistema della piattaforma di scambio pubblicitario. Massimo 100 caratteri. I caratteri consentiti sono alfanumerici, trattino basso, trattino e punto. Deve essere univoco per tutti i prodotti. Obbligatorio.

transactionType

enum (TransactionType)

Tipo di transazione del prodotto. Obbligatorio.

pricingType

enum (PricingType)

Tipo di prezzo per il prodotto. Obbligatorio.

updateTime
(deprecated)

string (Timestamp format)

Il timestamp dell'ultimo aggiornamento del prodotto.

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

startTime

string (Timestamp format)

L'ora in cui questo prodotto diventa attivo. Deve essere precedente a endTime. L'ora di inizio non può essere superiore a un anno. Obbligatorio.

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

endTime

string (Timestamp format)

Il momento in cui questo prodotto diventa inattivo. Non può essere successiva all'anno 2036. Obbligatorio.

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

rateDetails

object (RateDetails)

Dettagli tariffa. Obbligatorio.

creativeConfig[]

object (CreativeConfig)

I requisiti delle creatività per un prodotto. Obbligatorio per il prodotto di tipo di transazione prenotata.

makegood
(deprecated)

boolean

Indica se un prodotto è un prodotto di compensazione.

makegoodDetails
(deprecated)

object (MakegoodDetails)

I dettagli dell'elemento pubblicitario di recupero per un prodotto. Obbligatorio quando il prodotto è un makegood.

creativeSource

enum (CreativeSource)

Origine della creatività per un prodotto. Facoltativo, il valore predefinito è CREATIVE_SOURCE_ADVERTISER. Impossibile modificarlo dopo la creazione del prodotto.

mediumType

enum (MediumType)

Tipo di supporto per un prodotto. Se non specificato, il valore predefinito è DIGITAL per la compatibilità con le versioni precedenti. Impossibile modificarlo dopo la creazione del prodotto.

audienceTargetingConfig

object (AudienceTargetingConfig)

Facoltativo. Configurazione del targeting per pubblico applicata a livello di deal sulla piattaforma di scambio pubblicitario.

targetingCriteria

object (TargetingCriteria)

Solo output. Riferimenti ai criteri di targeting per prodotto. Applicabile solo agli scenari di deal istantanei.

forecastResult

object (ForecastResult)

Risultati della previsione del prodotto. Obbligatorio quando i criteri di targeting non sono vuoti e la previsione non viene fornita. Applicabile solo agli scenari di deal istantanei.

errorDetails

object (ErrorDetails)

I dettagli dell'errore devono essere specificati quando non è possibile aggiornare campi di prodotti specifici. Obbligatorio quando il risultato della previsione non può essere fornito a causa di un criterio di targeting o non è possibile apportare un aggiornamento al prodotto. Applicabile solo agli scenari di deal istantanei.

frequencyCap

object (FrequencyCap)

Solo output. Quota limite selezionata dall'acquirente. Applicabile solo agli scenari di deal istantanei.

program

string

Solo output. Il programma nell'ambito del quale l'acquirente ha creato il deal istantaneo. Vuoto per il flusso regolare dello scambio. Applicabile solo agli scenari di deal istantanei.

buyerCustomParameters

map (key: string, value: string)

Solo output. Parametri chiave/valore personalizzati impostati dall'acquirente nella richiesta di deal istantaneo. Applicabile solo agli scenari di deal istantanei.

Un oggetto contenente un elenco di coppie "key": value. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

Un etag che deve essere specificato durante l'aggiornamento di un prodotto. Deve essere specificato per un aggiornamento solo se il campo etag non è vuoto. Applicabile solo agli scenari di deal istantanei.

CreativeConfig

Configurazione dei requisiti delle creatività per un prodotto.

Rappresentazione JSON
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Campi
creativeType

enum (CreativeType)

Tipo di creatività. Obbligatorio.

dimensionCreativeConfig

object (DimensionCreativeConfig)

La configurazione per le creatività display. Questo campo non è supportato per le creatività native (CREATIVE_TYPE_NATIVE).

durationCreativeConfig

object (DurationCreativeConfig)

La configurazione per le creatività video.

CreativeType

Possibili tipi di creatività.

Enum
CREATIVE_TYPE_UNSPECIFIED Tipo di creatività non specificato. Valore di input non valido.
CREATIVE_TYPE_DISPLAY Tipo di creatività display.
CREATIVE_TYPE_VIDEO Tipo di creatività video.
CREATIVE_TYPE_AUDIO Tipo di creatività audio.
CREATIVE_TYPE_NATIVE Tipo di creatività nativa. Questa opzione non è supportata per i prodotti con tipo di transazione RESERVED.

DimensionCreativeConfig

Dimensioni della creatività display in pixel.

Rappresentazione JSON
{
  "width": integer,
  "height": integer
}
Campi
width

integer

Larghezza della creatività display. Obbligatorio.

height

integer

Altezza della creatività display. Obbligatorio.

DurationCreativeConfig

La configurazione della creatività in base alla durata.

Rappresentazione JSON
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Campi
duration

string (Duration format)

La durata della creatività video espressa in secondi. Obbligatorio

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".

durationMatchType

enum (DurationMatchType)

I criteri di corrispondenza della durata.

skippableMatchType

enum (SkippableMatchType)

Il tipo ignorabile di una creatività video.

DurationMatchType

Criteri di corrispondenza per la durata delle creatività video.

Enum
DURATION_MATCH_TYPE_UNSPECIFIED Il criterio di corrispondenza della durata non è specificato o è sconosciuto in questa versione. Valore di input non valido.
DURATION_MATCH_TYPE_EQUAL_TO La durata della creatività deve essere uguale alla durata richiesta.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO La durata della creatività deve essere uguale o inferiore alla durata richiesta.

SkippableMatchType

Criteri di corrispondenza per stabilire se una creatività video è ignorabile.

Enum
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Il tipo ignorabile non è specificato o è sconosciuto in questa versione. Valore di input non valido.
SKIPPABLE_MATCH_TYPE_SKIPPABLE La creatività deve essere ignorabile.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE La creatività non deve essere ignorabile.
SKIPPABLE_MATCH_TYPE_ANY La creatività può essere ignorabile o non ignorabile.

MakegoodDetails

La configurazione per i dettagli dell'elemento pubblicitario di recupero.

Rappresentazione JSON
{
  "originalExternalDealId": string,
  "reason": string
}
Campi
originalExternalDealId

string

L'ID deal esterno originale che richiede l'elemento pubblicitario di recupero. Massimo 100 caratteri. I caratteri consentiti sono alfanumerici, trattino basso, trattino e punto. Obbligatorio.

reason

string

Motivo dell'elemento pubblicitario di recupero avviato dal venditore. Massimo 250 caratteri. Obbligatorio.

CreativeSource

Origine creatività: da dove verranno pubblicate le creatività.

Enum
CREATIVE_SOURCE_UNSPECIFIED L'origine della creatività non è specificata o è sconosciuta in questa versione. Valore di input non valido.
CREATIVE_SOURCE_ADVERTISER Le creatività verranno pubblicate da DV360.
CREATIVE_SOURCE_PUBLISHER Le creatività verranno pubblicate dal publisher. Le creatività ospitate dal publisher non sono attualmente supportate; qualsiasi richiesta che tenta di impostare l'origine della creatività su CREATIVE_SOURCE_PUBLISHER non andrà a buon fine.

AudienceTargetingConfig

La configurazione per il targeting per pubblico.

Rappresentazione JSON
{
  "audienceType": enum (AudienceType)
}
Campi
audienceType

enum (AudienceType)

Il tipo di pubblico. Obbligatorio.

AudienceType

Tipo di pubblico.

Enum
AUDIENCE_TYPE_UNSPECIFIED Tipo di segmento di pubblico non specificato. Non valido per l'input.
AUDIENCE_TYPE_COMMERCE Tipo di segmento di pubblico commerciale.

TargetingCriteria

Criteri di targeting specificati.

Rappresentazione JSON
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Campi
selectedTargetingOptions[]

object (SelectedTargetingOption)

Opzioni selezionate.

SelectedTargetingOption

L'opzione o le opzioni di targeting selezionate per un singolo tipo di targeting.

Rappresentazione JSON
{
  "type": enum (TargetingType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of mutually exclusive fields.
}
Campi
type

enum (TargetingType)

Tipo di targeting associato alle opzioni selezionate.

È possibile includere un solo tipo di selezione. La selezione scelta deve corrispondere al TargetingType scelto per il campo type. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
audienceSelection

object (AudienceSelection)

Segmento di pubblico selezionato.

targetingSelection

object (TargetingSelection)

Insieme generico di ID opzione selezionati.

Fine dei campi che si escludono a vicenda.

TargetingType

Tipi di targeting.

Enum
TARGETING_TYPE_UNSPECIFIED Tipo di targeting non specificato, non valido per l'input.
TARGETING_TYPE_AUDIENCE Tipo di targeting: pubblico.
TARGETING_TYPE_COUNTRY Tipo di targeting: paese.
TARGETING_TYPE_DMA Tipo di targeting DMA.
TARGETING_TYPE_PROGRAMMER Tipo di targeting: programmatore.
TARGETING_TYPE_BRAND Tipo di targeting: brand.
TARGETING_TYPE_CONTENT_GENRE Tipo di targeting per genere dei contenuti.
TARGETING_TYPE_DEVICE Tipo di targeting per dispositivo.
TARGETING_TYPE_OPERATING_SYSTEM Tipo di targeting: sistema operativo.
TARGETING_TYPE_RATING Classificazione per tipi di targeting.
TARGETING_TYPE_ENVIRONMENT Ambiente del tipo di targeting.
TARGETING_TYPE_LANGUAGE Tipo di targeting: lingua.
TARGETING_TYPE_GEO Tipo di targeting geografico.
TARGETING_TYPE_AGE Tipo di targeting per età.
TARGETING_TYPE_GENDER Tipo di targeting per genere.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segmento contestuale del tipo di targeting.
TARGETING_TYPE_REQUEST_FORMAT Formato della richiesta del tipo di targeting.
TARGETING_TYPE_PUBLISHER Publisher del tipo di targeting.
TARGETING_TYPE_INVENTORY_SIZE Dimensioni del tipo di targeting.
TARGETING_TYPE_NETWORK Tipo di targeting: rete.
TARGETING_TYPE_PLATFORM Tipo di targeting: piattaforma.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Tipo di targeting Tipo di pubblicazione video.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Tipo di targeting: dimensioni minime del video player.
TARGETING_TYPE_VIDEO_COMPLETION Tipo di targeting: posizionamento video.
TARGETING_TYPE_VIEWABILITY Visibilità del tipo di targeting.
TARGETING_TYPE_REWARDED Tipo di targeting con premio.
TARGETING_TYPE_VIDEO_AD_DURATION_THRESHOLD_SEC Soglia di durata dell'annuncio video per il tipo di targeting (sec)
TARGETING_TYPE_VIDEO_PLACEMENT Tipo di targeting: posizionamento video.
TARGETING_TYPE_VIDEO_PLAYBACK_METHOD Tipo di targeting Metodo di riproduzione video.
TARGETING_TYPE_APP_ID ID app del tipo di targeting.
TARGETING_TYPE_DOMAIN_URL URL del dominio del tipo di targeting.
TARGETING_TYPE_CTR Percentuale di clic per tipo di targeting.
TARGETING_TYPE_DEMOGRAPHICS Tipo di targeting: dati demografici.
TARGETING_TYPE_RESTRICTED_CATEGORY Categoria con restrizioni del tipo di targeting.
TARGETING_TYPE_AD_POSITION Posizione dell'annuncio per tipo di targeting.
TARGETING_TYPE_DAY_AND_TIME Tipo di targeting per giorno e ora.
TARGETING_TYPE_RETAIL_MEDIA_AUDIENCE Tipo di targeting: pubblico di retail media.

AudienceSelection

Opzioni di targeting per pubblico selezionate.

Rappresentazione JSON
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Campi
includedOrGroups[]

object (OrGroup)

Le opzioni incluse sono congiunte con AND, ogni opzione inclusa può essere un'opzione singola o un gruppo di opzioni congiunte con OR.

excludedOptionIds[]

string (int64 format)

Le opzioni escluse sono congiunte con OR.

OrGroup

Un gruppo di opzioni selezionate congiunte da OR.

Rappresentazione JSON
{
  "optionIds": [
    string
  ]
}
Campi
optionIds[]

string (int64 format)

ID delle opzioni selezionate.

TargetingSelection

Opzioni di targeting selezionate ed escluse, applicabili alla maggior parte dei tipi di targeting.

Rappresentazione JSON
{
  "optionIds": [
    string
  ],
  "externalIds": [
    string
  ],
  "excludedOptionIds": [
    string
  ],
  "excludedExternalIds": [
    string
  ]
}
Campi
optionIds[]

string (int64 format)

Solo output. ID delle opzioni di targeting DV3 selezionate condivisi con la piattaforma di scambio pubblicitario. Può essere restituito insieme a excludedOptionIds, a condizione che i due elenchi non si sovrappongano.

externalIds[]

string

Solo output. ID delle opzioni di targeting selezionate forniti dalla piattaforma di scambio pubblicitario. Può essere restituito insieme a excludedExternalIds, a condizione che i due elenchi non si sovrappongano.

excludedOptionIds[]

string (int64 format)

Solo output. ID delle opzioni di targeting DV3 escluse condivisi con la piattaforma di scambio pubblicitario. Può essere restituito insieme a optionIds, a condizione che i due elenchi non si sovrappongano.

excludedExternalIds[]

string

Solo output. ID delle opzioni di targeting escluse forniti dalla piattaforma di scambio pubblicitario. Può essere restituito insieme a externalIds, a condizione che i due elenchi non si sovrappongano.

ForecastResult

Risultato della previsione specificato.

Rappresentazione JSON
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Campi
forecasts[]

object (Forecast)

Previsione. forecastCategory deve essere univoco per ogni elemento specificato.

Previsione

Previsione della categoria di previsione specificata.

Rappresentazione JSON
{
  "forecastCategory": enum (ForecastCategory),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of mutually exclusive fields.
}
Campi
forecastCategory

enum (ForecastCategory)

La categoria di previsione specificata rappresentata dalla statistica di previsione.

È possibile includere un solo tipo di dati statistici. I dati inseriti devono corrispondere al campo forecastCategory. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
number

string (int64 format)

Dati numerici.

percentage

integer

Dati percentuali.

cpmPrice

object (Money)

Dati sui prezzi CPM.

cpmRange

object (CpmRange)

Dati sulla fascia di prezzo CPM.

forecastBreakdownData

object (ForecastBreakdownData)

Dati di suddivisione della previsione.

Fine dei campi che si escludono a vicenda.

ForecastCategory

Categoria di previsione.

Enum
FORECAST_CATEGORY_UNSPECIFIED Categoria non specificata. Non valido per l'input.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Opportunità totali. Dati numerici.
FORECAST_CATEGORY_TOTAL_AUDIENCE Pubblico totale. Dati numerici.
FORECAST_CATEGORY_DIGITAL_TRP Punti di valutazione target digitali. Dati percentuali.
FORECAST_CATEGORY_SUGGESTED_CPM Prezzo CPM suggerito. Intervallo CPM o dati sui prezzi CPM.
FORECAST_CATEGORY_UNIQUE_REACH Prevedere la Unique Reach. Dati numerici.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Suddivisione previsione. Dati di suddivisione della previsione.

CpmRange

L'intervallo CPM contiene il CPM minimo e massimo.

Rappresentazione JSON
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Campi
minCpm

object (Money)

Limite inferiore dell'intervallo del CPM.

maxCpm

object (Money)

Limite superiore dell'intervallo del CPM.

ForecastBreakdownData

I dati di suddivisione della previsione contengono un elenco di suddivisioni della previsione.

Rappresentazione JSON
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Campi
forecastBreakdowns[]

object (ForecastBreakdown)

Un elenco di suddivisioni delle previsioni.

ForecastBreakdown

Suddivisione della previsione dell'opzione di targeting selezionata.

Rappresentazione JSON
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

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

object (SelectedTargetingOption)

L'opzione o le opzioni di targeting selezionate per un singolo tipo di targeting.

È possibile includere un solo tipo di dati di suddivisione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
impressions

string (int64 format)

Prevedi le impressioni.

Fine dei campi che si escludono a vicenda.

ErrorDetails

Dettagli dell'errore specificati quando l'aggiornamento presenta errori.

Rappresentazione JSON
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Campi
message

string

Il messaggio specificato quando l'aggiornamento presenta errori.

instantDealErrorStatus

enum (InstantDealErrorStatus)

Lo stato di errore specificato quando l'aggiornamento presenta errori per i deal istantanei.

InstantDealErrorStatus

Stato di errore specificato quando l'aggiornamento istantaneo del deal presenta errori.

Enum
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Stato di errore non specificato.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE Lo stato di errore indica che l'inventario non è disponibile.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE Lo stato di errore indica che la previsione non è disponibile.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT Lo stato di errore indica che sono presenti campi di immissione non validi.

FrequencyCap

Il numero di volte in cui un utente può visualizzare lo stesso annuncio in un determinato periodo di tempo.

Rappresentazione JSON
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Campi
timeUnit

enum (TimeUnit)

L'unità di tempo in cui verrà applicata la quota limite.

maxImpressions

string (int64 format)

Il numero massimo di volte in cui un utente può visualizzare lo stesso annuncio durante questo periodo.

TimeUnit

L'unità di tempo in cui verrà applicata la quota limite.

Enum
TIME_UNIT_UNSPECIFIED Unità di tempo non specificata.
TIME_UNIT_LIFETIME La quota limite verrà applicata all'intera durata.
TIME_UNIT_MONTHS La quota limite verrà applicata a un numero di mesi.
TIME_UNIT_WEEKS La quota limite verrà applicata a un numero di settimane.
TIME_UNIT_DAYS La quota limite verrà applicata a un numero di giorni.

Metodi

create

Crea un prodotto.

get

Recupera un prodotto.

list

Elenca i prodotti.

patch

Aggiorna un prodotto.