Method: sdfdownloadtasks.create

Cria uma tarefa de download de SDF. Retorna um Operation.

Uma tarefa de download de SDF é uma operação assíncrona 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 vai incluir os arquivos de download, que precisam ser recuperados com media.download.

O estado da operação pode ser recuperado com sdfdownloadtasks.operations.get.

Os erros podem ser encontrados em error.message. Observe que error.details precisa estar vazio.

Solicitação HTTP

POST https://displayvideo.googleapis.com/v5/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 (SdfVersion),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
Campos
version

enum (SdfVersion)

Obrigatório. A versão do 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.
Obrigatório. O ID raiz determina o contexto da solicitação de download. Exatamente um campo precisa ser definido. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
partnerId

string (int64 format)

O ID do parceiro para o qual o SDF será baixado.
advertiserId

string (int64 format)

O ID do anunciante para o qual o SDF será baixado.
Fim dos campos mutuamente exclusivos.
Obrigatório. Opções que especificam os tipos de entidade e os intervalos para download. Exatamente um campo precisa ser definido. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
parentEntityFilter

object (ParentEntityFilter)

Filtra os 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 pelos IDs delas.
inventorySourceFilter

object (InventorySourceFilter)

Filtra as origens de inventário pelos IDs.
Fim dos campos mutuamente exclusivos.

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 OAuth 2.0 Overview.

ParentEntityFilter

Uma opção de filtragem que filtra os tipos de arquivo selecionados que pertencem a um conjunto escolhido de entidades de filtro.

Representação JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
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 as entidades que serão buscadas. Se o tipo de filtro não for FILTER_TYPE_NONE, pelo menos um ID precisará ser especificado.

FileType

Tipos possíveis de arquivos que podem ser baixados.

Tipos enumerados
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.

Tipos enumerados
FILTER_TYPE_UNSPECIFIED Valor padrão quando o tipo não é especificado ou é desconhecido nesta versão.
FILTER_TYPE_NONE Se 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 precisam ser IDs de anunciante 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 campanha que pertencem ao Advertiser ou Partner especificado em CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID ID do produto de mídia. Se selecionados, todos os IDs de filtro precisam ser IDs de produtos de mídia que pertencem ao Advertiser ou Partner especificado em CreateSdfDownloadTaskRequest. Só pode ser usado para baixar 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 pedido 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 baixar 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 IDs delas.

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 para download por ID. Todos os IDs precisam pertencer ao mesmo Advertiser ou Partner especificado em CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Pedidos de inserção para 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 para download 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 filtragem para entidades de origem de inventário.

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

string (int64 format)

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