REST Resource: exchanges.orders.products

Risorsa: Prodotto

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)
  },
  "etag": string
}
Campi
name

string

Nome del percorso relativo per il prodotto. Generato dal server. Esempio: "exchanges/1234/orders/5678/products/abc". Solo output.

displayName

string

Il nome visualizzato del prodotto.

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

externalDealId

string

ID esterno. Si tratta dell'ID deal nel sistema della piattaforma di scambio. 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)

Timestamp dell'ultimo aggiornamento del prodotto.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 normalizzato in base al fuso orario UTC 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)

Ora in cui questo prodotto diventa inattivo. Al momento non può essere successiva all'anno 2036. Obbligatorio.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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 della creatività per un prodotto. Obbligatorio per il prodotto di tipo transazione riservata.

makegood
(deprecated)

boolean

Indica se un prodotto è un prodotto di compensazione.

makegoodDetails
(deprecated)

object (MakegoodDetails)

I dettagli della compensazione per un prodotto. Obbligatorio quando il prodotto è un'assegnazione compensativa.

creativeSource

enum (CreativeSource)

Origine creatività per un prodotto. Facoltativo, il valore predefinito è CREATIVE_SOURCE_ADVERTISER. Non può essere modificato dopo la creazione del prodotto.

mediumType

enum (MediumType)

Tipo di mezzo per un prodotto. Se non specificato per la compatibilità con le versioni precedenti, il valore predefinito è DIGITAL. Non può essere modificato dopo la creazione del prodotto.

audienceTargetingConfig

object (AudienceTargetingConfig)

Facoltativo. Configurazione del targeting per segmenti di pubblico selezionata applicata a livello di deal su Exchange.

targetingCriteria

object (TargetingCriteria)

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

forecastResult

object (ForecastResult)

Risultati della previsione dei prodotti. Obbligatorio quando i criteri di targeting non sono vuoti e la previsione non viene fornita. Applicabile solo agli scenari di deal istantaneo.

errorDetails

object (ErrorDetails)

I dettagli dell'errore devono essere specificati quando non è possibile aggiornare campi specifici del prodotto. 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 istantaneo.

frequencyCap

object (FrequencyCap)

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

etag

string

Un ETag da specificare 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 istantaneo.

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

DimensionCreativeConfig

Dimensione 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 termini di durata.

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

string (Duration format)

La durata della creatività video 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 di ignorabilità di una creatività video.

DurationMatchType

Formati possibili per il criterio di corrispondenza della durata.

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 corrispondere a quella richiesta.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO La durata della creatività deve essere uguale o inferiore alla durata richiesta.

SkippableMatchType

Formati possibili per un prodotto.

Enum
SKIPPABLE_MATCH_TYPE_UNSPECIFIED Il tipo di annuncio 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 della compensazione.

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 La sorgente 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. Al momento le creatività ospitate dal publisher non sono supportate; qualsiasi richiesta che tenti di impostare l'origine creatività su CREATIVE_SOURCE_PUBLISHER non andrà a buon fine.

AudienceTargetingConfig

La configurazione del targeting per pubblico.

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

enum (AudienceType)

Il tipo di segmento di pubblico. Obbligatorio.

AudienceType

Tipo di pubblico.

Enum
AUDIENCE_TYPE_UNSPECIFIED Tipo 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),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Campi
type

enum (TargetingType)

Il tipo di targeting associato alle opzioni selezionate.

Campo unione value. È possibile includere un solo tipo di selezione. La selezione scelta deve corrispondere a TargetingType scelto per il campo "type". value può essere solo uno dei seguenti:
audienceSelection

object (AudienceSelection)

Segmento di pubblico selezionato.

targetingSelection

object (TargetingSelection)

Set generico di ID opzione selezionati.

TargetingType

Tipi di targeting.

Enum
TARGETING_TYPE_UNSPECIFIED Tipo di targeting non specificato, non valido per l'input.
TARGETING_TYPE_AUDIENCE Pubblico di tipo targeting.
TARGETING_TYPE_COUNTRY Paese del tipo di targeting.
TARGETING_TYPE_DMA Tipo di targeting dma.
TARGETING_TYPE_PROGRAMMER Programmatore del tipo di targeting.
TARGETING_TYPE_BRAND Brand del tipo di targeting.
TARGETING_TYPE_CONTENT_GENRE Genere di contenuti del tipo di targeting.
TARGETING_TYPE_DEVICE Dispositivo di tipo di targeting.
TARGETING_TYPE_OPERATING_SYSTEM Sistema operativo di tipo di targeting.
TARGETING_TYPE_RATING Valutazione del tipo di targeting.
TARGETING_TYPE_ENVIRONMENT Ambiente del tipo di targeting.
TARGETING_TYPE_LANGUAGE Lingua del tipo di targeting.
TARGETING_TYPE_GEO Geografia del tipo di targeting.
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 Tipo di targeting publisher.
TARGETING_TYPE_INVENTORY_SIZE Dimensioni del tipo di targeting.
TARGETING_TYPE_NETWORK Rete di tipo di targeting.
TARGETING_TYPE_PLATFORM Piattaforma del tipo di targeting.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Tipo di targeting del tipo di pubblicazione video.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Dimensioni minime del video player per il tipo di targeting video.

AudienceSelection

Opzioni di targeting per pubblico selezionate.

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

object (OrGroup)

Le opzioni incluse sono unite con AND. Ogni opzione inclusa può essere un'opzione singola o un gruppo di opzioni unite con OR.

excludedOptionIds[]

string (int64 format)

Le opzioni escluse sono unite con OR.

OrGroup

Un gruppo di opzioni selezionate unite da OR.

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

string (int64 format)

ID opzioni selezionate.

TargetingSelection

Un insieme di uno o più ID opzione selezionati, applicabile alla maggior parte dei tipi di targeting.

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

string (int64 format)

ID opzioni selezionate.

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

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Campi
forecastCategory

enum (ForecastCategory)

La categoria di previsione specificata rappresentata dalla statistica di previsione.

Campo unione forecast_data. Può essere incluso un solo tipo di dati delle statistiche. I dati inseriti devono corrispondere al campo "forecastCategory". forecast_data può essere solo uno dei seguenti:
number

string (int64 format)

Dati numerici.

percentage

integer

Dati percentuali.

cpmPrice

object (Money)

Dati sul prezzo CPM.

cpmRange

object (CpmRange)

Dati sull'intervallo di prezzo CPM.

forecastBreakdownData

object (ForecastBreakdownData)

Dati di suddivisione della previsione.

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 Prevedi la unique reach. Dati numerici.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Suddivisione previsione. Dati di suddivisione della previsione.

CpmRange

L'intervallo CPM contiene il valore minimo e massimo del CPM.

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

object (Money)

Limite inferiore dell'intervallo CPM.

maxCpm

object (Money)

Limite superiore dell'intervallo CPM.

ForecastBreakdownData

I dati di suddivisione della previsione contengono un elenco della suddivisione 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)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Campi
selectedTargetingOption

object (SelectedTargetingOption)

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

Campo unione breakdown_data. Può essere incluso un solo tipo di dati di distribuzione. breakdown_data può essere solo uno dei seguenti:
impressions

string (int64 format)

Prevedi le impressioni.

ErrorDetails

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

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

string

Il messaggio specifica quando l'aggiornamento presenta errori.

instantDealErrorStatus

enum (InstantDealErrorStatus)

Lo stato di errore specificato quando l'aggiornamento presenta errori per le offerte immediate.

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 input non validi.

FrequencyCap

Il numero di volte in cui a un utente può essere mostrato lo stesso annuncio durante 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

Ottiene il prodotto.

list

Elenca il prodotto.

patch

Aggiorna un prodotto.