Method: customBiddingAlgorithms.list

Lista algoritmos de lances personalizados acessíveis ao usuário atual e que podem ser usados em estratégias de lances.

A ordem é definida pelo parâmetro orderBy.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v1/customBiddingAlgorithms

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

Parâmetros de consulta

Parâmetros
pageSize

integer

Tamanho da página solicitada. O valor precisa estar entre 1 e 200. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado pela chamada anterior para o método customBiddingAlgorithms.list. Se não for especificado, a primeira página de resultados será retornada.
orderBy

string

Campo que classificará a lista. Os valores aceitos são:

  • displayName (padrão)

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, adicione um sufixo "desc" ao nome dele. Exemplo: displayName desc.
filter

string

Permite filtrar por campos de algoritmo de lances personalizados.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas por AND. Uma sequência de restrições usa AND implicitamente.
  • Uma restrição tem o formato {field} {operator} {value}.
  • O campo customBiddingAlgorithmType precisa usar o operador EQUALS (=).
  • O campo displayName precisa usar o operador HAS (:).

Campos compatíveis:

  • customBiddingAlgorithmType
  • displayName

Exemplos:

  • Todos os algoritmos de lances personalizados em que o nome de exibição contém "política": displayName:"politics".
  • Todos os algoritmos de lances personalizados em que o tipo é "Script_BASED": customBiddingAlgorithmType=SCRIPT_BASED

Esse campo não pode ter mais de 500 caracteres.

Consulte nosso guia de filtragem de solicitações LIST para mais informações.
Parâmetro de união accessor. Obrigatório. Identifica em qual entidade do DV360 a solicitação está sendo feita. A solicitação LIST só retornará entidades de algoritmo de lances personalizados que são acessíveis para a entidade do DV360 identificada em accessor. Para executar a solicitação LIST, o usuário precisa ter permissão para a entidade accessor. accessor só pode ser de um dos seguintes tipos:
partnerId

string (int64 format)

O ID do parceiro do DV360 que tem acesso ao algoritmo de lances personalizados.
advertiserId

string (int64 format)

O ID do anunciante do DV360 que tem acesso ao algoritmo de lances personalizados.

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 
{
  "customBiddingAlgorithms": [
    {
      object (CustomBiddingAlgorithm)
    }
  ],
  "nextPageToken": string
}
Campos
customBiddingAlgorithms[]

object (CustomBiddingAlgorithm)

A lista de algoritmos de lances personalizados.

Esta lista estará ausente se estiver vazia.
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 ListCustomBiddingAlgorithmsRequest para recuperar a próxima página de resultados. Se o campo for nulo, isso significa que essa é a última página.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

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