Method: sellers.orders.list

Lista os pedidos.

  • Por exemplo, GET /v1/sellers/321/orders
  • Retorna uma lista de pedidos e um token para recuperar a próxima página em caso de êxito.
  • Retorna o código de erro PERMISSION_DENIED se o usuário não tiver acesso ao vendedor ou se o ID do vendedor não existir.
  • Retorna o código de erro INVALID_ARGUMENT se os vendedores fornecerem um tamanho de página ou token de página inválido.

Solicitação HTTP

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/orders

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai, que é proprietário desse conjunto de pedidos. Formato: sellers/{seller}

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de itens para retornar. O serviço pode retornar menos que esse valor. O número máximo permitido de pedidos é 1.000. Se não for especificado, serão retornados no máximo mil pedidos.
pageToken

string

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

string

O filtro da lista. Atualmente oferece suporte a ID externo e filtragem de estado, com a sintaxe: "externalId = [EXTERNAL_ID]" e "estado = [ESTADO]". Os operadores lógicos AND e OR podem ser usados para encadear filtros.
orderBy

string

A ordem por string usada para especificar a ordem de classificação dos resultados. Atualmente aceita a ordenação por updateTime, forneça "updateTime" para obter resultados classificados por updateTime em ordem crescente ou "updateTime desc" para ordem decrescente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

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

object (Order)

A lista de pedidos.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método orders.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.