A partir de
8 de setembro de 2025, todos os novos itens de linha precisarão declarar se vão veicular anúncios políticos da União Europeia (UE). As APIs do Display & Video 360 e os uploads de SDF que não fornecem declarações vão falhar. Consulte nossa
página de suspensões de uso para mais detalhes sobre como atualizar sua integração e fazer essa declaração.
Method: customBiddingAlgorithms.scripts.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Lista os scripts de lances personalizados que pertencem ao algoritmo especificado.
A ordem é definida pelo parâmetro orderBy.
Solicitação HTTP
GET https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
customBiddingAlgorithmId |
string (int64 format)
Obrigatório. O ID do algoritmo de lances personalizados é o proprietário do script.
|
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 scripts.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:
A ordem de classificação padrão é decrescente. Para especificar a ordem crescente de um campo, o sufixo "desc" precisa ser removido. Exemplo: createTime.
|
Parâmetro de união accessor. Obrigatório. Identifica a entidade do DV360 que é proprietária do algoritmo de lances personalizados pai. Pode ser um parceiro ou um anunciante. accessor pode ser apenas de um dos tipos a seguir: |
partnerId |
string (int64 format)
O ID do parceiro que é proprietário do algoritmo de lances personalizados principal. Somente esse parceiro terá acesso de gravação a esse script de lances personalizados.
|
advertiserId |
string (int64 format)
O ID do anunciante que é proprietário do algoritmo de lances personalizados principal.
|
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 |
{
"customBiddingScripts": [
{
object (CustomBiddingScript)
}
],
"nextPageToken": string
} |
| Campos |
customBiddingScripts[] |
object (CustomBiddingScript)
Lista de scripts de lances personalizados. Essa lista não será exibida 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 ListCustomBiddingScriptsRequest 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 OAuth 2.0 Overview.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],["This API lists custom bidding scripts associated with a specified algorithm using a `GET` request. You must provide the `customBiddingAlgorithmId`. You can filter the results using query parameters like `pageSize`, `pageToken`, and `orderBy`. The `accessor` parameter is required and accepts either a `partnerId` or `advertiserId` for ownership. The response includes a list of `customBiddingScripts` and a `nextPageToken` for pagination. Requires the `https://www.googleapis.com/auth/display-video` OAuth scope.\n"],null,["# Method: customBiddingAlgorithms.scripts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomBiddingScriptsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists custom bidding scripts that belong to the given algorithm.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v4/customBiddingAlgorithms.scripts/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/customBiddingAlgorithms/{customBiddingAlgorithmId}/scripts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customBiddingAlgorithmId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the custom bidding algorithm owns the script. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/customBiddingAlgorithms.scripts/list#body.ListCustomBiddingScriptsResponse.FIELDS.next_page_token) returned from the previous call to `scripts.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`. |\n| Union parameter `accessor`. Required. Identifies the DV360 entity that owns the parent custom bidding algorithm. It can be either a partner or an advertiser. `accessor` can be only one of the following: ||\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that owns the parent custom bidding algorithm. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customBiddingScripts\": [ { object (/display-video/api/reference/rest/v4/customBiddingAlgorithms.scripts#CustomBiddingScript) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customBiddingScripts[]` | `object (`[CustomBiddingScript](/display-video/api/reference/rest/v4/customBiddingAlgorithms.scripts#CustomBiddingScript)`)` The list of custom bidding scripts. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/customBiddingAlgorithms.scripts/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
