REST Resource: advertisers.lineItems

Recurso: LineItem

Es 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. Indica 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. Lo asigna 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 ofertar 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 la creación.
  • No se puede volver a cambiar una línea de pedido al estado ENTITY_STATUS_DRAFT desde ningún otro estado.
  • Si el pedido de inserción superior de la línea de pedido no está activo, no podrá 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. Lo asigna el sistema.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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)

Es el costo del socio asociado a la línea de pedido.

Si está ausente o vacío en el método lineItems.create, la línea de pedido recién creada heredará los costos de socios de su pedido de inserción superior.

flight

object (LineItemFlight)

Obligatorio. Hora de inicio y finalización del período de publicación de la línea de pedido.

budget

object (LineItemBudget)

Obligatorio. La configuración de asignación de presupuesto de la línea de pedido.

pacing

object (Pacing)

Obligatorio. Es la configuración de 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.

Si se asigna un límite limitado, se debe usar el campo maxImpressions en este objeto de configuración.

partnerRevenueModel

object (PartnerRevenueModel)

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

conversionCounting

object (ConversionCountingConfig)

Es la configuración del seguimiento de conversiones de la línea de pedido.

creativeIds[]

string (int64 format)

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

bidStrategy

object (BiddingStrategy)

Obligatorio. Es 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 privado asignadas a la línea de pedido.

targetingExpansion

object (TargetingExpansionConfig)

La configuración de 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 usan ofertas automáticas y se segmentan de forma positiva para listas de público aptas.

warningMessages[]

enum (LineItemWarningMessage)

Solo salida. Los mensajes de advertencia que genera la línea de pedido. Estas advertencias no impiden que se guarde la línea de pedido, pero es posible que algunas impidan su publicación.

mobileApp

object (MobileApp)

Es la aplicación para dispositivos móviles que promociona 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

Indica si se deben excluir nuevos intercambios para que la línea de pedido no se oriente automáticamente. Este campo se establece como 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 son aplicables, como el formato de los anuncios o las opciones de segmentación.

Enumeradores
LINE_ITEM_TYPE_UNSPECIFIED

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

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 Son anuncios HTML5, nativos, con imágenes 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 Anuncios de video que se venden según el 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 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_AUDIO_DEFAULT Anuncios de audio de RTB que se venden para una variedad de 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

Es la configuración que controla 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 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. Salida solo de lo contrario.
  • Cuando crees un vuelo nuevo, los valores de startDate y endDate deben estar en el futuro.
  • Un vuelo existente con un startDate en el pasado tiene un endDate mutable, pero un startDate inmutable.
  • endDate debe ser la startDate o una posterior, ambos antes del año 2037.
triggerId

string (int64 format)

El ID del activador manual asociado con la línea de pedido.

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

Advertencia: Las líneas de pedido que usan activadores manuales ya no se publican en Display & Video 360. Este campo dejará de estar disponible el 1 de agosto de 2023. Lee nuestro anuncio de baja de funciones para obtener más información.

LineItemFlightDateType

Son los posibles tipos de fechas de publicación de una línea de pedido.

Enumeradores
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED No se especificó el valor del tipo o se desconoce en esta versión.
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED Las fechas de publicación de la línea de pedido se heredan de su pedido de inserción superior.
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 usan activadores manuales ya no se publican en Display & Video 360. Este valor dejará de estar disponible el 1 de agosto de 2023. Lee nuestro anuncio de baja de funciones para obtener más información.

LineItemBudget

Configuración que controla 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 de 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 una moneda o en impresiones. Este valor se hereda del pedido de inserción superior.

maxAmount

string (int64 format)

El importe de presupuesto máximo 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 de presupuesto.

Enumeradores
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED No se especificó el valor del tipo o se desconoce en esta versión.
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 un límite de presupuesto a la línea de pedido.

PartnerRevenueModel

Es la configuración que controla cómo se calculan los ingresos del socio.

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

enum (PartnerRevenueModelMarkupType)

Obligatorio. Es el tipo de lenguaje de marcado del modelo de ingresos de socios.

markupAmount

string (int64 format)

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

  • Cuando markupType se establece en PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM, este campo representa el margen de beneficio del CPM en micros de la moneda del anunciante. Por ejemplo, 1500000 representa 1.5 unidades estándar de la moneda.
  • Cuando markupType se configura como PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP, este campo representa el margen de beneficio porcentual del costo de medios en milisegundos. Por ejemplo, 100 representa 0.1% (0.001 decimal).
  • Cuando markupType se configura como PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP, este campo representa el margen de beneficio porcentual del costo total de medios en milisegundos. Por ejemplo, 100 representa 0.1% (0.001 decimal).

PartnerRevenueModelMarkupType

Posibles tipos de lenguaje de marcado del modelo de ingresos de socios.

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

Calcula los ingresos del socio según un porcentaje de recargo de su costo de medios.

PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP Calcula los ingresos del socio según un porcentaje de recargo del costo de medios total, que incluye todos los costos del socio y los costos de datos.

ConversionCountingConfig

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 vista.

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

string (int64 format)

Es el porcentaje de conversiones posteriores a la vista que se cuentan, en milisegundos (1/1,000 de un porcentaje). Debe estar comprendido entre 0 y 100,000 inclusive.

Por ejemplo, para realizar un seguimiento del 50% de las conversiones posteriores al clic, establezca un valor en 50,000.

floodlightActivityConfigs[]

object (TrackingFloodlightActivityConfig)

Los parámetros de configuración de la actividad de Floodlight que se utilizan para hacer un seguimiento de las conversiones.

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

TrackingFloodlightActivityConfig

Son parámetros que controlan 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 después de que se hace clic en un anuncio durante los cuales se puede registrar una conversión. Debe estar comprendido entre 0 y 90 inclusive.

postViewLookbackWindowDays

integer

Obligatorio. Indica 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

Son los parámetros de configuración que controlan la configuración de la segmentación optimizada de la línea de pedido.

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

enum (TargetingExpansionLevel)

Obligatorio. Indica si se activó la segmentación optimizada.

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 establece en cualquier otro valor, se establecerá automáticamente en LEAST_EXPANSION.

NO_EXPANSION será el valor predeterminado para el campo y se asignará automáticamente si no lo configuras.

excludeFirstPartyAudience
(deprecated)

boolean

Indica si se deben excluir los públicos propios para que no se usen 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á como false. Si este campo se configura como true cuando deje de estar disponible, toda la segmentación positiva por público propio asignada a esta línea de pedido se reemplazará por la segmentación negativa de los mismos públicos propios para garantizar la exclusión continua de esos públicos.

TargetingExpansionLevel

La configuración de la segmentación optimizada

Enumeradores
TARGETING_EXPANSION_LEVEL_UNSPECIFIED No se especificó el parámetro de configuración de la segmentación optimizada o se desconoce en esta versión.
NO_EXPANSION La segmentación optimizada está desactivada.
LEAST_EXPANSION La segmentación optimizada está activada.
SOME_EXPANSION

Si se usa, se establecerá automáticamente en LEAST_EXPANSION.

BALANCED_EXPANSION

Si se usa, se establecerá automáticamente en LEAST_EXPANSION.

MORE_EXPANSION

Si se usa, se establecerá automáticamente en LEAST_EXPANSION.

MOST_EXPANSION

Si se usa, se establecerá automáticamente en LEAST_EXPANSION.

LineItemWarningMessage

Son los mensajes de advertencia que genera una línea de pedido. Estos tipos de advertencias no impiden que se guarde una línea de pedido, pero sí pueden bloquearla para que no se ejecute.

Enumeradores
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED No se especificó o es desconocido.
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 ya pasó.
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 la segmentación de su 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 esta línea de pedido requiere que segmentes tus anuncios para una lista de 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 impedirá que la línea de pedido se publique, por lo que debes considerar quitar estas listas de tu 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 ya no está 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 desactivarse después del 25 de marzo de 2023.

Actualiza la integración de tu 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 que el campo excludeFirstPartyAudience dejará de estar disponible.

MobileApp

Una app para dispositivos móviles promocionada mediante una línea de pedido de instalación de app 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 con el ID de paquete que usa Play Store de Android, como com.google.android.gm.

Las aplicaciones para iOS se identifican con un ID de la aplicación de nueve dígitos que utiliza la App Store 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. Es el publicador de la app.

Plataforma

Posibles plataformas de aplicaciones para dispositivos móviles

Enumeradores
PLATFORM_UNSPECIFIED No se especificó la plataforma.
IOS plataforma de 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 para 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 una configuración (incluida la segmentación) heredada del pedido de inserción y una entity_status con ENTITY_STATUS_DRAFT.

get

Obtiene una línea de pedido.

list

Muestra una lista de las líneas de pedido de un anunciante.

patch

Actualiza una línea de pedido existente.