- HTTP-Anfrage
- Anfragetext
- Antworttext
- Autorisierungsbereiche
- ParentEntityFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- FileType
- FilterType
- IdFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- InventorySourceFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Testen!
Eine SDF-Downloadaufgabe erstellen Gibt ein Operation
zurück.
Eine SDF-Download-Aufgabe ist ein lang andauernder, asynchroner Vorgang. Der Typ metadata
dieses Vorgangs ist SdfDownloadTaskMetadata
. Wenn die Anfrage erfolgreich ist, lautet der Typ response
des Vorgangs SdfDownloadTask
. Die Antwort enthält nicht die Downloaddateien, die mit media.download
abgerufen werden müssen. Der Vorgang kann mit sdfdownloadtask.operations.get
abgerufen werden.
Etwaige Fehler sind in der error.message
enthalten. 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 ( |
Felder | |
---|---|
version |
Erforderlich. Die SDF-Version der heruntergeladenen Datei. Wenn |
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 |
Die ID des Partners, für den die SDF heruntergeladen werden soll. |
advertiserId |
Die ID des Werbetreibenden, für den die SDF heruntergeladen werden soll. |
Union-Feld filtering_option . Erforderlich. Optionen, die die herunterzuladenden Entitätstypen und Bereiche angeben. Es muss genau ein Feld festgelegt werden. Für filtering_option ist nur einer der folgenden Werte zulässig: |
|
parentEntityFilter |
Filtert nach ausgewählten Dateitypen. Die Entitäten in den einzelnen Dateien werden anhand ausgewählter Filterentitäten gefiltert. Die Filterentitäten müssen vom selben Typ wie die ausgewählten Dateitypen oder ein übergeordneter Typ sein. |
idFilter |
Filtert Entitäten nach ihren Entitäts-IDs. |
inventorySourceFilter |
Filtert Inventarquellen nach 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 in der Übersicht über OAuth 2.0.
ParentEntityFilter
Eine Filteroption, mit der nach ausgewählten Dateitypen gefiltert werden kann, die zu einem ausgewählten Satz von Filterentitäten gehören.
JSON-Darstellung |
---|
{ "fileType": [ enum ( |
Felder | |
---|---|
fileType[] |
Erforderlich. Dateitypen, die zurückgegeben werden. |
filterType |
Erforderlich. Filtertyp zum Filtern abgerufener Entitäten. |
filterIds[] |
Die IDs des angegebenen Filtertyps. Wird verwendet, um abzurufende Entitäten zu filtern. Wenn der Filtertyp nicht |
FileType
Mögliche Dateitypen, die heruntergeladen werden können
Enums | |
---|---|
FILE_TYPE_UNSPECIFIED |
Standardwert, wenn der Typ in dieser Version nicht angegeben oder 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 in dieser Version nicht angegeben oder 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 in CreateSdfDownloadTaskRequest angegebenen Partner gehören. |
FILTER_TYPE_CAMPAIGN_ID |
Kampagnen-ID. Wenn diese Option ausgewählt ist, müssen alle Filter-IDs Kampagnen-IDs sein, die zu den 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 zur 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 den 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 zu den 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[] |
Herunterzuladende Kampagnen nach ID. Alle IDs müssen zur selben |
mediaProductIds[] |
Herunterzuladende Medienprodukte nach ID Alle IDs müssen zur selben |
insertionOrderIds[] |
Anzeigenaufträge zum Herunterladen nach ID. Alle IDs müssen zur selben |
lineItemIds[] |
Herunterzuladende Werbebuchungen nach ID Alle IDs müssen zur selben |
adGroupIds[] |
YouTube-Anzeigengruppen zum Herunterladen nach ID. Alle IDs müssen zur selben |
adGroupAdIds[] |
YouTube-Anzeigen zum Herunterladen nach ID. Alle IDs müssen zur selben |
InventorySourceFilter
Eine Filteroption zum Filtern von Inventarquellenentitäten.
JSON-Darstellung |
---|
{ "inventorySourceIds": [ string ] } |
Felder | |
---|---|
inventorySourceIds[] |
Herunterzuladende Inventarquellen nach ID. Alle IDs müssen zur selben |