REST Resource: inventorySources

Recurso: InventorySource

Uma origem de inventário.

Representação 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)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
Campos
name

string

Apenas saída. O nome do recurso da origem de inventário.
inventorySourceId

string (int64 format)

Apenas saída. O ID exclusivo da origem de inventário. Atribuído pelo sistema.
displayName

string

O nome de exibição da origem de inventário.

Precisa ser codificado em UTF-8 com um tamanho máximo de 240 bytes.
inventorySourceType

enum (InventorySourceType)

Denota o tipo da origem de inventário.
inventorySourceProductType

enum (InventorySourceProductType)

Apenas saída. O tipo de produto da origem de inventário, indicando a forma como ela vende o inventário.
commitment

enum (InventorySourceCommitment)

Se a origem de inventário tem uma veiculação garantida ou não garantida.
deliveryMethod

enum (InventorySourceDeliveryMethod)

O método de exibição da origem de inventário.

  • Para fontes de inventário não garantido, o único valor aceitável é INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Para fontes de inventário garantido, os valores aceitáveis são INVENTORY_SOURCE_DELIVERY_METHOD_TAG e INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

O ID no espaço de troca que identifica exclusivamente a origem de inventário.

Precisa ser exclusivo entre os compradores em cada exchange, mas não necessariamente entre as exchanges.
status

object (InventorySourceStatus)

As configurações de status da origem de inventário.
exchange

enum (Exchange)

A troca a que a origem de inventário pertence.
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora da última atualização da origem de inventário. Atribuído pelo sistema.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

Obrigatório. Os detalhes da taxa da origem de inventário.
publisherName

string

O nome do publisher/vendedor da origem de inventário.
timeRange

object (TimeRange)

O período em que essa origem de inventário começa e para de veicular.
creativeConfigs[]

object (CreativeConfig)

Os requisitos de criativo da origem de inventário.

Não aplicável a pacotes de leilão.
guaranteedOrderId

string

Imutável. O ID do pedido garantido a que esta origem de inventário pertence.

Aplicável somente quando commitment é INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

O parceiro ou os anunciantes que têm acesso de leitura/gravação à origem de inventário.

Saída somente quando commitment é INVENTORY_SOURCE_COMMITMENT_GUARANTEED. Nesse caso, os acessadores de leitura/gravação são herdados da ordem garantida principal.

Obrigatório quando commitment é INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Se commitment for INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED e um parceiro for definido nesse campo, todos os anunciantes desse parceiro terão acesso somente leitura à origem de inventário automaticamente. Esses anunciantes não serão incluídos em readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Apenas saída. Os IDs dos anunciantes com acesso somente leitura à origem de inventário.
readPartnerIds[]

string (int64 format)

Apenas saída. Os IDs dos parceiros com acesso somente leitura à origem de inventário.

Todos os anunciantes dos parceiros nesse campo herdam o acesso somente leitura à origem de inventário.

InventorySourceType

Tipos possíveis de origem de inventário.

Tipos enumerados
INVENTORY_SOURCE_TYPE_UNSPECIFIED O tipo de origem de inventário não foi especificado ou é desconhecido nesta versão.
INVENTORY_SOURCE_TYPE_PRIVATE Origem de inventário privada.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Pacote de leilão.

InventorySourceProductType

Possíveis tipos de produtos de uma origem de inventário.

Tipos enumerados
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED O tipo de produto não foi especificado ou é desconhecido nesta versão. Não é possível modificar as origens de inventário desse tipo de produto usando a API.
PREFERRED_DEAL A origem de inventário vende inventário por transação preferencial.
PRIVATE_AUCTION A origem de inventário vende inventário por leilão privado.
PROGRAMMATIC_GUARANTEED A origem de inventário vende inventário usando a programática garantida.
TAG_GUARANTEED A origem de inventário vende inventário com garantia de tag.
YOUTUBE_RESERVE A origem de inventário vende inventário pelo YouTube Reserve.
INSTANT_RESERVE A origem de inventário vende inventário usando a Reserva instantânea. Não é possível modificar as origens de inventário desse tipo de produto usando a API.
GUARANTEED_PACKAGE A origem de inventário vende inventário com o pacote garantido. Não é possível modificar as origens de inventário desse tipo de produto usando a API.
PROGRAMMATIC_TV A origem de inventário vende inventário pela TV programática. Não é possível modificar as origens de inventário desse tipo de produto usando a API.
AUCTION_PACKAGE A origem de inventário vende inventário usando o pacote de leilão. Não é possível modificar as origens de inventário desse tipo de produto usando a API.

InventorySourceCommitment

Possíveis tipos de compromisso para uma origem de inventário.

Tipos enumerados
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED O compromisso não foi especificado ou é desconhecido nesta versão.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED O compromisso é de entrega garantida.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED O compromisso é de entrega não garantida.

InventorySourceDeliveryMethod

Possíveis métodos de exibição para uma origem de inventário.

Tipos enumerados
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED O método de entrega não foi especificado ou é desconhecido nesta versão.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC O método de exibição é programático.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG O método de exibição é tag.

InventorySourceStatus

As configurações relacionadas ao status da origem de inventário.

Representação JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Campos
entityStatus

enum (EntityStatus)

Indica se a origem de inventário pode ser veiculada ou não.

Os valores aceitáveis são ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED e ENTITY_STATUS_PAUSED. O valor padrão é ENTITY_STATUS_ACTIVE.
entityPauseReason

string

O motivo fornecido pelo usuário para pausar essa origem de inventário.

Não pode exceder 100 caracteres.

Aplicável somente quando entityStatus está definido como ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

Apenas saída. O status definido pelo vendedor para a origem de inventário.

Aplicável somente a fontes de inventário sincronizadas diretamente dos publishers. Os valores aceitáveis são ENTITY_STATUS_ACTIVE e ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Apenas saída. O motivo fornecido pelo vendedor para pausar essa origem de inventário.

Aplicável somente para fontes de inventário sincronizadas diretamente dos editores e quando sellerStatus está definido como ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Apenas saída. O status da configuração da origem de inventário.

Aplicável somente a fontes de inventário garantido. Os valores aceitáveis são INVENTORY_SOURCE_CONFIG_STATUS_PENDING e INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Uma fonte de inventário precisa ser configurada (preencha os campos obrigatórios, escolha criativos e selecione uma campanha padrão) antes da veiculação.

InventorySourceConfigStatus

Possíveis estados de configuração para uma origem de inventário garantido.

Tipos enumerados
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED O status de aprovação não foi especificado ou é desconhecido nesta versão.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING O estado inicial de uma origem de inventário garantido. A origem de inventário nesse estado precisa ser configurada.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED O estado depois que o comprador configura uma origem de inventário garantido.

RateDetails

As configurações relacionadas à taxa da origem de inventário.

Representação JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Campos
inventorySourceRateType

enum (InventorySourceRateType)

O tipo de taxa.

Os valores aceitáveis são INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR e INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

A taxa da origem de inventário.
unitsPurchased

string (int64 format)

Obrigatório para fontes de inventário garantido. O número de impressões garantidas pelo vendedor.
minimumSpend

object (Money)

Apenas saída. O valor que o comprador se comprometeu a gastar antecipadamente na origem de inventário.

Aplicável somente a fontes de inventário garantido.

InventorySourceRateType

Tipos de taxa possíveis para uma origem de inventário.

Tipos enumerados
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED O tipo de taxa não foi especificado ou é desconhecido nesta versão.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED O tipo de taxa é CPM (fixo).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR O tipo de taxa é CPM (mínimo).
INVENTORY_SOURCE_RATE_TYPE_CPD O tipo de taxa é "Custo por dia".
INVENTORY_SOURCE_RATE_TYPE_CPH O tipo de taxa é "Custo por hora".
INVENTORY_SOURCE_RATE_TYPE_FLAT O tipo de taxa é "Flat".

Dinheiro

Representa um montante em dinheiro com o respectivo tipo de moeda.

Representação JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Campos
currencyCode

string

O código de moeda de três letras definido no ISO 4217.
units

string (int64 format)

As unidades inteiras do montante. Por exemplo, se currencyCode for "USD", então 1 unidade vai equivaler a um dólar americano.
nanos

integer

Número de unidades nano (10^-9) do montante. É necessário que o valor fique entre -999.999.999 e +999.999.999 (inclusive os dois limites). Se units for positivo, nanos será positivo ou zero. Se units for zero, nanos poderá ser positivo, zero ou negativo. Se units for negativo, nanos será negativo ou zero. Por exemplo,US $-1,75 é representado como units=-1 e nanos=-750.000.000.

TimeRange

Um período.

Representação JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Obrigatório. O limite inferior de um período, inclusive.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Obrigatório. O limite superior de um intervalo de tempo, inclusive.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CreativeConfig

Configuração de requisitos de criativo para a origem de inventário.

Representação JSON 
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
Campos
creativeType

enum (CreativeType)

O tipo de criativo que pode ser atribuído à origem de inventário. Somente os seguintes tipos são suportados:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Aplicável quando creative_type é um dos seguintes:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

A configuração dos criativos que podem ser atribuídos à origem de inventário. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

A configuração para criativos de display. Aplicável quando creativeType é CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

A configuração para criativos de vídeo. Aplicável quando creativeType é CREATIVE_TYPE_VIDEO.
Fim dos campos mutuamente exclusivos.

InventorySourceDisplayCreativeConfig

A configuração para criativos de display.

Representação JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Campos
creativeSize

object (Dimensions)

Os requisitos de tamanho para criativos de display que podem ser atribuídos à origem de inventário.

InventorySourceVideoCreativeConfig

A configuração para criativos de vídeo.

Representação JSON 
{
  "duration": string
}
Campos
duration

string (Duration format)

Os requisitos de duração para os criativos de vídeo que podem ser atribuídos à origem de inventário.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

InventorySourceAccessors

O parceiro ou os anunciantes com acesso à origem de inventário.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
Campos
O parceiro ou os anunciantes com acesso à origem de inventário. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
partner

object (PartnerAccessor)

O parceiro com acesso à origem de inventário.
advertisers

object (AdvertiserAccessors)

Os anunciantes com acesso à origem de inventário. Todos os anunciantes precisam pertencer ao mesmo parceiro.
Fim dos campos mutuamente exclusivos.

PartnerAccessor

O parceiro com acesso à origem de inventário.

Representação JSON 
{
  "partnerId": string
}
Campos
partnerId

string (int64 format)

O ID do parceiro.

AdvertiserAccessors

Os anunciantes com acesso à origem de inventário.

Representação JSON 
{
  "advertiserIds": [
    string
  ]
}
Campos
advertiserIds[]

string (int64 format)

Os IDs dos anunciantes.

Métodos

create

 Cria uma nova origem de inventário.

editInventorySourceReadWriteAccessors

 Edita os acessadores de leitura/gravação de uma origem de inventário.

get

 Recebe uma origem de inventário.

list

 Lista as fontes de inventário acessíveis ao usuário atual.

patch

 Atualiza uma origem de inventário.