Method: sdfdownloadtasks.create

Erstellt eine SDF-Download-Aufgabe. Gibt ein Operation zurück.

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

Fehler finden Sie in der error.message. error.details muss leer sein.

HTTP-Anfrage

POST https://displayvideo.googleapis.com/v2/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 SDF_VERSION_UNSPECIFIED festgelegt ist, wird standardmäßig die Version verwendet, die vom Werbetreibenden oder Partner angegeben wurde, der durch root_id angegeben wurde. Sofern nicht anders konfiguriert, übernimmt ein Werbetreibender die SDF-Version des Partners.
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 zum Angeben der Entitätstypen und -bereiche, die heruntergeladen werden sollen. Es muss genau ein Feld festgelegt werden. Für filtering_option ist nur einer der folgenden Werte zulässig:
parentEntityFilter

object (ParentEntityFilter)

Filter für ausgewählte Dateitypen. Die Entitäten in jeder Datei werden nach einem ausgewählten Satz von Filterentitäten gefiltert. Die Filterentitäten müssen denselben Typ wie die ausgewählten Dateitypen haben oder einen übergeordneten Typ haben.
idFilter

object (IdFilter)

Filtert Entitäten nach Entitäts-ID.
inventorySourceFilter

object (InventorySourceFilter)

Inventarquellen werden nach IDs gefiltert.

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 in der Übersicht über OAuth 2.0.

ParentEntityFilter

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

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

enum (FileType)

Erforderlich. Zurückgegebene Dateitypen.
filterType

enum (FilterType)

Erforderlich. Filtertyp zum Filtern abgerufener Entitäten.
filterIds[]

string (int64 format)

Die IDs des angegebenen Filtertyps. Damit werden die abzurufenden Entitäten 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 Medienprodukt.
FILE_TYPE_INSERTION_ORDER Anzeigenauftrag.
FILE_TYPE_LINE_ITEM Werbebuchung.
FILE_TYPE_AD_GROUP YouTube-Anzeigengruppe.
FILE_TYPE_AD YouTube-Anzeige

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 ein 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 sind.
FILTER_TYPE_CAMPAIGN_ID Kampagnen-ID Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Kampagnen-IDs sein, die zur Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben sind.
FILTER_TYPE_MEDIA_PRODUCT_ID Medienprodukt-ID. Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Medienprodukt-IDs sein, die zur 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 zur 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_AD_GROUP 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 sind. Kann nur zum Herunterladen von FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP 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
  ]
}
Felder
campaignIds[]

string (int64 format)

Herunterzuladende Kampagnen nach ID. Alle IDs müssen zur selben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
mediaProductIds[]

string (int64 format)

Herunterzuladende Medienprodukte nach ID. Alle IDs müssen zur selben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
insertionOrderIds[]

string (int64 format)

Herunterzuladende Anzeigenaufträge nach ID. Alle IDs müssen zur selben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
lineItemIds[]

string (int64 format)

Herunterzuladende Werbebuchungen nach ID. Alle IDs müssen zur selben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
adGroupIds[]

string (int64 format)

Herunterzuladende YouTube-Anzeigengruppen nach ID. Alle IDs müssen zur selben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.
adGroupAdIds[]

string (int64 format)

Herunterzuladende YouTube-Anzeigen nach ID. Alle IDs müssen zur selben Advertiser oder Partner gehören, die in CreateSdfDownloadTaskRequest angegeben ist.

InventorySourceFilter

Filteroption zum Filtern nach Inventarquellenentitäten.

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

string (int64 format)

Herunterzuladende Inventarquellen nach ID. Alle IDs müssen zur selben 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.