Method: advertisers.lineItems.list

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

El parámetro orderBy define el orden. Si no se especifica un filter de entityStatus, las líneas de pedido con ENTITY_STATUS_ARCHIVED no se incluirán en los resultados.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/lineItems

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante para el que se enumeran las líneas de pedido.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. Debe ser un valor entre 1 y 100. Si no se especifica, el valor predeterminado será 100. Muestra el código de error INVALID_ARGUMENT si se especifica un valor no válido.
pageToken

string

Un token que identifica una página de resultados que el servidor debe mostrar. Por lo general, es el valor de nextPageToken que se muestra en la llamada anterior al método lineItems.list. Si no se especifica, se mostrará la primera página de resultados.
orderBy

string

Campo por el que se ordenará la lista. Los valores aceptables son:

  • displayName (predeterminada)
  • entityStatus
  • flight.dateRange.endDate
  • updateTime

El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente para un campo, se debe agregar el sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

Permite filtrar por propiedades de línea de pedido.

Sintaxis compatible:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con los operadores lógicos AND o OR. Una secuencia de restricciones usa AND de manera implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El operador que se usa en flight.dateRange.endDate debe ser LESS THAN (<).
  • El operador que se usa en updateTime debe ser GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • El operador que se usa en warningMessages debe ser HAS (:).
  • Los operadores que se usan en todos los demás campos deben ser EQUALS (=).
  • Propiedades compatibles:
    • campaignId
    • displayName
    • insertionOrderId
    • entityStatus
    • lineItemId
    • lineItemType
    • flight.dateRange.endDate (entrada con formato AAAA-MM-DD)
    • warningMessages
    • flight.triggerId
    • updateTime (entrada en formato ISO 8601 o AAAA-MM-DDTHH:MM:SSZ)
    • targetedChannelId
    • targetedNegativeKeywordListId

Ejemplos:

  • Todas las líneas de pedido incluidas en un pedido de inserción: insertionOrderId="1234"
  • Todas las líneas de pedido ENTITY_STATUS_ACTIVE o ENTITY_STATUS_PAUSED y LINE_ITEM_TYPE_DISPLAY_DEFAULT de un anunciante: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"
  • Todas las líneas de pedido con fechas de publicación que finalicen antes del 28 de marzo de 2019: flight.dateRange.endDate<"2019-03-28"
  • Todas las líneas de pedido que tienen NO_VALID_CREATIVE en warningMessages: warningMessages:"NO_VALID_CREATIVE"
  • Todas las líneas de pedido con una hora de actualización inferior o igual a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Todas las líneas de pedido con una fecha de actualización superior o igual a 2020-11-04T18:54:47Z (format of ISO 8601): updateTime>="2020-11-04T18:54:47Z"
  • Todas las líneas de pedido que usan el canal y la lista de palabras clave negativas especificadas en su segmentación: targetedNegativeKeywordListId=789 AND targetedChannelId=12345

La longitud de este campo no debe superar los 500 caracteres.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ],
  "nextPageToken": string
}
Campos
lineItems[]

object (LineItem)

Es la lista de líneas de pedido.

Esta lista no estará disponible si está vacía.
nextPageToken

string

Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método lineItems.list para recuperar la siguiente página de resultados.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/display-video

Para obtener más información, consulta la Descripción general de OAuth 2.0.