Method: customBiddingAlgorithms.list

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

A ordem é definida pelo parâmetro orderBy.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/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, 100 será usado como padrão. Retorna o código de erro INVALID_ARGUMENT se um valor inválido for especificado.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado da 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 classifica a lista. Os valores aceitáveis 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 algoritmos 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 pela 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 cujo nome de exibição contém "políticas": displayName:"politics".
  • Todos os algoritmos de lance personalizado com 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 a entidade do DV360 em que a solicitação está sendo feita. A solicitação LIST só vai retornar entidades de algoritmo de lances personalizados que sejam acessíveis à entidade do DV360 identificada no accessor. Para realizar a solicitação LIST, o usuário precisa ter permissão para a entidade accessor. accessor pode ser apenas um dos seguintes:
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 subsequente para o método ListCustomBiddingAlgorithmsRequest para recuperar a próxima página de resultados. Se esse campo for nulo, significa que esta é 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.