- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- Escopos da autorização
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- Faça um teste
Cria uma tarefa de download de SDF. Retorna um Operation
.
Uma tarefa de download de SDF é uma operação assíncrona e de longa duração. O tipo metadata
dessa operação é SdfDownloadTaskMetadata
. Se a solicitação for bem-sucedida, o tipo response
da operação será SdfDownloadTask
. A resposta não incluirá os arquivos de download, que precisam ser recuperados com media.download
. O estado da operação pode ser recuperado com sdfdownloadtask.operations.get
.
Todos os erros podem ser encontrados no error.message
. error.details
precisa estar vazio.
Solicitação HTTP
POST https://displayvideo.googleapis.com/v1/sdfdownloadtasks
O URL usa a sintaxe de transcodificação gRPC.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "version": enum ( |
Campos | |
---|---|
version |
Obrigatório. A versão SDF do arquivo transferido por download. Se definido como |
Campo de união root_id . Obrigatório. O ID raiz determina o contexto da solicitação de download. Exatamente um campo precisa ser definido. root_id pode ser apenas de um dos tipos a seguir: |
|
partnerId |
O ID do parceiro para o qual o download do SDF será realizado. |
advertiserId |
O ID do anunciante para o qual fazer o download do SDF. |
Campo de união filtering_option . Obrigatório. Opções que especificam os tipos de entidade e os intervalos para download. Exatamente um campo precisa ser definido. filtering_option pode ser apenas de um dos tipos a seguir: |
|
parentEntityFilter |
Filtros nos tipos de arquivo selecionados. As entidades de cada arquivo são filtradas por um conjunto escolhido de entidades de filtro. As entidades de filtro precisam ser do mesmo tipo ou de um tipo pai dos tipos de arquivo selecionados. |
idFilter |
Filtros em entidades pelos IDs delas. |
inventorySourceFilter |
Filtros nas origens de inventário pelos IDs delas. |
Corpo da resposta
Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Operation
.
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.
ParentEntityFilter
Uma opção que filtra os tipos de arquivo selecionados que pertencem a um conjunto escolhido de entidades de filtro.
Representação JSON |
---|
{ "fileType": [ enum ( |
Campos | |
---|---|
fileType[] |
Obrigatório. Tipos de arquivo que serão retornados. |
filterType |
Obrigatório. Tipo de filtro usado para filtrar as entidades buscadas. |
filterIds[] |
Os IDs do tipo de filtro especificado. É usado para filtrar entidades a serem buscadas. Se o tipo de filtro não for |
FileType
Possíveis tipos de arquivos para download.
Enums | |
---|---|
FILE_TYPE_UNSPECIFIED |
Valor padrão quando o tipo não é especificado ou é desconhecido nesta versão. |
FILE_TYPE_CAMPAIGN |
campanha. |
FILE_TYPE_MEDIA_PRODUCT |
Produto de mídia. |
FILE_TYPE_INSERTION_ORDER |
Pedido de inserção. |
FILE_TYPE_LINE_ITEM |
Item de linha. |
FILE_TYPE_AD_GROUP |
grupo de anúncios do YouTube. |
FILE_TYPE_AD |
Anúncio do YouTube |
FilterType
Tipos possíveis que podem ser filtrados.
Enums | |
---|---|
FILTER_TYPE_UNSPECIFIED |
Valor padrão quando o tipo não é especificado ou é desconhecido nesta versão. |
FILTER_TYPE_NONE |
Se esta opção for selecionada, nenhum filtro será aplicado ao download. Só pode ser usado se um Advertiser for especificado em CreateSdfDownloadTaskRequest . |
FILTER_TYPE_ADVERTISER_ID |
ID do anunciante. Se selecionados, todos os IDs de filtro precisarão ser IDs de anunciantes que pertençam ao Partner especificado em CreateSdfDownloadTaskRequest . |
FILTER_TYPE_CAMPAIGN_ID |
ID da campanha Se selecionados, todos os IDs de filtro precisarão ser IDs de campanhas que pertençam ao Advertiser ou ao Partner especificados em CreateSdfDownloadTaskRequest . |
FILTER_TYPE_MEDIA_PRODUCT_ID |
ID do produto de mídia. Se selecionados, todos os IDs de filtro precisarão ser IDs de produtos de mídia que pertençam ao Advertiser ou ao Partner especificados em CreateSdfDownloadTaskRequest . Só pode ser usado para fazer o download de FILE_TYPE_MEDIA_PRODUCT . |
FILTER_TYPE_INSERTION_ORDER_ID |
ID do pedido de inserção Se selecionados, todos os IDs de filtro precisarão ser IDs de pedidos de inserção que pertençam ao Advertiser ou ao Partner especificados em CreateSdfDownloadTaskRequest . Só pode ser usado para fazer o download de FILE_TYPE_INSERTION_ORDER , FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP e FILE_TYPE_AD . |
FILTER_TYPE_LINE_ITEM_ID |
ID do item de linha. Se selecionados, todos os IDs de filtro precisarão ser IDs de itens de linha que pertençam ao Advertiser ou ao Partner especificados em CreateSdfDownloadTaskRequest . Só pode ser usado para fazer o download de FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP e FILE_TYPE_AD . |
IdFilter
Uma opção de filtragem que filtra entidades pelos respectivos IDs.
Representação JSON |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
Campos | |
---|---|
campaignIds[] |
Campanhas para download por ID. Todos os IDs precisam pertencer ao mesmo |
mediaProductIds[] |
Produtos de mídia para download por ID. Todos os IDs precisam pertencer ao mesmo |
insertionOrderIds[] |
Download dos pedidos de inserção por ID. Todos os IDs precisam pertencer ao mesmo |
lineItemIds[] |
Itens de linha para download por ID. Todos os IDs precisam pertencer ao mesmo |
adGroupIds[] |
Grupos de anúncios do YouTube, disponíveis para download por ID. Todos os IDs precisam pertencer ao mesmo |
adGroupAdIds[] |
Anúncios do YouTube para download por ID. Todos os IDs precisam pertencer ao mesmo |
InventorySourceFilter
Uma opção para filtrar entidades da origem de inventário.
Representação JSON |
---|
{ "inventorySourceIds": [ string ] } |
Campos | |
---|---|
inventorySourceIds[] |
Origens de inventário para download por ID. Todos os IDs precisam pertencer ao mesmo |