Method: sdfdownloadtasks.create

Crea un'attività di download SDF. Restituisce un Operation.

Un'attività di download SDF è un'operazione asincrona a lunga esecuzione. Il tipo metadata di questa operazione è SdfDownloadTaskMetadata. Se la richiesta ha esito positivo, il tipo response dell'operazione è SdfDownloadTask. La risposta non includerà i file di download, che devono essere recuperati con media.download.

Lo stato dell'operazione può essere recuperato con sdfdownloadtasks.operations.get.

Eventuali errori sono disponibili in error.message. Tieni presente che error.details dovrebbe essere vuoto.

Richiesta HTTP

POST https://displayvideo.googleapis.com/v4/sdfdownloadtasks

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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.
}
Campi
version

enum (SdfVersion)

Obbligatorio. La versione SDF del file scaricato. Se impostato su SDF_VERSION_UNSPECIFIED, per impostazione predefinita verrà utilizzata la versione specificata dall'inserzionista o dal partner identificato da root_id. Un inserzionista eredita la versione SDF dal partner, a meno che non venga configurata diversamente.
Campo unione root_id. Obbligatorio. L'ID principale determina il contesto della richiesta di download. Deve essere impostato un solo campo. root_id può essere solo uno dei seguenti:
partnerId

string (int64 format)

L'ID del partner per cui scaricare il file SDF.
advertiserId

string (int64 format)

L'ID dell'inserzionista per cui scaricare il file SDF.
Campo unione filtering_option. Obbligatorio. Opzioni che specificano i tipi di entità e gli intervalli da scaricare. Deve essere impostato un solo campo. filtering_option può essere solo uno dei seguenti:
parentEntityFilter

object (ParentEntityFilter)

Filtra in base ai tipi di file selezionati. Le entità in ogni file vengono filtrate in base a un insieme scelto di entità di filtro. Le entità di filtro devono essere dello stesso tipo o di un tipo principale dei tipi di file selezionati.
idFilter

object (IdFilter)

Filtra le entità in base ai relativi ID.
inventorySourceFilter

object (InventorySourceFilter)

Filtra le origini dell'inventario in base ai relativi ID.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation appena creata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/display-video

Per ulteriori informazioni, consulta la sezione OAuth 2.0 Overview.

ParentEntityFilter

Un'opzione di filtro che filtra in base ai tipi di file selezionati appartenenti a un insieme scelto di entità di filtro.

Rappresentazione JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Campi
fileType[]

enum (FileType)

Obbligatorio. Tipi di file che verranno restituiti.
filterType

enum (FilterType)

Obbligatorio. Tipo di filtro utilizzato per filtrare le entità recuperate.
filterIds[]

string (int64 format)

Gli ID del tipo di filtro specificato. Viene utilizzato per filtrare le entità da recuperare. Se il tipo di filtro non è FILTER_TYPE_NONE, è necessario specificare almeno un ID.

FileType

Possibili tipi di file che possono essere scaricati.

Enum
FILE_TYPE_UNSPECIFIED Valore predefinito quando il tipo non è specificato o è sconosciuto in questa versione.
FILE_TYPE_CAMPAIGN campagna.
FILE_TYPE_MEDIA_PRODUCT Prodotto multimediale.
FILE_TYPE_INSERTION_ORDER Ordine di inserzione.
FILE_TYPE_LINE_ITEM Elemento pubblicitario.
FILE_TYPE_AD_GROUP Gruppo di annunci di YouTube.
FILE_TYPE_AD Annuncio di YouTube.
FILE_TYPE_LINE_ITEM_QA Formato dell'elemento pubblicitario - QA.
FILE_TYPE_AD_GROUP_QA Gruppo di annunci di YouTube - Formato QA.

FilterType

Possibili tipi su cui applicare un filtro.

Enum
FILTER_TYPE_UNSPECIFIED Valore predefinito quando il tipo non è specificato o è sconosciuto in questa versione.
FILTER_TYPE_NONE Se selezionata, non verrà applicato alcun filtro al download. Può essere utilizzato solo se in CreateSdfDownloadTaskRequest è specificato un Advertiser.
FILTER_TYPE_ADVERTISER_ID ID inserzionista. Se selezionati, tutti gli ID filtro devono essere ID inserzionista appartenenti al Partner specificato in CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID ID campagna. Se selezionati, tutti gli ID filtro devono essere ID campagna che appartengono a Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID ID prodotto multimediale. Se selezionati, tutti gli ID filtro devono essere ID prodotto multimediale che appartengono a Advertiser o Partner specificati in CreateSdfDownloadTaskRequest. Può essere utilizzato solo per scaricare FILE_TYPE_MEDIA_PRODUCT.
FILTER_TYPE_INSERTION_ORDER_ID ID ordine di inserzione. Se selezionati, tutti gli ID filtro devono essere ID ordine di inserzione che appartengono a Advertiser o Partner specificati in CreateSdfDownloadTaskRequest. Può essere utilizzato solo per scaricare 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 elemento pubblicitario. Se selezionati, tutti gli ID filtro devono essere ID elemento pubblicitario che appartengono a Advertiser o Partner specificati in CreateSdfDownloadTaskRequest. Può essere utilizzato solo per scaricare FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA e FILE_TYPE_AD.

IdFilter

Un'opzione di filtro che filtra le entità in base ai relativi ID.

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

string (int64 format)

Le campagne da scaricare per ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Prodotti multimediali da scaricare per ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Ordini di inserzione da scaricare per ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Elementi pubblicitari da scaricare per ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Gruppi di annunci di YouTube da scaricare in base all'ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Annunci di YouTube da scaricare in base all'ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
lineItemQaIds[]

string (int64 format)

Facoltativo. Elementi pubblicitari, per ID, da scaricare in formato QA. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

Facoltativo. Gruppi di annunci di YouTube, per ID, da scaricare in formato QA. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest.

InventorySourceFilter

Un'opzione di filtro per filtrare in base alle entità Origine inventario.

Rappresentazione JSON 
{
  "inventorySourceIds": [
    string
  ]
}
Campi
inventorySourceIds[]

string (int64 format)

Origini dell'inventario da scaricare in base all'ID. Tutti gli ID devono appartenere allo stesso Advertiser o Partner specificato in CreateSdfDownloadTaskRequest. Lascia vuoto per scaricare tutte le origini inventario per l'inserzionista o il partner selezionato.