REST Resource: inventorySources

Risorsa: InventorySource

Un'origine dell'inventario.

Rappresentazione JSON 
{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "subSitePropertyId": string,
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Campi
name

string

Solo output. Il nome della risorsa dell'origine dell'inventario.
inventorySourceId

string (int64 format)

Solo output. L'ID univoco dell'origine dell'inventario. Assegnato dal sistema.
displayName

string

Il nome visualizzato dell'origine dell'inventario.

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

enum (InventorySourceType)

Indica il tipo di origine dell'inventario.
inventorySourceProductType

enum (InventorySourceProductType)

Solo output. Il tipo di prodotto dell'origine dell'inventario, che indica il modo in cui vende l'inventario.
commitment

enum (InventorySourceCommitment)

Indica se l'origine dell'inventario ha una pubblicazione garantita o non garantita.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Il metodo di pubblicazione dell'origine dell'inventario.

  • Per le origini dell'inventario non garantite, l'unico valore accettabile è INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Per le origini dell'inventario garantite, i valori accettabili sono INVENTORY_SOURCE_DELIVERY_METHOD_TAG e INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

L'ID nello spazio della piattaforma di scambio che identifica in modo univoco l'origine dell'inventario.

Deve essere univoco per tutti gli acquirenti all'interno di ciascuna piattaforma di scambio pubblicitario, ma non necessariamente per tutte le piattaforme di scambio pubblicitario.
status

object (InventorySourceStatus)

Le impostazioni dello stato dell'origine dell'inventario.
exchange

enum (Exchange)

La piattaforma di scambio pubblicitario a cui appartiene l'origine dell'inventario.
updateTime

string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento dell'origine dell'inventario. Assegnato dal sistema.

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

object (RateDetails)

Obbligatorio. I dettagli delle tariffe dell'origine dell'inventario.
publisherName

string

Il nome del publisher/venditore dell'origine dell'inventario.
timeRange

object (TimeRange)

L'intervallo di tempo in cui inizia e termina la pubblicazione di questa origine dell'inventario.
creativeConfigs[]

object (CreativeConfig)

I requisiti delle creatività dell'origine dell'inventario.

Non applicabile ai pacchetti di aste.
guaranteedOrderId

string

Immutabile. L'ID dell'ordine garantito a cui appartiene questa origine dell'inventario.

Applicabile solo quando commitment è INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

Il partner o gli inserzionisti che hanno accesso in lettura/scrittura all'origine dell'inventario.

Restituisce output solo quando commitment è INVENTORY_SOURCE_COMMITMENT_GUARANTEED, nel qual caso le funzioni di accesso di lettura/scrittura vengono ereditate dall'ordine principale garantito.

Obbligatorio quando commitment è INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Se commitment è INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED e un partner è impostato in questo campo, tutti gli inserzionisti al di sotto di questo partner avranno automaticamente accesso di sola lettura all'origine dell'inventario. Questi inserzionisti non verranno inclusi in readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Solo output. Gli ID degli inserzionisti con accesso di sola lettura all'origine dell'inventario.
readPartnerIds[]

string (int64 format)

Solo output. Gli ID dei partner con accesso di sola lettura all'origine dell'inventario.

Tutti gli inserzionisti dei partner in questo campo ereditano l'accesso di sola lettura all'origine dell'inventario.

InventorySourceType

Possibili tipi di origini dell'inventario.

Enum
INVENTORY_SOURCE_TYPE_UNSPECIFIED Il tipo di origine dell'inventario non è specificato o è sconosciuto in questa versione.
INVENTORY_SOURCE_TYPE_PRIVATE Origine dell'inventario privato.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Pacchetto di aste.

InventorySourceProductType

Possibili tipi di prodotto di un'origine dell'inventario.

Enum
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Il tipo di prodotto non è specificato o è sconosciuto in questa versione. La modifica delle origini dell'inventario di questo tipo di prodotto non è supportata tramite API.
PREFERRED_DEAL L'origine dell'inventario vende l'inventario tramite un preferred deal.
PRIVATE_AUCTION L'origine dell'inventario vende l'inventario tramite l'asta privata.
PROGRAMMATIC_GUARANTEED L'origine dell'inventario vende l'inventario tramite la pubblicità programmatica garantita.
TAG_GUARANTEED L'origine dell'inventario vende l'inventario tramite la garanzia mediante tag.
YOUTUBE_RESERVE L'origine dell'inventario vende l'inventario tramite YouTube Reserve.
INSTANT_RESERVE L'origine dell'inventario vende l'inventario tramite Prenotazione istantanea. La modifica delle origini dell'inventario di questo tipo di prodotto non è supportata tramite API.
GUARANTEED_PACKAGE L'origine dell'inventario vende l'inventario tramite il pacchetto di pubblicità garantita. La modifica delle origini dell'inventario di questo tipo di prodotto non è supportata tramite API.
PROGRAMMATIC_TV La fonte dell'inventario vende l'inventario tramite la TV programmata. La modifica delle origini dell'inventario di questo tipo di prodotto non è supportata tramite API.
AUCTION_PACKAGE L'origine dell'inventario vende l'inventario tramite il pacchetto di aste. La modifica delle origini dell'inventario di questo tipo di prodotto non è supportata tramite API.

InventorySourceCommitment

Possibili tipi di impegno per un'origine dell'inventario.

Enum
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED L'impegno non è specificato o è sconosciuto in questa versione.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED L'impegno è garantito al momento della pubblicazione.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED L'impegno è una pubblicazione non garantita.

InventorySourceDeliveryMethod

Possibili metodi di pubblicazione per un'origine dell'inventario.

Enum
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Il metodo di recapito non è specificato o è sconosciuto in questa versione.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Il metodo di pubblicazione è programmatico.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Il metodo di pubblicazione è il tag.

InventorySourceStatus

Le impostazioni relative allo stato dell'origine dell'inventario.

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

enum (EntityStatus)

Indica se l'origine dell'inventario è pubblicabile.

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 questa origine dell'inventario.

Non deve superare i 100 caratteri.

Applicabile solo quando il criterio entityStatus è impostato su ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

Solo output. Lo stato impostato dal venditore per l'origine dell'inventario.

Si applica solo alle origini dell'inventario sincronizzate direttamente dai publisher. I valori accettati sono ENTITY_STATUS_ACTIVE e ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Solo output. Il motivo fornito dal venditore per mettere in pausa questa origine dell'inventario.

Applicabile solo per le origini dell'inventario sincronizzate direttamente dai publisher e quando sellerStatus è impostato su ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Solo output. Lo stato di configurazione dell'origine dell'inventario.

Valido solo per le origini dell'inventario garantite. I valori accettati sono INVENTORY_SOURCE_CONFIG_STATUS_PENDING e INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Per poter essere pubblicata, è necessario configurare un'origine dell'inventario (compila i campi obbligatori, scegli le creatività e seleziona una campagna predefinita).

InventorySourceConfigStatus

Possibili stati di configurazione per un'origine dell'inventario garantita.

Enum
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Lo stato di approvazione non è specificato o è sconosciuto in questa versione.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Lo stato iniziale di un'origine dell'inventario garantita. L'origine dell'inventario in questo stato deve essere configurata.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Lo stato dopo che l'acquirente configura un'origine dell'inventario garantita.

RateDetails

Le impostazioni relative alla tariffa dell'origine dell'inventario.

Rappresentazione JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Campi
inventorySourceRateType

enum (InventorySourceRateType)

Il tipo di tariffa.

I valori accettati sono INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR e INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

La tariffa per l'origine dell'inventario.
unitsPurchased

string (int64 format)

Obbligatorio per le origini dell'inventario garantite. Il numero di impressioni garantite dal venditore.
minimumSpend

object (Money)

Solo output. L'importo che l'acquirente si è impegnato a spendere inizialmente per l'origine dell'inventario.

Valido solo per le origini dell'inventario garantite.

InventorySourceRateType

Possibili tipi di tariffa per un'origine dell'inventario.

Enum
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Il tipo di tariffa non è specificato o è sconosciuto in questa versione.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Il tipo di tariffa è CPM (fisso).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Il tipo di tariffa è CPM (minimo).
INVENTORY_SOURCE_RATE_TYPE_CPD Il tipo di tariffa è costo giornaliero.
INVENTORY_SOURCE_RATE_TYPE_FLAT La tariffa è fissa.

Valuta

Rappresenta un importo di denaro con il relativo tipo di valuta.

Rappresentazione JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Campi
currencyCode

string

Il codice valuta di tre lettere definito nello standard ISO 4217.
units

string (int64 format)

L'intera unità dell'importo. Ad esempio, se currencyCode è "USD", 1 unità equivale a un dollaro statunitense.
nanos

integer

Numero di nano (10^-9) unità della quantità. Il valore deve essere compreso tra -999.999.999 e +999.999.999 inclusi. Se units è positivo, nanos deve essere positivo o zero. Se units è zero, nanos può essere positivo, zero o negativo. Se units è negativo, nanos deve essere negativo o pari a zero. Ad esempio,$ -1,75 è rappresentato come units=-1 e nanos=-750.000.000.

TimeRange

Un intervallo di tempo.

Rappresentazione JSON 
{
  "startTime": string,
  "endTime": string
}
Campi
startTime

string (Timestamp format)

Obbligatorio. Il limite inferiore di un intervallo di tempo (incluso).

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

string (Timestamp format)

Obbligatorio. Il limite superiore di un intervallo di tempo (incluso).

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

CreativeConfig

Configurazione dei requisiti della creatività per l'origine dell'inventario.

Rappresentazione JSON 
{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}
Campi
creativeType

enum (CreativeType)

Il tipo di creatività che può essere assegnato all'origine dell'inventario. Sono supportati solo i seguenti tipi:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Campo di unione creative_config_scheme. Applicabile quando creative_type è uno di:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

La configurazione per le creatività che possono essere assegnate all'origine dell'inventario. creative_config_scheme può essere solo uno dei seguenti:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

La configurazione per le creatività display. Applicabile quando creativeType è CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

La configurazione per le creatività video. Applicabile quando creativeType è CREATIVE_TYPE_VIDEO.

InventorySourceDisplayCreativeConfig

La configurazione per le creatività display.

Rappresentazione JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Campi
creativeSize

object (Dimensions)

I requisiti di dimensione per le creatività display che possono essere assegnate all'origine dell'inventario.

InventorySourceVideoCreativeConfig

La configurazione per le creatività video.

Rappresentazione JSON 
{
  "duration": string
}
Campi
duration

string (Duration format)

I requisiti di durata per le creatività video che possono essere assegnate all'origine dell'inventario.

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

InventorySourceAccessors

Il partner o gli inserzionisti con accesso all'origine dell'inventario.

Rappresentazione JSON 
{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}
Campi
Campo di unione accessors. Il partner o gli inserzionisti con accesso all'origine dell'inventario. accessors può essere solo uno dei seguenti:
partner

object (PartnerAccessor)

Il partner con accesso all'origine dell'inventario.
advertisers

object (AdvertiserAccessors)

Gli inserzionisti con accesso all'origine dell'inventario. Tutti gli inserzionisti devono appartenere allo stesso partner.

PartnerAccessor

Il partner con accesso all'origine dell'inventario.

Rappresentazione JSON 
{
  "partnerId": string
}
Campi
partnerId

string (int64 format)

L'ID del partner.

AdvertiserAccessors

Gli inserzionisti con accesso all'origine dell'inventario.

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

string (int64 format)

Gli ID degli inserzionisti.

Metodi

create

 Crea una nuova origine dell'inventario.

editInventorySourceReadWriteAccessors

 Modifica le funzioni di accesso di lettura/scrittura di un'origine dell'inventario.

get

 Recupera un'origine dell'inventario.

list

 Elenca le origini dell'inventario accessibili all'utente corrente.

patch

 Consente di aggiornare un'origine dell'inventario esistente.