Method: sdfdownloadtasks.create

Crée une tâche de téléchargement de fichiers de données structurées. Renvoie un Operation.

Une tâche de téléchargement de fichiers 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'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é à l'aide de sdfdownloadtask.operations.get.

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

Requête HTTP

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

  // 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.
}
Champs
version

enum (SdfVersion)

Obligatoire. Version SDF du fichier téléchargé. Si la valeur est SDF_VERSION_UNSPECIFIED, la version spécifiée par l'annonceur ou le partenaire identifié par root_id est utilisée par défaut. Un annonceur hérite de la version de ses fichiers SDF de son partenaire, sauf indication contraire.
Champ d'union root_id. Obligatoire. L'ID racine détermine le contexte de la requête de téléchargement. Vous ne devez définir qu'un seul champ. root_id ne peut être qu'un des éléments suivants :
partnerId

string (int64 format)

ID du partenaire pour lequel le fichier SDF doit être téléchargé.
advertiserId

string (int64 format)

ID de l'annonceur pour lequel le fichier SDF doit être téléchargé.
Champ d'union filtering_option. Obligatoire. Options spécifiant les types d'entités et les plages d'entités à télécharger. Vous ne devez définir qu'un seul champ. filtering_option ne peut être qu'un des éléments suivants :
parentEntityFilter

object (ParentEntityFilter)

Filtre sur les types de fichiers sélectionnés. Les entités de chaque fichier sont filtrées selon un ensemble d'entités de filtre choisi. Les entités de filtre doivent être du même type ou être du même type que les types de fichiers sélectionnés.
idFilter

object (IdFilter)

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

object (InventorySourceFilter)

Filtre les sources d'inventaire en fonction de leur ID.

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 effectue un filtrage sur 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)

Identifiants du type de filtre spécifié. Cela permet de filtrer les entités à extraire. 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.

FilterType

Types possibles pouvant être filtrés.

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 ne sera appliqué au téléchargement. Ne peut être utilisé que si 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 la campagne. Si cette option est sélectionnée, tous les ID de filtre doivent être des ID de campagne appartenant à l'Advertiser ou à l'Partner spécifié dans CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID ID de 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 d'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_AD_GROUP 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_AD_GROUP et FILE_TYPE_AD.

IdFilter

Une option de filtrage qui filtre les entités par leur ID d'entité.

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

string (int64 format)

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

string (int64 format)

Produits multimédias à télécharger par identifiant. Tous les identifiants 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 identifiants doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Éléments de campagne à télécharger par identifiant. Tous les identifiants 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 identifiants 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 identifiants doivent appartenir au même Advertiser ou Partner spécifié dans CreateSdfDownloadTaskRequest.

InventorySourceFilter

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

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

string (int64 format)

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