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 tamanho máximo de 240 bytes.
inventorySourceType

enum (InventorySourceType)

Indica o tipo da origem de inventário.
inventorySourceProductType

enum (InventorySourceProductType)

Apenas saída. O tipo de produto da origem de inventário, que indica a forma pela qual ela vende o inventário.
commitment

enum (InventorySourceCommitment)

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

enum (InventorySourceDeliveryMethod)

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

  • Para origens de inventário não garantidas, o único valor aceitável é INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • Para origens de inventário garantidas, 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.

Ele precisa ser único entre os compradores em cada troca, mas não necessariamente único em todas as trocas.
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 em que a origem de inventário foi atualizada pela última vez. Atribuído pelo sistema.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
rateDetails

object (RateDetails)

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

string

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

object (TimeRange)

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

object (CreativeConfig)

Os requisitos de criativos da origem de inventário.

Não se aplica a pacotes de leilão.
guaranteedOrderId

string

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

Aplicável apenas 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 apenas quando commitment é INVENTORY_SOURCE_COMMITMENT_GUARANTEED. Nesse caso, os acessadores de leitura/gravação serão herdados da ordem garantida pai.

Obrigatório quando commitment for INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Se commitment for INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED e um parceiro estiver definido neste campo, todos os anunciantes deste parceiro terão automaticamente acesso somente leitura à origem de inventário. Esses anunciantes não serão incluídos no 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 códigos dos parceiros com acesso somente leitura à origem de inventário.

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

InventorySourceType

Possíveis tipos de origem de inventário.

Enums
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 privado.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Pacote de leilão.

InventorySourceProductType

Tipos de produtos possíveis de uma origem de inventário.

Enums
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED O tipo de produto não foi especificado ou é desconhecido nesta versão. A modificação de origens de inventário desse tipo de produto não é compatível com a API.
PREFERRED_DEAL A origem de inventário vende inventário por meio da transação preferencial.
PRIVATE_AUCTION A origem de inventário vende inventário por meio de leilão privado.
PROGRAMMATIC_GUARANTEED A origem de inventário vende inventário por meio da programática garantida.
TAG_GUARANTEED A origem de inventário vende inventário por meio de uma tag garantida.
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. A modificação de origens de inventário desse tipo de produto não é compatível com a API.
GUARANTEED_PACKAGE A origem de inventário vende inventário por meio do pacote garantido. A modificação de origens de inventário desse tipo de produto não é compatível com a API.
PROGRAMMATIC_TV A origem de inventário vende inventário pela TV programática. A modificação de origens de inventário desse tipo de produto não é compatível com a API.
AUCTION_PACKAGE A origem de inventário vende inventário por meio do pacote de leilão. A modificação de origens de inventário desse tipo de produto não é compatível com a API.

InventorySourceCommitment

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

Enums
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED O compromisso não foi especificado ou é desconhecido nesta versão.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED O compromisso é a entrega garantida.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED O compromisso é uma exibição não garantida.

InventorySourceDeliveryMethod

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

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

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 informado pelo usuário para pausar essa origem de inventário.

Não pode exceder 100 caracteres.

Aplicável apenas 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 origens de inventário sincronizadas diretamente com os editores. 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 a origens de inventário sincronizadas diretamente com os editores e quando sellerStatus está definido como ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

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

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

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

InventorySourceConfigStatus

Estados de configuração possíveis para uma origem de inventário garantida.

Enums
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 garantida. A origem de inventário nesse estado precisa ser configurada.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED O estado após o comprador configurar uma origem de inventário garantida.

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 origens de inventário garantidas. É o número de impressões garantidas pelo vendedor.
minimumSpend

object (Money)

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

Aplicável somente a origens de inventário garantidas.

InventorySourceRateType

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

Enums
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 (fixa).
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_FLAT O tipo de taxa é fixo.

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", 1 unidade 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 precisará ser positivo ou zero. Se units for zero, nanos poderá ser positivo, zero ou negativo. Se units for negativo, nanos precisará 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.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Obrigatório. O limite superior de um período, inclusivo.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

CreativeConfig

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

Representação 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.
}
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

Campo de união creative_config_scheme. 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. creative_config_scheme pode ser apenas de um dos tipos a seguir:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

É a configuração dos 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.

InventorySourceDisplayCreativeConfig

É a configuração dos 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 dos criativos em 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 
{

  // 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.
}
Campos
Campo de união accessors. O parceiro ou os anunciantes com acesso à origem de inventário. accessors pode ser apenas de um dos tipos a seguir:
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.

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 origens de inventário que são acessíveis ao usuário atual.

patch

 Atualiza uma origem de inventário existente.