Esta página foi traduzida pela API Cloud Translation.

Method: sdfdownloadtasks.create

Solicitação HTTP
Corpo da solicitação
- Representação JSON
Corpo da resposta
Escopos de autorização
ParentEntityFilter
- Representação JSON
FileType
FilterType
IdFilter
- Representação JSON
InventorySourceFilter
- Representação JSON
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 de operação pode ser recuperado com sdfdownloadtask.operations.get.

Os erros podem ser encontrados no error.message. Observe que error.details deve estar vazio.

Solicitação HTTP

POST https://displayvideo.googleapis.com/v3/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

Representação JSON
{ "version": enum (`SdfVersion`), // Union field `root_id` can be only one of the following: "partnerId": string, "advertiserId": string // End of list of possible types for union field `root_id`. // Union field `filtering_option` can be only one of the following: "parentEntityFilter": { object (`ParentEntityFilter`) }, "idFilter": { object (`IdFilter`) }, "inventorySourceFilter": { object (`InventorySourceFilter`) } // End of list of possible types for union field `filtering_option`. }

{
  "version": enum (SdfVersion),

  // Union field root_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field root_id.

  // Union field filtering_option can be only one of the following:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of list of possible types for union field filtering_option.
}

Campos
`version`	`enum (SdfVersion)` Obrigatório. A versão SDF do arquivo baixado. Se definido como `SDF_VERSION_UNSPECIFIED`, o padrão será a versão especificada pelo anunciante ou parceiro identificado por `root_id`. Um anunciante herda a versão do SDF do parceiro, a menos que seja configurado de outra forma.
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`	`string (int64 format)` O ID do parceiro para fazer o download do SDF.
`advertiserId`	`string (int64 format)` 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 dos quais fazer o download. Exatamente um campo precisa ser definido. `filtering_option` pode ser apenas de um dos tipos a seguir:
`parentEntityFilter`	`object (ParentEntityFilter)` Filtros nos tipos de arquivo selecionados. As entidades em 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`	`object (IdFilter)` Filtra entidades por seus IDs de entidade.
`inventorySourceFilter`	`object (InventorySourceFilter)` Filtros nas origens de inventário pelos IDs.

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 de filtragem que filtra os tipos de arquivo selecionados que pertencem a um conjunto específico de entidades de filtro.

Representação JSON
{ "fileType": [ enum (`FileType`) ], "filterType": enum (`FilterType`), "filterIds": [ string ] }

Campos

Campos
`fileType[]`	`enum (FileType)` Obrigatório. Tipos de arquivo que serão retornados.
`filterType`	`enum (FilterType)` Obrigatório. Tipo de filtro usado para filtrar entidades buscadas.
`filterIds[]`	`string (int64 format)` Os IDs do tipo de filtro especificado. Isso é usado para filtrar entidades a serem buscadas. Se o tipo de filtro não for `FILTER_TYPE_NONE`, será necessário especificar pelo menos um ID.

fileType[]

enum (FileType)

Obrigatório. Tipos de arquivo que serão retornados.

filterType

enum (FilterType)

Obrigatório. Tipo de filtro usado para filtrar entidades buscadas.

filterIds[]

string (int64 format)

Os IDs do tipo de filtro especificado. Isso é usado para filtrar entidades a serem buscadas. Se o tipo de filtro não for FILTER_TYPE_NONE, será necessário especificar pelo menos um ID.

FileType

Possíveis tipos de arquivos dos quais é possível fazer o 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.
`FILE_TYPE_LINE_ITEM_QA`	Item de linha - formato de controle de qualidade.
`FILE_TYPE_AD_GROUP_QA`	Grupo de anúncios do YouTube - formato de controle de qualidade.

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ó poderá ser usado se um `Advertiser` for especificado em `CreateSdfDownloadTaskRequest`.
`FILTER_TYPE_ADVERTISER_ID`	ID do anunciante. Se selecionados, todos os IDs de filtro precisam ser IDs de anunciantes que pertencem ao `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`FILTER_TYPE_CAMPAIGN_ID`	ID da campanha. Se selecionados, todos os IDs de filtro precisam ser IDs de campanhas que pertencem ao `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`FILTER_TYPE_MEDIA_PRODUCT_ID`	ID do produto de mídia. Se selecionado, todos os IDs de filtro precisam ser IDs de produtos de mídia que pertencem ao `Advertiser` ou ao `Partner` especificado 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 precisam ser IDs de pedidos de inserção que pertencem ao `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`. Só pode ser usado para fazer o download de `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA` e `FILE_TYPE_AD`.
`FILTER_TYPE_LINE_ITEM_ID`	ID do item de linha. Se selecionados, todos os IDs de filtro precisam ser IDs de item de linha que pertencem ao `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`. Só pode ser usado para fazer o download de `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA` 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 ], "lineItemQaIds": [ string ], "adGroupQaIds": [ string ] }

Representação JSON

{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}

Campos
`campaignIds[]`	`string (int64 format)` Campanhas para download por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`mediaProductIds[]`	`string (int64 format)` Produtos de mídia baixados por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`insertionOrderIds[]`	`string (int64 format)` Pedidos de inserção transferidos por download por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`lineItemIds[]`	`string (int64 format)` Itens de linha para download por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`adGroupIds[]`	`string (int64 format)` Grupos de anúncios do YouTube que serão baixados por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`adGroupAdIds[]`	`string (int64 format)` Anúncios do YouTube para download por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`lineItemQaIds[]`	`string (int64 format)` Opcional. Itens de linha, por ID, para download no formato de controle de qualidade. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.
`adGroupQaIds[]`	`string (int64 format)` Opcional. Grupos de anúncios do YouTube, por ID, para download no formato de controle de qualidade. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`.

InventorySourceFilter

Uma opção de filtro para filtrar entidades de origem de inventário.

Representação JSON
{ "inventorySourceIds": [ string ] }

Campos

Campos
`inventorySourceIds[]`	`string (int64 format)` Origens de inventário para fazer o download por ID. Todos os IDs precisam pertencer ao mesmo `Advertiser` ou `Partner` especificado em `CreateSdfDownloadTaskRequest`. Deixe em branco para fazer o download de todas as origens de inventário do anunciante ou parceiro selecionado.

inventorySourceIds[]

string (int64 format)

Origens de inventário para fazer o download por ID. Todos os IDs precisam pertencer ao mesmo Advertiser ou Partner especificado em CreateSdfDownloadTaskRequest. Deixe em branco para fazer o download de todas as origens de inventário do anunciante ou parceiro selecionado.