Method: sdfdownloadtasks.create

Tworzy zadanie pobierania SDF. Zwraca Operation.

Zadanie pobierania SDF to długotrwała, asynchroniczna operacja. Typ metadata tej operacji to SdfDownloadTaskMetadata. Jeśli żądanie się powiedzie, typ response operacji to SdfDownloadTask. Odpowiedź nie będzie zawierać plików do pobrania, które należy pobrać za pomocą media.download.

Stan operacji można pobrać za pomocą sdfdownloadtasks.operations.get.

Wszelkie błędy znajdziesz w error.message. Pamiętaj, że pole error.details powinno być puste.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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.
}
Pola
version

enum (SdfVersion)

Wymagane. Wersja SDF pobranego pliku. Jeśli ustawisz wartość SDF_VERSION_UNSPECIFIED, domyślnie będzie używana wersja określona przez reklamodawcę lub partnera, którego identyfikator to root_id. Reklamodawca dziedziczy wersję plików SDF od partnera, chyba że skonfigurowano inaczej.
Wymagane. Identyfikator główny określa kontekst żądania pobrania. Musisz wypełnić dokładnie jedno pole. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
partnerId

string (int64 format)

Identyfikator partnera, dla którego chcesz pobrać plik SDF.
advertiserId

string (int64 format)

Identyfikator reklamodawcy, dla którego chcesz pobrać pliki SDF.
Koniec pól wykluczających się wzajemnie.
Wymagane. Opcje określające typy i zakresy elementów do pobrania. Musisz wypełnić dokładnie jedno pole. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
parentEntityFilter

object (ParentEntityFilter)

Filtruje według wybranych typów plików. Elementy w każdym pliku są filtrowane według wybranego zestawu elementów filtra. Encje filtra muszą być tego samego typu co wybrane typy plików lub typu nadrzędnego.
idFilter

object (IdFilter)

Filtruje encje według ich identyfikatorów.
inventorySourceFilter

object (InventorySourceFilter)

Filtruje źródła zasobów reklamowych według ich identyfikatorów.
Koniec pól wykluczających się wzajemnie.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje nowo utworzone wystąpienie elementu Operation.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

ParentEntityFilter

Opcja filtrowania, która filtruje wybrane typy plików należące do wybranego zestawu encji filtra.

Zapis JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Pola
fileType[]

enum (FileType)

Wymagane. Typy plików, które zostaną zwrócone.
filterType

enum (FilterType)

Wymagane. Typ filtra używany do filtrowania pobranych encji.
filterIds[]

string (int64 format)

Identyfikatory określonego typu filtra. Służy do filtrowania elementów do pobrania. Jeśli typ filtra nie jest ustawiony na FILTER_TYPE_NONE, musisz podać co najmniej 1 identyfikator.

FileType

Możliwe typy plików, które można pobrać.

Wartości w polu enum
FILE_TYPE_UNSPECIFIED Wartość domyślna, gdy typ nie jest określony lub jest nieznany w tej wersji.
FILE_TYPE_CAMPAIGN Kampania.
FILE_TYPE_MEDIA_PRODUCT Usługa związana z multimediami.
FILE_TYPE_INSERTION_ORDER Zamówienie reklamowe.
FILE_TYPE_LINE_ITEM Element zamówienia.
FILE_TYPE_AD_GROUP Grupa reklam na YouTube.
FILE_TYPE_AD Reklama w YouTube.
FILE_TYPE_LINE_ITEM_QA Element zamówienia – format QA.
FILE_TYPE_AD_GROUP_QA Grupa reklam na YouTube – format QA.

FilterType

Możliwe typy, według których można filtrować.

Wartości w polu enum
FILTER_TYPE_UNSPECIFIED Wartość domyślna, gdy typ nie jest określony lub jest nieznany w tej wersji.
FILTER_TYPE_NONE Jeśli wybierzesz tę opcję, do pobierania nie zostanie zastosowany żaden filtr. Można używać tylko wtedy, gdy w CreateSdfDownloadTaskRequest określono Advertiser.
FILTER_TYPE_ADVERTISER_ID Identyfikator reklamodawcy. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami reklamodawców, które należą do Partner określonego w CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID Identyfikator kampanii. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami kampanii należącymi do Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Identyfikator produktu multimedialnego. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami produktów multimedialnych, które należą do Advertiser lub Partner określonych w zasadzie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania aplikacji FILE_TYPE_MEDIA_PRODUCT.
FILTER_TYPE_INSERTION_ORDER_ID Identyfikator zamówienia reklamowego. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami zamówień reklamowych, które należą do Advertiser lub Partner określonych w zasadzie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania tych aplikacji: FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA i FILE_TYPE_AD.
FILTER_TYPE_LINE_ITEM_ID Identyfikator elementu zamówienia. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami elementów zamówienia, które należą do Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania tych aplikacji: FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA i FILE_TYPE_AD.

IdFilter

Opcja filtrowania, która filtruje encje według ich identyfikatorów.

Zapis JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
Pola
campaignIds[]

string (int64 format)

Kampanie do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Produkty multimedialne do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Zamówienia reklamowe do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Elementy zamówienia do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Grupy reklam na YouTube do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Reklamy na YouTube do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
lineItemQaIds[]

string (int64 format)

Opcjonalnie: Elementy zamówienia (według identyfikatora) do pobrania w formacie QA. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

Opcjonalnie: Grupy reklam na YouTube według identyfikatora do pobrania w formacie QA. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.

InventorySourceFilter

Opcja filtrowania według encji źródeł zasobów reklamowych.

Zapis JSON 
{
  "inventorySourceIds": [
    string
  ]
}
Pola
inventorySourceIds[]

string (int64 format)

Źródła zasobów reklamowych do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego elementu Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest. Pozostaw to pole puste, aby pobrać wszystkie źródła zasobów reklamowych wybranego reklamodawcy lub partnera.