Method: advertisers.lineItems.list

Muestra las líneas de pedido de un anunciante.

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

Solicitud HTTP

GET https://displayvideo.googleapis.com/v1/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 incluirán las líneas de pedido.

Parámetros de consulta

Parámetros
pageSize

integer

Indica el tamaño de la página solicitada. El valor debe estar comprendido entre 1 y 200. Si no se especifica, se usará el valor predeterminado 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, este 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

Es el campo que se usa para ordenar la lista. Los valores aceptables son:

  • displayName (predeterminada)
  • entityStatus
  • updateTime

El orden predeterminado es ascendente. Para especificar el orden descendente para un campo, agrega el sufijo “desc” al nombre del campo. Ejemplo: displayName desc.
filter

string

Permite filtrar por campos de líneas de pedido.

Sintaxis admitida:

  • Las expresiones de filtro constan 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 forma implícita.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El campo updateTime debe usar los operadores GREATER THAN OR EQUAL TO (>=) o LESS THAN OR EQUAL TO (<=).
  • Todos los demás campos deben usar el operador EQUALS (=).

Campos admitidos:

  • campaignId
  • displayName
  • entityStatus
  • insertionOrderId
  • lineItemId
  • lineItemType
  • updateTime (entrada en formato ISO 8601 o YYYY-MM-DDTHH:MM:SSZ)

Ejemplos:

  • Todas las líneas de pedido en un pedido de inserción: insertionOrderId="1234"
  • Todas las líneas de pedido ENTITY_STATUS_ACTIVE, 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 una hora de actualización inferior o igual a 2020-11-04T18:54:47Z (formato de 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 (formato de ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

Consulta nuestra guía sobre solicitudes de filtros LIST para obtener más información.

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 se mostrará 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 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.