Method: sdfdownloadtasks.create

Crée une tâche de téléchargement de SDF. Renvoie un Operation.

Une tâche de téléchargement de FDS 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'inclura pas les fichiers de téléchargement, qui doivent être récupérés avec media.download.

L'état de l'opération peut être récupéré avec sdfdownloadtasks.operations.get.

Les erreurs éventuelles sont indiquées dans le error.message. Notez que error.details doit être vide.

Requête HTTP

POST https://displayvideo.googleapis.com/v5/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 (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.
}
Champs
version

enum (SdfVersion)

Obligatoire. Version SDF du fichier téléchargé. Si la valeur est définie sur SDF_VERSION_UNSPECIFIED, la version par défaut sera celle spécifiée par l'annonceur ou le partenaire identifié par root_id. Un annonceur hérite de la version de SDF de son partenaire, sauf configuration contraire.
Obligatoire. L'ID racine détermine le contexte de la demande de téléchargement. Un seul champ doit être défini. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
partnerId

string (int64 format)

ID du partenaire pour lequel télécharger le fichier SDF.
advertiserId

string (int64 format)

ID de l'annonceur pour lequel télécharger le fichier SDF.
Fin des champs mutuellement exclusifs.
Obligatoire. Options spécifiant les types d'entités et les plages à télécharger. Un seul champ doit être défini. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
parentEntityFilter

object (ParentEntityFilter)

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 d'un type parent.
idFilter

object (IdFilter)

Filtre les entités en fonction de leur ID d'entité.
inventorySourceFilter

object (InventorySourceFilter)

Filtre les sources d'inventaire en fonction de leur ID.
Fin des champs mutuellement exclusifs.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Operation.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.

ParentEntityFilter

Option de filtrage qui filtre les types de fichiers sélectionnés appartenant à un ensemble d'entités de filtre choisi.

Représentation JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Champs
fileType[]

enum (FileType)

Obligatoire. Types de fichiers qui seront renvoyés.
filterType

enum (FilterType)

Obligatoire. Type de filtre utilisé pour filtrer les entités récupérées.
filterIds[]

string (int64 format)

ID du type de filtre spécifié. Il permet de filtrer les entités à récupérer. Si le type de filtre n'est pas FILTER_TYPE_NONE, vous devez spécifier au moins un ID.

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 des questions de l'annexe.
FILE_TYPE_AD_GROUP_QA YouTube Ad Group - QA format.

FilterType

Types possibles sur lesquels filtrer.

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 vous sélectionnez cette option, aucun filtre ne sera 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 au Partner spécifié dans CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID ID de campagne. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID de campagne appartenant au Advertiser ou au Partner spécifié dans CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Identifiant produit multimédia. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID de produits multimédias appartenant au Advertiser ou au 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 à l'Advertiser ou à l'Partner spécifié 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'élément de campagne appartenant à 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 leur ID.

Représentation JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
Champs
campaignIds[]

string (int64 format)

Campagnes à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Produits multimédias à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Ordres d'insertion à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Éléments de campagne à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Groupes d'annonces YouTube à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Annonces YouTube à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
lineItemQaIds[]

string (int64 format)

Facultatif. Éléments de campagne, par ID, à télécharger au format QA. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

Facultatif. Groupes d'annonces YouTube, par ID, à télécharger au format QA. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.

InventorySourceFilter

Option de filtrage pour filtrer les entités de source d'inventaire.

Représentation JSON 
{
  "inventorySourceIds": [
    string
  ]
}
Champs
inventorySourceIds[]

string (int64 format)

Sources d'inventaire à télécharger par ID. Tous les ID doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest. Laissez ce champ vide pour télécharger toutes les sources d'inventaire de l'annonceur ou du partenaire sélectionné.