- Requête HTTP
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- Essayer
Crée une tâche de téléchargement SDF. Renvoie un Operation
.
Une tâche de téléchargement SDF est une opération asynchrone de longue durée. Le type metadata
de cette opération est SdfDownloadTaskMetadata
. Si la requête aboutit, le type response
de l'opération est SdfDownloadTask
. La réponse n'inclut pas les fichiers à télécharger, qui doivent être récupérés avec media.download
. L'état de l'opération peut être récupéré avec sdfdownloadtask.operations.get
.
Toutes les erreurs se trouvent dans error.message
. Notez que error.details
doit être vide.
Requête HTTP
POST https://displayvideo.googleapis.com/v3/sdfdownloadtasks
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "version": enum ( |
Champs | |
---|---|
version |
Obligatoire. Version SDF du fichier téléchargé. Si la valeur est |
Champ d'union root_id . Obligatoire. L'ID racine détermine le contexte de la requête de téléchargement. Un seul champ doit être défini. root_id ne peut être qu'un des éléments suivants : |
|
partner |
ID du partenaire pour lequel télécharger le fichier SDF. |
advertiser |
Identifiant de l'annonceur pour lequel vous souhaitez télécharger un fichier SDF. |
Champ d'union filtering_option . Obligatoire. Options qui spécifient les types et les plages d'entités à télécharger. Un seul champ doit être défini. filtering_option ne peut être qu'un des éléments suivants : |
|
parent |
Filtre les types de fichiers sélectionnés. Les entités de chaque fichier sont filtrées par un ensemble d'entités de filtre choisi. Les entités de filtre doivent être du même type que les types de fichiers sélectionnés ou un type parent de ceux-ci. |
id |
Filtre les entités en fonction de leurs ID. |
inventory |
Filtres sur les sources d'inventaire en fonction de leur identifiant. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Operation
.
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/display-video
Pour en savoir plus, consultez la présentation d'OAuth 2.0.
ParentEntityFilter
Option de filtrage qui filtre les types de fichiers sélectionnés appartenant à un ensemble donné d'entités de filtre.
Représentation JSON |
---|
{ "fileType": [ enum ( |
Champs | |
---|---|
file |
Obligatoire. Types de fichiers qui seront renvoyés. |
filter |
Obligatoire. Type de filtre utilisé pour filtrer les entités extraites. |
filter |
ID du type de filtre spécifié. Permet de filtrer les entités à extraire. Si le type de filtre n'est pas |
FileType
Types de fichiers pouvant être téléchargés.
Enums | |
---|---|
FILE_TYPE_UNSPECIFIED |
Valeur par défaut lorsque le type n'est pas spécifié ou est inconnu dans cette version. |
FILE_TYPE_CAMPAIGN |
une campagne qui, |
FILE_TYPE_MEDIA_PRODUCT |
Produit multimédia. |
FILE_TYPE_INSERTION_ORDER |
Ordre d'insertion. |
FILE_TYPE_LINE_ITEM |
Élément de campagne. |
FILE_TYPE_AD_GROUP |
Groupe d'annonces YouTube |
FILE_TYPE_AD |
Annonce YouTube |
FILE_TYPE_LINE_ITEM_QA |
Élément de campagne – Format de contrôle qualité. |
FILE_TYPE_AD_GROUP_QA |
Format de contrôle qualité pour les groupes d'annonces YouTube. |
FilterType
Types de filtres possibles.
Enums | |
---|---|
FILTER_TYPE_UNSPECIFIED |
Valeur par défaut lorsque le type n'est pas spécifié ou est inconnu dans cette version. |
FILTER_TYPE_NONE |
Si cette option est sélectionnée, aucun filtre n'est appliqué au téléchargement. Ne peut être utilisé que si un Advertiser est spécifié dans CreateSdfDownloadTaskRequest . |
FILTER_TYPE_ADVERTISER_ID |
Référence annonceur. Si cette option est sélectionnée, tous les ID de filtre doivent être des références annonceur appartenant aux Partner spécifiées dans CreateSdfDownloadTaskRequest . |
FILTER_TYPE_CAMPAIGN_ID |
ID de la campagne. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID de campagne appartenant aux Advertiser ou aux Partner spécifiés dans CreateSdfDownloadTaskRequest . |
FILTER_TYPE_MEDIA_PRODUCT_ID |
ID du produit multimédia. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID de produits multimédias appartenant à l'Advertiser ou à l'Partner spécifié dans CreateSdfDownloadTaskRequest . Ne peut être utilisé que pour télécharger FILE_TYPE_MEDIA_PRODUCT . |
FILTER_TYPE_INSERTION_ORDER_ID |
ID de l'ordre d'insertion. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID d'ordre d'insertion appartenant aux Advertiser ou aux Partner spécifiés dans CreateSdfDownloadTaskRequest . Ne peut être utilisé que pour télécharger FILE_TYPE_INSERTION_ORDER , FILE_TYPE_LINE_ITEM , FILE_TYPE_LINE_ITEM_QA , FILE_TYPE_AD_GROUP , FILE_TYPE_AD_GROUP_QA et FILE_TYPE_AD . |
FILTER_TYPE_LINE_ITEM_ID |
ID de l'élément de campagne. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID d'article qui appartiennent à l'Advertiser ou à l'Partner spécifié dans CreateSdfDownloadTaskRequest . Ne peut être utilisé que pour télécharger FILE_TYPE_LINE_ITEM , FILE_TYPE_LINE_ITEM_QA , FILE_TYPE_AD_GROUP , FILE_TYPE_AD_GROUP_QA et FILE_TYPE_AD . |
IdFilter
Option de filtrage qui filtre les entités en fonction de leurs ID.
Représentation JSON |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ], "lineItemQaIds": [ string ], "adGroupQaIds": [ string ] } |
Champs | |
---|---|
campaign |
Campagnes à télécharger par ID. Tous les ID doivent appartenir au même |
media |
Produits multimédias à télécharger par ID. Tous les ID doivent appartenir au même |
insertion |
Ordres d'insertion à télécharger par ID. Tous les ID doivent appartenir au même |
line |
Éléments de campagne à télécharger par identifiant. Tous les ID doivent appartenir au même |
ad |
Groupes d'annonces YouTube à télécharger par ID. Tous les ID doivent appartenir au même |
ad |
Annonces YouTube à télécharger par ID. Tous les ID doivent appartenir au même |
line |
Facultatif. Éléments de campagne, par ID, à télécharger au format QA. Tous les ID doivent appartenir au même |
ad |
Facultatif. Groupes d'annonces YouTube, par ID, à télécharger au format QA. Tous les ID doivent appartenir au même |
InventorySourceFilter
Option de filtrage pour les entités "Source d'inventaire".
Représentation JSON |
---|
{ "inventorySourceIds": [ string ] } |
Champs | |
---|---|
inventory |
Sources d'inventaire à télécharger par ID. Tous les ID doivent appartenir au même |