REST Resource: advertisers.lineItems

Recurso: LineItem

Una sola línea de pedido.

Representación JSON 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "lineItemId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "flight": {
    object (LineItemFlight)
  },
  "budget": {
    object (LineItemBudget)
  },
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "partnerRevenueModel": {
    object (PartnerRevenueModel)
  },
  "conversionCounting": {
    object (ConversionCountingConfig)
  },
  "creativeIds": [
    string
  ],
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "inventorySourceIds": [
    string
  ],
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "warningMessages": [
    enum (LineItemWarningMessage)
  ],
  "mobileApp": {
    object (MobileApp)
  },
  "reservationType": enum (ReservationType),
  "excludeNewExchanges": boolean
}
Campos
name

string

Solo salida. El nombre del recurso de la línea de pedido.
advertiserId

string (int64 format)

Solo salida. Es el ID único del anunciante al que pertenece la línea de pedido.
campaignId

string (int64 format)

Solo salida. El ID único de la campaña a la que pertenece la línea de pedido.
insertionOrderId

string (int64 format)

Obligatorio. Inmutable. Es el ID único del pedido de inserción al que pertenece la línea de pedido.
lineItemId

string (int64 format)

Solo salida. El ID único de la línea de pedido. Asignada por el sistema.
displayName

string

Obligatorio. El nombre visible de la línea de pedido.

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

enum (LineItemType)

Obligatorio. Inmutable. El tipo de línea de pedido.
entityStatus

enum (EntityStatus)

Obligatorio. Controla si la línea de pedido puede invertir su presupuesto y oferta en el inventario.

  • Para el método lineItems.create, solo se permite ENTITY_STATUS_DRAFT. Para activar una línea de pedido, usa el método lineItems.patch y actualiza el estado a ENTITY_STATUS_ACTIVE después de su creación.
  • Una línea de pedido no se puede volver al estado ENTITY_STATUS_DRAFT desde ningún otro estado.
  • Si el pedido de inserción principal de la línea de pedido no está activo, esta no puede invertir su presupuesto incluso si su propio estado es ENTITY_STATUS_ACTIVE.
updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de la línea de pedido. Asignada por el sistema.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
partnerCosts[]

object (PartnerCost)

Los costos del socio asociados con la línea de pedido.

Si el método lineItems.create no está presente o está vacío, la línea de pedido recién creada heredará los costos del socio de su pedido de inserción superior.
flight

object (LineItemFlight)

Obligatorio. Son las horas de inicio y finalización del período de publicación de la línea de pedido.
budget

object (LineItemBudget)

Obligatorio. Es la configuración de asignación del presupuesto de la línea de pedido.
pacing

object (Pacing)

Obligatorio. La configuración de la velocidad de inversión del presupuesto de la línea de pedido.
frequencyCap

object (FrequencyCap)

Obligatorio. La configuración de limitación de frecuencia de impresiones de la línea de pedido.

El campo maxImpressions de este objeto de configuración se debe usar si se asigna un límite limitado.
partnerRevenueModel

object (PartnerRevenueModel)

Obligatorio. La configuración del modelo de ingresos del socio de la línea de pedido.
conversionCounting

object (ConversionCountingConfig)

La configuración del seguimiento de conversiones de la línea de pedido.
creativeIds[]

string (int64 format)

Son los IDs de las creatividades asociadas con la línea de pedido.
bidStrategy

object (BiddingStrategy)

Obligatorio. La estrategia de ofertas de la línea de pedido.
integrationDetails

object (IntegrationDetails)

Son los detalles de integración de la línea de pedido.
inventorySourceIds[]

string (int64 format)

Son los IDs de las fuentes de inventario privadas asignadas a la línea de pedido.
targetingExpansion

object (TargetingExpansionConfig)

Es la configuración de la segmentación optimizada de la línea de pedido.

Esta configuración solo se aplica a las líneas de pedido de anuncios gráficos, de video o de audio que utilizan ofertas automáticas y se orientan de forma positiva a listas de público aptas.
warningMessages[]

enum (LineItemWarningMessage)

Solo salida. Son los mensajes de advertencia que genera la línea de pedido. Estas advertencias no bloquean el guardado de la línea de pedido, pero algunas pueden impedir su publicación.
mobileApp

object (MobileApp)

La aplicación para dispositivos móviles promocionada por la línea de pedido.

Esto es aplicable solo cuando lineItemType es LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL o LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.
reservationType

enum (ReservationType)

Solo salida. El tipo de reserva de la línea de pedido.
excludeNewExchanges

boolean

Establece si se deben excluir nuevos intercambios para que no se orienten automáticamente a la línea de pedido. Este campo es falso de forma predeterminada.

LineItemType

Tipos posibles de una línea de pedido.

El tipo de línea de pedido determina qué configuración y opciones se aplican, como el formato de los anuncios o las opciones de segmentación.

Enumeraciones
LINE_ITEM_TYPE_UNSPECIFIED

No se especificó el valor del tipo en esta versión o se desconoce.

Las líneas de pedido de este tipo y su segmentación no se pueden crear ni actualizar con la API.
LINE_ITEM_TYPE_DISPLAY_DEFAULT Anuncios HTML5, nativos, de imagen o rich media
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL Anuncios gráficos que generan instalaciones de una aplicación
LINE_ITEM_TYPE_VIDEO_DEFAULT Los anuncios de video se venden sobre una base CPM para diversos entornos.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL Anuncios de video que generan instalaciones de una aplicación
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY

Anuncios gráficos que se publican en el inventario de la aplicación para dispositivos móviles

Las líneas de pedido de este tipo y su segmentación no se pueden crear ni actualizar con la API.
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY

Anuncios de video que se publican en el inventario de aplicaciones para dispositivos móviles

Las líneas de pedido de este tipo y su segmentación no se pueden crear ni actualizar con la API.
LINE_ITEM_TYPE_AUDIO_DEFAULT Anuncios de audio de RTB que se venden en diversos entornos.
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP Los anuncios de transmisión libre están presentes en los pedidos de inserción de OTT. Este tipo solo se aplica a líneas de pedido con un pedido de inserción de insertionOrderType OVER_THE_TOP.

LineItemFlight

Son parámetros de configuración que controlan la duración activa de una línea de pedido.

Representación JSON 
{
  "flightDateType": enum (LineItemFlightDateType),
  "dateRange": {
    object (DateRange)
  },
  "triggerId": string
}
Campos
flightDateType

enum (LineItemFlightDateType)

Obligatorio. El tipo de las fechas de publicación de la línea de pedido.
dateRange

object (DateRange)

Son las fechas de inicio y finalización del período de publicación de la línea de pedido. Se resuelven según la zona horaria del anunciante principal.

  • Obligatorio cuando flightDateType es LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM. Resultado solo de lo contrario.
  • Cuando creas un nuevo vuelo, tanto startDate como endDate deben ser en el futuro.
  • Un vuelo existente con un startDate del pasado tiene un endDate mutable, pero un startDate inmutable.
  • endDate debe ser startDate o posterior, ambos antes del año 2037.
triggerId

string (int64 format)

Es el ID del activador manual asociado a la línea de pedido.

  • Obligatorio cuando flightDateType es LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER. No se debe configurar de otra manera.
  • Cuando se establece, las fechas de publicación de la línea de pedido se heredan del pedido de inserción principal.
  • Las líneas de pedido activas se invertirán cuando el activador seleccionado se active dentro de las fechas de publicación del pedido de inserción principal.

Advertencia: Las líneas de pedido que utilizan activadores manuales ya no se publican en Display ni Video en 360° Este campo se desactivará el 1 de agosto de 2023. Lee el anuncio de la baja de la función para obtener más información.

LineItemFlightDateType

Tipos posibles de fechas de publicación de una línea de pedido.

Enumeraciones
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED No se especificó el valor del tipo en esta versión o se desconoce.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED Las fechas de publicación de la línea de pedido se heredan del pedido de inserción principal.
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM La línea de pedido usa sus propias fechas de publicación personalizadas.
LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER

La línea de pedido usa un activador.

Advertencia: Las líneas de pedido que utilizan activadores manuales ya no se publican en Display ni Video en 360° Este valor dejará de estar disponible el 1 de agosto de 2023. Lee el anuncio de la baja de la función para obtener más información.

LineItemBudget

Son parámetros de configuración que controlan cómo se asigna el presupuesto.

Representación JSON 
{
  "budgetAllocationType": enum (LineItemBudgetAllocationType),
  "budgetUnit": enum (BudgetUnit),
  "maxAmount": string
}
Campos
budgetAllocationType

enum (LineItemBudgetAllocationType)

Obligatorio. El tipo de asignación del presupuesto.

LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC solo es aplicable cuando está habilitada la asignación automática de presupuesto para el pedido de inserción superior.
budgetUnit

enum (BudgetUnit)

Solo salida. La unidad de presupuesto especifica si el presupuesto se basa en la moneda o en las impresiones. Este valor se hereda del pedido de inserción superior.
maxAmount

string (int64 format)

El importe máximo del presupuesto que invertirá la línea de pedido. Debe ser mayor que 0.

Cuando budgetAllocationType sea:

  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC, este campo es inmutable y lo establece el sistema.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED, si budgetUnit es:
    • BUDGET_UNIT_CURRENCY, este campo representa el importe máximo del presupuesto que se invertirá, en micros de la moneda del anunciante. Por ejemplo, 1500000 representa 1.5 unidades estándar de la moneda.
    • BUDGET_UNIT_IMPRESSIONS, este campo representa la cantidad máxima de impresiones que se publicarán.
  • LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED, este campo no es aplicable y el sistema lo ignorará.

LineItemBudgetAllocationType

Tipos posibles de asignación del presupuesto.

Enumeraciones
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED No se especificó el valor del tipo en esta versión o se desconoce.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC La asignación automática de presupuesto está habilitada para la línea de pedido.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED Se asigna un importe de presupuesto máximo fijo a la línea de pedido.
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED No se aplica ningún límite de presupuesto a la línea de pedido.

PartnerRevenueModel

Configuración que controla cómo se calculan los ingresos de los socios.

Representación JSON 
{
  "markupType": enum (PartnerRevenueModelMarkupType),
  "markupAmount": string
}
Campos
markupType

enum (PartnerRevenueModelMarkupType)

Obligatorio. El tipo de margen de beneficios del modelo de ingresos de socios.
markupAmount

string (int64 format)

Obligatorio. El importe del margen de beneficio del modelo de ingresos de socios. Debe ser mayor o igual que 0.

  • Cuando el valor de markupType es PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, este campo representa el lenguaje de marcado de CPM en micros de la moneda del anunciante. Por ejemplo, 1500000 representa 1.5 unidades estándar de la moneda.
  • Cuando se establece markupType en PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, este campo representa el margen de beneficios del costo de medios en milésimas de segundo. Por ejemplo, 100 representa 0.1% (0.001 decimal).
  • Cuando se establece markupType en PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, este campo representa el margen de beneficios del costo total de medios en milésimas de segundo. Por ejemplo, 100 representa 0.1% (0.001 decimal).

PartnerRevenueModelMarkupType

Tipos de margen de beneficios posibles del modelo de ingresos de socios.

Enumeraciones
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED No se especificó el valor del tipo en esta versión o se desconoce.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM Calcula los ingresos del socio en función de un CPM fijo.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP

Calcula los ingresos del socio según un porcentaje de cargo adicional de su costo de medios.
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Calcula los ingresos del socio en función de un cargo adicional del costo total de medios, que incluye todos los costos del socio y de datos.

ConversionCountingConfig

Es la configuración que controla cómo se registran las conversiones.

Se registrarán todas las conversiones posteriores al clic. Se puede establecer un valor porcentual para el recuento de conversiones posteriores a la reproducción.

Representación JSON 
{
  "postViewCountPercentageMillis": string,
  "floodlightActivityConfigs": [
    {
      object (TrackingFloodlightActivityConfig)
    }
  ]
}
Campos
postViewCountPercentageMillis

string (int64 format)

Es el porcentaje de conversiones posteriores a la reproducción que se deben registrar, en milisegundos (1/1,000 de un porcentaje). El valor debe estar comprendido entre 0 y 100,000, inclusive.

Por ejemplo, para realizar un seguimiento del 50% de las conversiones posteriores al clic, establece un valor de 50,000.
floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

La configuración de la actividad de Floodlight que se utiliza para hacer un seguimiento de las conversiones

La cantidad de conversiones registradas es la suma de todas las conversiones registradas por todos los IDs de actividad de Floodlight especificados en este campo.

TrackingFloodlightActivityConfig

Es la configuración que controla el comportamiento de una sola configuración de actividad de Floodlight.

Representación JSON 
{
  "floodlightActivityId": string,
  "postClickLookbackWindowDays": integer,
  "postViewLookbackWindowDays": integer
}
Campos
floodlightActivityId

string (int64 format)

Obligatorio. El ID de la actividad de Floodlight.
postClickLookbackWindowDays

integer

Obligatorio. Es la cantidad de días posteriores a un clic en un anuncio en los que se puede registrar una conversión. Debe estar comprendido entre 0 y 90 inclusive.
postViewLookbackWindowDays

integer

Obligatorio. Es la cantidad de días posteriores a la visualización de un anuncio en los que se puede registrar una conversión. Debe estar comprendido entre 0 y 90 inclusive.

TargetingExpansionConfig

Es la configuración que controla la configuración de segmentación optimizada de la línea de pedido.

Representación JSON 
{
  "targetingExpansionLevel": enum (TargetingExpansionLevel),
  "excludeFirstPartyAudience": boolean
}
Campos
targetingExpansionLevel

enum (TargetingExpansionLevel)

Obligatorio. Si la segmentación optimizada está activada

Este campo admite los siguientes valores:

  • NO_EXPANSION: La segmentación optimizada está desactivada
  • LEAST_EXPANSION: La segmentación optimizada está activada

Si este campo se configura con cualquier otro valor, se establecerá automáticamente en LEAST_EXPANSION.

NO_EXPANSION será el valor predeterminado del campo y se asignará automáticamente si no lo configuras.
excludeFirstPartyAudience
(deprecated)

boolean

Indica si se deben excluir públicos propios para evitar su uso en la expansión de la segmentación.

Este campo dejó de estar disponible con el lanzamiento de la segmentación optimizada.

Este campo se establecerá en false. Si estableces este campo como true cuando deje de estar disponible, toda la segmentación por público propia que se haya asignado a esta línea de pedido se reemplazará por una segmentación negativa de los mismos públicos propios para garantizar la exclusión continua de esos públicos.

TargetingExpansionLevel

La configuración de segmentación optimizada

Enumeraciones
TARGETING_EXPANSION_LEVEL_UNSPECIFIED La configuración de la segmentación optimizada no se especifica en esta versión o se desconoce.
NO_EXPANSION La segmentación optimizada está desactivada.
LEAST_EXPANSION La segmentación optimizada está activada.
SOME_EXPANSION

Si se usa, se configurará automáticamente como LEAST_EXPANSION.
BALANCED_EXPANSION

Si se usa, se configurará automáticamente como LEAST_EXPANSION.
MORE_EXPANSION

Si se usa, se configurará automáticamente como LEAST_EXPANSION.
MOST_EXPANSION

Si se usa, se configurará automáticamente como LEAST_EXPANSION.

LineItemWarningMessage

Son los mensajes de advertencia generados por una línea de pedido. Estos tipos de advertencias no bloquean el guardado de una línea de pedido, pero pueden bloquear su publicación.

Enumeraciones
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED No se especifica o es desconocida.
INVALID_FLIGHT_DATES Esta línea de pedido tiene fechas de período de publicación no válidas. No se publicará la línea de pedido.
EXPIRED La fecha de finalización de esta línea de pedido es en el pasado.
PENDING_FLIGHT Esta línea de pedido comenzará a ejecutarse en el futuro.
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED Todos los intercambios habilitados por los socios tienen una segmentación negativa. No se publicará la línea de pedido.
INVALID_INVENTORY_SOURCE No se orientan fuentes de inventario activas. No se publicará la línea de pedido.
APP_INVENTORY_INVALID_SITE_TARGETING La orientación por aplicaciones y URL de esta línea de pedido no incluye ninguna aplicación para dispositivo móvil. Este tipo de línea de pedido requiere que incluya aplicaciones para dispositivos móviles en su segmentación por canal, lista de sitios o aplicaciones. No se publicará la línea de pedido.
APP_INVENTORY_INVALID_AUDIENCE_LISTS Esta línea de pedido no se orienta a ningún usuario de dispositivos móviles. El tipo de línea de pedido requiere que orientes una lista de usuarios con usuarios de dispositivos móviles. No se publicará la línea de pedido.
NO_VALID_CREATIVE Esta línea de pedido no contiene ninguna creatividad válida. No se publicará la línea de pedido.
PARENT_INSERTION_ORDER_PAUSED El pedido de inserción de esta línea de pedido está detenido. No se publicará la línea de pedido.
PARENT_INSERTION_ORDER_EXPIRED El pedido de inserción de esta línea de pedido tiene su fecha de finalización establecida en el pasado. No se publicará la línea de pedido.
NO_POSITIVE_AUDIENCE_LIST_TARGETED Esta línea de pedido no se orienta a ninguna lista de público. Eso puede hacer que su presupuesto se invierta demasiado rápido.
APP_INSTALL_NO_CONVERSION_PIXEL Esta línea de pedido de instalación de aplicación no tiene configurado ningún píxel de conversión.
TARGETING_REVOKED_OR_CLOSED_USER_LIST Esta línea de pedido se orienta a una o más listas de usuarios que ya no están disponibles. En el futuro, esto evitará que la línea de pedido se publique. Por lo tanto, considere quitar estas listas de su segmentación.
APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY Esta línea de pedido de instalación de aplicaciones no tiene una estrategia de oferta óptima.
CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS Los acuerdos a los que se orienta esta línea de pedido aceptan tamaños de creatividad que no están en uso. Esto puede limitar su publicación o rendimiento.
NO_CREATIVE_FOR_TARGETED_DEALS Esta línea de pedido no contiene ninguna creatividad para los acuerdos segmentados.
TARGETING_DEPRECATED_GEO_TARGET Esta línea de pedido se orienta a una segmentación geográfica que dejó de estar disponible.
DEPRECATED_FIRST_PARTY_AUDIENCE_EXCLUSION

Esta línea de pedido usa el parámetro de configuración excludeFirstPartyAudience, que dejó de estar disponible y se programó para dar de baja después del 25 de marzo de 2023.

Actualiza tu integración de API para excluir directamente cualquier público propio mediante la segmentación por público antes del 25 de marzo de 2023 para tener en cuenta la desactivación del campo excludeFirstPartyAudience.

Aplicación para dispositivos móviles

Una aplicación para dispositivos móviles promocionada por una línea de pedido de instalación de aplicación para dispositivos móviles.

Representación JSON 
{
  "appId": string,
  "platform": enum (Platform),
  "displayName": string,
  "publisher": string
}
Campos
appId

string

Obligatorio. Es el ID de la app que proporciona la tienda de la plataforma.

Las apps para Android se identifican por el ID del paquete que usa Play Store de Android, como com.google.android.gm.

Las aplicaciones para iOS se identifican con un ID de aplicación de nueve dígitos que utiliza la tienda de aplicaciones de Apple, como 422689480.
platform

enum (Platform)

Solo salida. La plataforma de la app
displayName

string

Solo salida. Es el nombre de la app.
publisher

string

Solo salida. El publicador de la app

Plataforma

Posibles plataformas de apps para dispositivos móviles

Enumeraciones
PLATFORM_UNSPECIFIED No se especificó la plataforma.
IOS plataforma iOS.
ANDROID plataforma de Android.

Métodos

bulkEditLineItemAssignedTargetingOptions

 Edita de forma masiva las opciones de segmentación en una sola línea de pedido.

bulkListLineItemAssignedTargetingOptions

 Se muestran las opciones de segmentación asignadas de una línea de pedido en todos los tipos de segmentación.

create

 Crea una línea de pedido nueva.

delete

 Borra una línea de pedido.

generateDefault

 Crea una nueva línea de pedido con la configuración (incluida la segmentación) heredada del pedido de inserción y una ENTITY_STATUS_DRAFT entity_status.

get

 Obtiene una línea de pedido.

list

 Muestra las líneas de pedido de un anunciante.

patch

 Actualiza una línea de pedido existente.