Method: exchanges.orders.list

Lista os pedidos.

Solicitação HTTP

GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*}/orders

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Nome do recurso pai. Exemplo: exchanges/123. Obrigatório.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de itens para retornar. O padrão é 50. O valor máximo permitido é 200. Se não for especificado, o tamanho de página padrão será 50. Se pageSize for maior que 200, usaremos 200 como tamanho de página.

pageToken

string

O valor nextPageToken retornado de uma solicitação de lista anterior, se houver.

filter

string

Permite filtrar por propriedades do pedido.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas por operadores lógicos AND ou OR. Uma sequência de restrições usa AND implicitamente.
  • Uma restrição tem o formato <field> <operator> <value>.
  • O operador de status e displayName precisa ser EQUALS (=).
  • Campos compatíveis:
    • OrderStatus
    • DisplayName
    • UpdateTime

Exemplos:

  • Receber pedidos com status definido como ACCEPTED status=ACCEPTED

  • Receber pedidos com o nome de exibição display name displayName="display name"

  • Receber pedidos com tempo de atualização maior que 2024-02-12T18:47:29.784Z updateTime>"2024-02-12T18:47:29.784Z"

O comprimento desse campo não pode ser maior que 500 caracteres.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para listar pedidos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "order": [
    {
      object (Order)
    }
  ],
  "nextPageToken": string
}
Campos
order[]

object (Order)

Pedidos listados. Haverá um número máximo de itens retornados com base no campo pageSize na solicitação.

nextPageToken

string

Token para recuperar a próxima página de resultados ou um valor vazio se não houver mais resultados na lista.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/doubleclickbidmanager

Para mais informações, consulte OAuth 2.0 Overview.