REST Resource: inventorySources

Recurso: InventorySource

Es una fuente de inventario.

Representación 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

Solo salida. Es el nombre del recurso de la fuente de inventario.
inventorySourceId

string (int64 format)

Solo salida. Es el ID único de la fuente de inventario. El sistema lo asigna.
displayName

string

Es el nombre visible de la fuente de inventario.

Debe estar codificado en UTF-8 con un tamaño máximo de 240 bytes.
inventorySourceType

enum (InventorySourceType)

Indica el tipo de fuente del inventario.
inventorySourceProductType

enum (InventorySourceProductType)

Solo salida. Es el tipo de producto de la fuente de inventario, que indica la forma en que vende el inventario.
commitment

enum (InventorySourceCommitment)

Indica si la fuente de inventario tiene una publicación garantizada o no garantizada.
deliveryMethod

enum (InventorySourceDeliveryMethod)

Es el método de publicación de la fuente de inventario.

  • Para las fuentes de inventario no garantizadas, el único valor aceptable es INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
  • En el caso de las fuentes de inventario garantizado, los valores aceptables son INVENTORY_SOURCE_DELIVERY_METHOD_TAG y INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC.
dealId

string

Es el ID del espacio de intercambio que identifica de forma única la fuente del inventario.

Debe ser único entre los compradores de cada intercambio, pero no necesariamente entre los intercambios.
status

object (InventorySourceStatus)

Es la configuración de estado de la fuente del inventario.
exchange

enum (Exchange)

Es el exchange al que pertenece la fuente de inventario.
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la última actualización de la fuente del inventario. El sistema lo asigna.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
rateDetails

object (RateDetails)

Obligatorio. Son los detalles de la tarifa de la fuente de inventario.
publisherName

string

Es el nombre del editor o vendedor de la fuente de inventario.
timeRange

object (TimeRange)

Es el período durante el cual esta fuente de inventario comienza y deja de publicar anuncios.
creativeConfigs[]

object (CreativeConfig)

Son los requisitos de creatividad de la fuente de inventario.

No se aplica a los paquetes de subasta.
guaranteedOrderId

string

Inmutable. Es el ID del pedido garantizado al que pertenece esta fuente de inventario.

Solo es aplicable cuando commitment es INVENTORY_SOURCE_COMMITMENT_GUARANTEED.
readWriteAccessors

object (InventorySourceAccessors)

Es el socio o los anunciantes que tienen acceso de lectura y escritura a la fuente de inventario.

Solo se genera cuando commitment es INVENTORY_SOURCE_COMMITMENT_GUARANTEED, en cuyo caso los descriptores de acceso de lectura y escritura se heredan del orden garantizado principal.

Obligatorio cuando commitment es INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED.

Si commitment es INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED y se establece un socio en este campo, todos los anunciantes de este socio tendrán automáticamente acceso de solo lectura a la fuente de inventario. Estos anunciantes no se incluirán en readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Solo salida. Son los IDs de los anunciantes que tienen acceso de solo lectura a la fuente de inventario.
readPartnerIds[]

string (int64 format)

Solo salida. Son los IDs de los socios que tienen acceso de solo lectura a la fuente del inventario.

Todos los anunciantes de los socios incluidos en este campo heredan el acceso de solo lectura a la fuente de inventario.

InventorySourceType

Son los tipos de fuentes de inventario posibles.

Enumeraciones
INVENTORY_SOURCE_TYPE_UNSPECIFIED El tipo de fuente de inventario no se especificó o es desconocido en esta versión.
INVENTORY_SOURCE_TYPE_PRIVATE Es una fuente de inventario privada.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Es un paquete de subasta.

InventorySourceProductType

Son los tipos de productos posibles de una fuente de inventario.

Enumeraciones
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED El tipo de producto no se especifica o se desconoce en esta versión. No se admite la modificación de las fuentes de inventario de este tipo de producto a través de la API.
PREFERRED_DEAL La fuente de inventario vende inventario a través de un Acuerdo preferido.
PRIVATE_AUCTION La fuente de inventario vende inventario a través de la subasta privada.
PROGRAMMATIC_GUARANTEED La fuente de inventario vende inventario a través de la Programática garantizada.
TAG_GUARANTEED La fuente de inventario vende inventario a través de la etiqueta garantizada.
YOUTUBE_RESERVE La fuente de inventario vende inventario a través de YouTube Reserve.
INSTANT_RESERVE La fuente de inventario vende inventario a través de la Reserva instantánea. No se admite la modificación de las fuentes de inventario de este tipo de producto a través de la API.
GUARANTEED_PACKAGE La fuente de inventario vende inventario a través de paquetes garantizados. No se admite la modificación de las fuentes de inventario de este tipo de producto a través de la API.
PROGRAMMATIC_TV La fuente de inventario vende inventario a través de la TV programática. No se admite la modificación de las fuentes de inventario de este tipo de producto a través de la API.
AUCTION_PACKAGE La fuente de inventario vende inventario a través del paquete de subasta. No se admite la modificación de las fuentes de inventario de este tipo de producto a través de la API.

InventorySourceCommitment

Son los tipos de compromisos posibles para una fuente de inventario.

Enumeraciones
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED No se especificó la confirmación o se desconoce en esta versión.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED El compromiso es la entrega garantizada.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED El compromiso es la entrega no garantizada.

InventorySourceDeliveryMethod

Son los posibles métodos de publicación de una fuente de inventario.

Enumeraciones
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED El método de entrega no se especificó o es desconocido en esta versión.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC El método de publicación es programático.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG El método de publicación es la etiqueta.

InventorySourceStatus

Es la configuración relacionada con el estado de la fuente del inventario.

Representación JSON 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Campos
entityStatus

enum (EntityStatus)

Indica si la fuente de inventario puede publicarse.

Los valores aceptables son ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED y ENTITY_STATUS_PAUSED. El valor predeterminado es ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Es el motivo que proporciona el usuario para pausar esta fuente de inventario.

No debe superar los 100 caracteres.

Solo se aplica cuando entityStatus se configura como ENTITY_STATUS_PAUSED.
sellerStatus

enum (EntityStatus)

Solo salida. Es el estado que establece el vendedor para la fuente de inventario.

Solo se aplica a las fuentes de inventario que se sincronizan directamente desde los publicadores. Los valores aceptables son ENTITY_STATUS_ACTIVE y ENTITY_STATUS_PAUSED.
sellerPauseReason

string

Solo salida. Es el motivo que proporciona el vendedor para detener esta fuente de inventario.

Solo se aplica a las fuentes de inventario que se sincronizan directamente desde los publicadores y cuando sellerStatus se establece en ENTITY_STATUS_PAUSED.
configStatus

enum (InventorySourceConfigStatus)

Solo salida. Es el estado de configuración de la fuente de inventario.

Solo se aplica a las fuentes de inventario garantizado. Los valores aceptables son INVENTORY_SOURCE_CONFIG_STATUS_PENDING y INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED.

Se debe configurar una fuente de inventario (completar los campos obligatorios, elegir creatividades y seleccionar una campaña predeterminada) antes de que se pueda publicar.

InventorySourceConfigStatus

Son los posibles estados de configuración de una fuente de inventario garantizado.

Enumeraciones
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED El estado de aprobación no se especificó o se desconoce en esta versión.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Es el estado inicial de una fuente de inventario garantizado. Se debe configurar la fuente de inventario en este estado.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Es el estado después de que el comprador configura una fuente de inventario garantizado.

RateDetails

Es la configuración relacionada con la tarifa de la fuente de inventario.

Representación JSON 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Campos
inventorySourceRateType

enum (InventorySourceRateType)

Es el tipo de tarifa.

Los valores aceptables son INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR y INVENTORY_SOURCE_RATE_TYPE_CPD.
rate

object (Money)

Es la tarifa de la fuente de inventario.
unitsPurchased

string (int64 format)

Se requiere para las fuentes de inventario garantizado. Es la cantidad de impresiones que garantiza el vendedor.
minimumSpend

object (Money)

Solo salida. Es el importe que el comprador se comprometió a invertir por adelantado en la fuente de inventario.

Solo se aplica a las fuentes de inventario garantizado.

InventorySourceRateType

Son los tipos de tarifas posibles para una fuente de inventario.

Enumeraciones
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED El tipo de tarifa no se especificó o se desconoce en esta versión.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED El tipo de tarifa es CPM (fijo).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR El tipo de tarifa es CPM (base).
INVENTORY_SOURCE_RATE_TYPE_CPD El tipo de tarifa es Costo por día.
INVENTORY_SOURCE_RATE_TYPE_FLAT El tipo de tarifa es plana.

Dinero

Representa un importe de dinero con su tipo de moneda.

Representación JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Campos
currencyCode

string

Es el código de moneda de tres letras definido en la norma ISO 4217.
units

string (int64 format)

La unidad entera del importe. Por ejemplo, si currencyCode es "USD", 1 unidad es un dólar estadounidense.
nanos

integer

Número de unidades nano (10^-9) del importe. Debe ser un valor entre -999,999,999 y +999,999,999. Si units es positivo, nanos debe ser positivo o cero. Si units es cero, nanos puede ser positivo, cero o negativo. Si units es negativo, nanos debe ser negativo o cero. Por ejemplo, –$1.75 se representa como units=-1 y nanos=-750,000,000.

TimeRange

Es un período.

Representación JSON 
{
  "startTime": string,
  "endTime": string
}
Campos
startTime

string (Timestamp format)

Obligatorio. Es el límite inferior de un período, incluido.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Obligatorio. Es el límite superior de un período, incluido.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

CreativeConfig

Es la configuración de los requisitos de creatividad para la fuente de inventario.

Representación 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)

Es el tipo de creatividad que se puede asignar a la fuente de inventario. Solo se admiten los siguientes tipos:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Campo de unión creative_config_scheme. Se aplica cuando creative_type es uno de los siguientes:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Es la configuración de las creatividades que se pueden asignar a la fuente de inventario. creative_config_scheme puede ser una de las siguientes opciones:
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Es la configuración para las creatividades gráficas. Se aplica cuando creativeType es CREATIVE_TYPE_STANDARD.
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Es la configuración para las creatividades de video. Se aplica cuando creativeType es CREATIVE_TYPE_VIDEO.

InventorySourceDisplayCreativeConfig

Es la configuración para las creatividades gráficas.

Representación JSON 
{
  "creativeSize": {
    object (Dimensions)
  }
}
Campos
creativeSize

object (Dimensions)

Son los requisitos de tamaño para las creatividades gráficas que se pueden asignar a la fuente de inventario.

InventorySourceVideoCreativeConfig

Es la configuración para las creatividades de video.

Representación JSON 
{
  "duration": string
}
Campos
duration

string (Duration format)

Son los requisitos de duración para las creatividades de video que se pueden asignar a la fuente de inventario.

Una duración en segundos con hasta nueve dígitos decimales, que terminan en “s”. Ejemplo: "3.5s".

InventorySourceAccessors

Es el socio o los anunciantes que tienen acceso a la fuente de inventario.

Representación 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ón accessors. Es el socio o los anunciantes que tienen acceso a la fuente de inventario. Las direcciones (accessors) solo pueden ser una de las siguientes opciones:
partner

object (PartnerAccessor)

Es el socio que tiene acceso a la fuente de inventario.
advertisers

object (AdvertiserAccessors)

Son los anunciantes que tienen acceso a la fuente de inventario. Todos los anunciantes deben pertenecer al mismo socio.

PartnerAccessor

Es el socio que tiene acceso a la fuente de inventario.

Representación JSON 
{
  "partnerId": string
}
Campos
partnerId

string (int64 format)

Es el ID del socio.

AdvertiserAccessors

Son los anunciantes que tienen acceso a la fuente de inventario.

Representación JSON 
{
  "advertiserIds": [
    string
  ]
}
Campos
advertiserIds[]

string (int64 format)

Son los IDs de los anunciantes.

Métodos

create

 Crea una fuente de inventario nueva.

editInventorySourceReadWriteAccessors

 Edita los descriptores de acceso de lectura y escritura de una fuente de inventario.

get

 Obtiene una fuente de inventario.

list

 Enumera las fuentes de inventario a las que puede acceder el usuario actual.

patch

 Actualiza una fuente de inventario existente.