REST Resource: exchanges.orders.products

Recurso: Producto

Producto

Representación 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
}
Campos
name

string

Es el nombre de la ruta relativa del producto. El servidor lo genera. Ejemplo: "exchanges/1234/orders/5678/products/abc". Solo salida.
displayName

string

Es el nombre visible del producto.

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

string

Es el ID externo. Es el ID del acuerdo en el sistema de intercambio. Máx. de 100 caracteres. Los caracteres permitidos son alfanuméricos, guiones bajos, guiones y puntos. Debe ser único en todos los productos. Obligatorio.
transactionType

enum (TransactionType)

Es el tipo de transacción del producto. Obligatorio.
pricingType

enum (PricingType)

Es el tipo de precio del producto. Obligatorio.
updateTime
(deprecated)

string (Timestamp format)

Es la marca de tiempo de la última actualización del producto.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 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".
startTime

string (Timestamp format)

Fecha y hora en que se activa este producto. Debe ser anterior a endTime. La hora de inicio no puede ser posterior a 1 año a partir de la fecha actual. Obligatorio.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 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)

Fecha y hora en que este producto dejará de estar activo. Actualmente, no puede ser posterior al año 2036. Obligatorio.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 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)

Detalles de la tarifa Obligatorio.
creativeConfig[]

object (CreativeConfig)

Son los requisitos de la creatividad de un producto. Es obligatorio para el producto de tipo de transacción reservada.
makegood
(deprecated)

boolean

Indica si un producto es de compensación.
makegoodDetails
(deprecated)

object (MakegoodDetails)

Son los detalles de la compensación de un producto. Se requiere cuando el producto es una compensación.
creativeSource

enum (CreativeSource)

Es la fuente de la creatividad de un producto. Es opcional y el valor predeterminado es CREATIVE_SOURCE_ADVERTISER. No se puede cambiar después de crear el producto.
mediumType

enum (MediumType)

Es el tipo de medio de un producto. El valor predeterminado es DIGITAL si no se especifica para la retrocompatibilidad. No se puede cambiar después de crear el producto.
audienceTargetingConfig

object (AudienceTargetingConfig)

Opcional. Se aplicó la configuración de segmentación por público seleccionada a nivel del acuerdo en Exchange.
targetingCriteria

object (TargetingCriteria)

Solo salida. Referencias a los criterios de segmentación de productos. Solo se aplica a las situaciones de acuerdos instantáneos.
forecastResult

object (ForecastResult)

Resultados de la previsión del producto Se requiere cuando los criterios de segmentación no están vacíos y no se proporciona la previsión. Solo se aplica a las situaciones de acuerdos instantáneos.
errorDetails

object (ErrorDetails)

Se deben especificar los detalles del error cuando no se puedan actualizar campos específicos del producto. Se requiere cuando no se puede proporcionar el resultado de la previsión debido a un criterio de segmentación o no se puede realizar una actualización del producto. Solo se aplica a las situaciones de acuerdos instantáneos.
frequencyCap

object (FrequencyCap)

Solo salida. Es el límite de frecuencia seleccionado por el comprador. Solo se aplica a las situaciones de acuerdos instantáneos.
etag

string

Es un ETag que se debe especificar cuando se actualiza un producto. Solo se debe especificar para una actualización si el campo de ETag no está vacío. Solo se aplica a las situaciones de acuerdos instantáneos.

CreativeConfig

Es la configuración de requisitos de creatividad para un producto.

Representación JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Campos
creativeType

enum (CreativeType)

Tipo de creatividad. Obligatorio.
dimensionCreativeConfig

object (DimensionCreativeConfig)

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

Este campo no es compatible con las creatividades nativas (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

Es la configuración de las creatividades de video.

CreativeType

Son los tipos de creatividades posibles.

Enumeraciones
CREATIVE_TYPE_UNSPECIFIED No se especificó el tipo de creatividad. El valor de entrada no es válido.
CREATIVE_TYPE_DISPLAY Es el tipo de creatividad de la pantalla.
CREATIVE_TYPE_VIDEO Es el tipo de creatividad de video.
CREATIVE_TYPE_AUDIO Es el tipo de creatividad de audio.
CREATIVE_TYPE_NATIVE Es el tipo de creatividad nativa.

DimensionCreativeConfig

Es la dimensión de la creatividad de pantalla en píxeles.

Representación JSON 
{
  "width": integer,
  "height": integer
}
Campos
width

integer

Ancho de la creatividad de Display. Obligatorio.
height

integer

Es la altura de la creatividad de Display. Obligatorio.

DurationCreativeConfig

Es la configuración de la creatividad en términos de duración.

Representación JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Campos
duration

string (Duration format)

Indica la duración de la creatividad de video en segundos. Obligatorio

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

enum (DurationMatchType)

Son los criterios de coincidencia de duración.
skippableMatchType

enum (SkippableMatchType)

Es el tipo de creatividad de video que se puede omitir.

DurationMatchType

Son los formatos posibles para el criterio de coincidencia de duración.

Enumeraciones
DURATION_MATCH_TYPE_UNSPECIFIED El criterio de coincidencia de duración no se especifica o es desconocido en esta versión. El valor de entrada no es válido.
DURATION_MATCH_TYPE_EQUAL_TO La duración de la creatividad debe ser la misma que la duración requerida.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO La duración de la creatividad debe ser igual o inferior a la duración requerida.

SkippableMatchType

Son los formatos posibles para un producto.

Enumeraciones
SKIPPABLE_MATCH_TYPE_UNSPECIFIED El tipo de elemento que se puede omitir no se especificó o es desconocido en esta versión. El valor de entrada no es válido.
SKIPPABLE_MATCH_TYPE_SKIPPABLE La creatividad debe poder omitirse.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE La creatividad no debe poder omitirse.
SKIPPABLE_MATCH_TYPE_ANY La creatividad puede ser omitible o no omitible.

MakegoodDetails

Es la configuración de los detalles de la compensación.

Representación JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
Campos
originalExternalDealId

string

Es el ID de acuerdo externo original que solicita una compensación. Máx. de 100 caracteres. Los caracteres permitidos son alfanuméricos, guiones bajos, guiones y puntos. Obligatorio.
reason

string

Es el motivo de la compensación iniciada por el vendedor. Máx. 250 caracteres. Obligatorio.

CreativeSource

Es la fuente de la creatividad, es decir, desde dónde se publicarán las creatividades.

Enumeraciones
CREATIVE_SOURCE_UNSPECIFIED En esta versión, no se especifica o se desconoce la fuente de la creatividad. El valor de entrada no es válido.
CREATIVE_SOURCE_ADVERTISER DV3 publicará las creatividades.
CREATIVE_SOURCE_PUBLISHER El publicador publicará las creatividades. Actualmente, no se admiten las creatividades alojadas por el publicador. Fallará cualquier solicitud que intente establecer la fuente de la creatividad en CREATIVE_SOURCE_PUBLISHER.

AudienceTargetingConfig

Es la configuración de la segmentación por público.

Representación JSON 
{
  "audienceType": enum (AudienceType)
}
Campos
audienceType

enum (AudienceType)

Es el tipo de público. Obligatorio.

AudienceType

Es el tipo de público.

Enumeraciones
AUDIENCE_TYPE_UNSPECIFIED Es un tipo de público sin especificar. No es válido como entrada.
AUDIENCE_TYPE_COMMERCE Es el tipo de público de comercio.

TargetingCriteria

Se especificaron los criterios de segmentación.

Representación JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Campos
selectedTargetingOptions[]

object (SelectedTargetingOption)

Opciones seleccionadas.

SelectedTargetingOption

Es la opción o las opciones de segmentación seleccionadas para un solo tipo de segmentación.

Representación 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.
}
Campos
type

enum (TargetingType)

Es el tipo de segmentación asociado a las opciones seleccionadas.
Campo de unión value. Solo se puede incluir un tipo de selección. La selección elegida debe corresponder al TargetingType elegido para el campo "type". Las direcciones (value) solo pueden ser una de las siguientes opciones:
audienceSelection

object (AudienceSelection)

Público seleccionado.
targetingSelection

object (TargetingSelection)

Es un conjunto genérico de IDs de opciones seleccionadas.

TargetingType

Son los tipos de segmentación.

Enumeraciones
TARGETING_TYPE_UNSPECIFIED Tipo de segmentación no especificado, no es válido para la entrada.
TARGETING_TYPE_AUDIENCE Es un público de tipo segmentación.
TARGETING_TYPE_COUNTRY Es el país del tipo de segmentación.
TARGETING_TYPE_DMA Es el tipo de segmentación por DMA.
TARGETING_TYPE_PROGRAMMER Es el programador del tipo de segmentación.
TARGETING_TYPE_BRAND Es la marca del tipo de segmentación.
TARGETING_TYPE_CONTENT_GENRE Es el género de contenido del tipo de segmentación.
TARGETING_TYPE_DEVICE Es el tipo de dispositivo de segmentación.
TARGETING_TYPE_OPERATING_SYSTEM Es el sistema operativo del tipo de segmentación.
TARGETING_TYPE_RATING Es la calificación del tipo de segmentación.
TARGETING_TYPE_ENVIRONMENT Es el entorno del tipo de segmentación.
TARGETING_TYPE_LANGUAGE Es el idioma del tipo de segmentación.
TARGETING_TYPE_GEO Es la segmentación geográfica del tipo de segmentación.
TARGETING_TYPE_AGE Es el tipo de segmentación por edad.
TARGETING_TYPE_GENDER Es el género del tipo de segmentación.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Es el tipo de segmentación contextual del segmento.
TARGETING_TYPE_REQUEST_FORMAT Es el formato de solicitud del tipo de segmentación.
TARGETING_TYPE_PUBLISHER Es el publicador del tipo de segmentación.
TARGETING_TYPE_INVENTORY_SIZE Es el tamaño del tipo de segmentación.
TARGETING_TYPE_NETWORK Es la red del tipo de segmentación.
TARGETING_TYPE_PLATFORM Es la plataforma del tipo de segmentación.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Es el tipo de segmentación del tipo de publicación de video.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Es el tamaño mínimo del reproductor de video para el tipo de segmentación.

AudienceSelection

Opciones de segmentación por público seleccionadas.

Representación JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Campos
includedOrGroups[]

object (OrGroup)

Las opciones incluidas se combinan con AND. Cada opción incluida puede ser una opción individual o un grupo de opciones combinadas con OR.
excludedOptionIds[]

string (int64 format)

Las opciones excluidas se unen con OR.

OrGroup

Es un grupo de opciones seleccionadas unidas por OR.

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

string (int64 format)

Son los IDs de las opciones seleccionadas.

TargetingSelection

Es un conjunto de uno o más IDs de opciones seleccionadas, aplicable a la mayoría de los tipos de segmentación.

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

string (int64 format)

Son los IDs de las opciones seleccionadas.

ForecastResult

Se especificó el resultado de la previsión.

Representación JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Campos
forecasts[]

object (Forecast)

Es la previsión. El atributo "forecastCategory" debe ser único para cada elemento especificado.

Previsión

Es la previsión de la categoría de previsión especificada.

Representación 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.
}
Campos
forecastCategory

enum (ForecastCategory)

Es la categoría de previsión especificada que representa la estadística de previsión.
Campo de unión forecast_data. Solo se puede incluir un tipo de datos de estadísticas. Los datos completados deben corresponder al campo "forecastCategory". Las direcciones (forecast_data) solo pueden ser una de las siguientes opciones:
number

string (int64 format)

Son datos numéricos.
percentage

integer

Son datos de porcentaje.
cpmPrice

object (Money)

Son los datos de precios del CPM.
cpmRange

object (CpmRange)

Son los datos del rango de precios del CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Son los datos del desglose de la previsión.

ForecastCategory

Es la categoría de previsión.

Enumeraciones
FORECAST_CATEGORY_UNSPECIFIED Categoría no especificada. No es válido como entrada.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Total de oportunidades Son datos numéricos.
FORECAST_CATEGORY_TOTAL_AUDIENCE Público total Son datos numéricos.
FORECAST_CATEGORY_DIGITAL_TRP Son los puntos porcentuales de audiencia en público objetivo digitales. Son datos de porcentaje.
FORECAST_CATEGORY_SUGGESTED_CPM Es el precio de CPM sugerido. Es el rango de CPM o los datos de precios de CPM.
FORECAST_CATEGORY_UNIQUE_REACH Prever el alcance único Son datos numéricos.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Es el desglose de la previsión. Son los datos del desglose de la previsión.

CpmRange

El rango de CPM contiene el valor mínimo y máximo del CPM.

Representación JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Campos
minCpm

object (Money)

Es el límite inferior del rango de CPM.
maxCpm

object (Money)

Límite superior del rango de CPM.

ForecastBreakdownData

Los datos de desglose de la previsión contienen una lista de desgloses de la previsión.

Representación JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Campos
forecastBreakdowns[]

object (ForecastBreakdown)

Es una lista de desgloses de previsiones.

ForecastBreakdown

Es el desglose de la previsión de la opción de segmentación seleccionada.

Representación 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.
}
Campos
selectedTargetingOption

object (SelectedTargetingOption)

Es la opción o las opciones de segmentación seleccionadas para un solo tipo de segmentación.
Campo de unión breakdown_data. Solo se puede incluir un tipo de datos de desglose. Las direcciones (breakdown_data) solo pueden ser una de las siguientes opciones:
impressions

string (int64 format)

Impresiones previstas

ErrorDetails

Son los detalles del error que se especifican cuando la actualización tiene errores.

Representación JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Campos
message

string

Es el mensaje que se especifica cuando la actualización tiene errores.
instantDealErrorStatus

enum (InstantDealErrorStatus)

Es el estado de error que se especifica cuando la actualización tiene errores para las ofertas instantáneas.

InstantDealErrorStatus

Es el estado de error que se especifica cuando la actualización instantánea del acuerdo tiene errores.

Enumeraciones
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Es el estado de error no especificado.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE El estado de error indica que el inventario no está disponible.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE El estado de error indica que la previsión no está disponible.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT El estado de error indica que hay campos de entrada no válidos.

FrequencyCap

Es la cantidad de veces que se le puede mostrar el mismo anuncio a un usuario durante un período determinado.

Representación JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Campos
timeUnit

enum (TimeUnit)

Es la unidad de tiempo en la que se aplicará la limitación de frecuencia.
maxImpressions

string (int64 format)

Es la cantidad máxima de veces que se le puede mostrar el mismo anuncio a un usuario durante este período.

TimeUnit

Es la unidad de tiempo en la que se aplicará la limitación de frecuencia.

Enumeraciones
TIME_UNIT_UNSPECIFIED Unidad de tiempo no especificada.
TIME_UNIT_LIFETIME La limitación de frecuencia se aplicará durante todo el período.
TIME_UNIT_MONTHS La limitación de frecuencia se aplicará durante varios meses.
TIME_UNIT_WEEKS La limitación de frecuencia se aplicará durante varias semanas.
TIME_UNIT_DAYS La limitación de frecuencia se aplicará durante una cantidad de días.

Métodos

create

 Crea un producto.

get

 Obtiene el producto.

list

 Enumera el producto.

patch

 Actualiza un producto.