Method: sdfdownloadtasks.create

Erstellt eine SDF-Downloadaufgabe. Gibt ein Operation zurück.

Eine SDF-Downloadaufgabe ist ein asynchroner Vorgang mit langer Ausführungszeit. Der metadata-Typ dieses Vorgangs ist SdfDownloadTaskMetadata. Wenn die Anfrage erfolgreich ist, ist der response-Typ des Vorgangs SdfDownloadTask. Die Antwort enthält nicht die Download-Dateien, die mit media.download abgerufen werden müssen. Der Status des Vorgangs kann mit sdfdownloadtask.operations.get abgerufen werden.

Alle Fehler finden Sie im error.message. error.details sollte leer sein.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
version

enum (SdfVersion)

Erforderlich. Die SDF-Version der heruntergeladenen Datei. Wenn diese Option auf SDF_VERSION_UNSPECIFIED festgelegt ist, wird standardmäßig die Version verwendet, die vom Werbetreibenden oder Partner angegeben wurde, der durch root_id identifiziert wird. Die SDF-Version eines Werbetreibenden wird von seinem Partner übernommen, sofern nichts anderes konfiguriert ist.
Union-Feld root_id. Erforderlich. Die Stamm-ID bestimmt den Kontext der Downloadanfrage. Es muss genau ein Feld festgelegt werden. Für root_id ist nur einer der folgenden Werte zulässig:
partnerId

string (int64 format)

Die ID des Partners, für den die SDF heruntergeladen werden soll.
advertiserId

string (int64 format)

Die ID des Werbetreibenden, für den die SDF heruntergeladen werden soll.
Union-Feld filtering_option. Erforderlich. Optionen, mit denen die herunterzuladenden Entitätstypen und ‑bereiche angegeben werden. Es muss genau ein Feld festgelegt werden. Für filtering_option ist nur einer der folgenden Werte zulässig:
parentEntityFilter

object (ParentEntityFilter)

Filtert nach ausgewählten Dateitypen. Die Entitäten in jeder Datei werden nach einer ausgewählten Gruppe von Filterentitäten gefiltert. Die Filterentitäten müssen denselben Typ wie die ausgewählten Dateitypen oder einen übergeordneten Typ haben.
idFilter

object (IdFilter)

Filtert Entitäten nach ihren Entitäts-IDs.
inventorySourceFilter

object (InventorySourceFilter)

Filtert Inventarquellen nach ihren IDs.

Antworttext

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Operation.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

ParentEntityFilter

Eine Filteroption, mit der nach ausgewählten Dateitypen gefiltert wird, die zu einer ausgewählten Gruppe von Filterentitäten gehören.

JSON-Darstellung 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Felder
fileType[]

enum (FileType)

Erforderlich. Dateitypen, die zurückgegeben werden.
filterType

enum (FilterType)

Erforderlich. Filtertyp, der zum Filtern abgerufener Einheiten verwendet wird.
filterIds[]

string (int64 format)

Die IDs des angegebenen Filtertyps. Damit werden die abzurufenden Einheiten gefiltert. Wenn der Filtertyp nicht FILTER_TYPE_NONE ist, muss mindestens eine ID angegeben werden.

FileType

Mögliche Dateitypen, die heruntergeladen werden können.

Enums
FILE_TYPE_UNSPECIFIED Standardwert, wenn der Typ nicht angegeben oder in dieser Version unbekannt ist.
FILE_TYPE_CAMPAIGN Kampagne enthalten.
FILE_TYPE_MEDIA_PRODUCT Mediaprodukt
FILE_TYPE_INSERTION_ORDER Anzeigenauftrag
FILE_TYPE_LINE_ITEM Werbebuchung.
FILE_TYPE_AD_GROUP YouTube-Anzeigengruppe
FILE_TYPE_AD YouTube-Anzeige
FILE_TYPE_LINE_ITEM_QA Werbebuchung – QA-Format
FILE_TYPE_AD_GROUP_QA YouTube-Anzeigengruppe – QA-Format.

FilterType

Mögliche Typen, nach denen gefiltert werden kann.

Enums
FILTER_TYPE_UNSPECIFIED Standardwert, wenn der Typ nicht angegeben oder in dieser Version unbekannt ist.
FILTER_TYPE_NONE Wenn diese Option ausgewählt ist, wird kein Filter auf den Download angewendet. Kann nur verwendet werden, wenn in CreateSdfDownloadTaskRequest eine Advertiser angegeben ist.
FILTER_TYPE_ADVERTISER_ID Werbetreibenden-ID Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Werbetreibenden-IDs sein, die zur Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
FILTER_TYPE_CAMPAIGN_ID Kampagnen-ID. Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Kampagnen-IDs sein, die zu Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben sind.
FILTER_TYPE_MEDIA_PRODUCT_ID Media-Produkt-ID. Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Media-Produkt-IDs sein, die zu Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben sind. Kann nur zum Herunterladen von FILE_TYPE_MEDIA_PRODUCT verwendet werden.
FILTER_TYPE_INSERTION_ORDER_ID Anzeigenauftrags-ID Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Anzeigenauftrags-IDs sein, die zu Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben sind. Kann nur zum Herunterladen von FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA und FILE_TYPE_AD verwendet werden.
FILTER_TYPE_LINE_ITEM_ID Werbebuchungs-ID. Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Werbebuchungs-IDs sein, die zur Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist. Kann nur zum Herunterladen von FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA und FILE_TYPE_AD verwendet werden.

IdFilter

Eine Filteroption, mit der Entitäten nach ihren Entitäts-IDs gefiltert werden.

JSON-Darstellung 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
Felder
campaignIds[]

string (int64 format)

Kampagnen, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
mediaProductIds[]

string (int64 format)

Medienprodukte, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
insertionOrderIds[]

string (int64 format)

Anzeigenaufträge, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
lineItemIds[]

string (int64 format)

Werbebuchungen, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
adGroupIds[]

string (int64 format)

YouTube-Anzeigengruppen, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
adGroupAdIds[]

string (int64 format)

YouTube-Anzeigen, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
lineItemQaIds[]

string (int64 format)

Optional. Werbebuchungen nach ID, die im QA-Format heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
adGroupQaIds[]

string (int64 format)

Optional. YouTube-Anzeigengruppen nach ID, die im QA-Format heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.

InventorySourceFilter

Eine Filteroption zum Filtern nach Inventarquellen-Entitäten.

JSON-Darstellung 
{
  "inventorySourceIds": [
    string
  ]
}
Felder
inventorySourceIds[]

string (int64 format)

Inventarquellen, die nach ID heruntergeladen werden sollen. Alle IDs müssen zu derselben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist. Lassen Sie das Feld leer, um alle Inventarquellen für den ausgewählten Werbetreibenden oder Partner herunterzuladen.