Method: sdfdownloadtasks.create

Tworzy zadanie pobierania pliku SDF. Zwraca wartość Operation.

Zadanie pobierania SDF to długotrwała operacja asynchroniczna. Typ tej operacji metadata to SdfDownloadTaskMetadata. Jeśli żądanie zostanie wykonane, typ operacji response to SdfDownloadTask. Odpowiedź nie będzie zawierać plików do pobrania, które należy pobrać za pomocą funkcji media.download. Stan operacji można pobrać za pomocą sdfdownloadtask.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/v3/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),

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

enum (SdfVersion)

Wymagane. Wersja SDF pobranego pliku. Jeśli ta opcja jest ustawiona na SDF_VERSION_UNSPECIFIED, domyślnie będzie używana wersja określona przez reklamodawcę lub partnera zidentyfikowanego przez parametr root_id. Reklamodawca dziedziczy wersję plików SDF od partnera, chyba że skonfigurowano inaczej.
Pole zbiorcze root_id. Wymagane. Identyfikator główny określa kontekst żądania pobierania. Musisz ustawić dokładnie 1 pole. root_id może mieć tylko jedną z tych wartości:
partnerId

string (int64 format)

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

string (int64 format)

Identyfikator reklamodawcy, dla którego chcesz pobrać plik SDF.
Pole zbiorcze filtering_option. Wymagane. Opcje określające typy i zakresy elementów do pobrania. Musisz ustawić dokładnie 1 pole. filtering_option może mieć tylko jedną z tych wartości:
parentEntityFilter

object (ParentEntityFilter)

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

object (IdFilter)

Filtruje elementy według ich identyfikatorów.
inventorySourceFilter

object (InventorySourceFilter)

Filtruje źródła zasobów reklamowych według ich identyfikatorów.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała nowo utworzoną instancję Operation.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.

ParentEntityFilter

Opcja filtrowania, która filtruje wybrane typy plików należące do wybranego zestawu jednostek 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 encji do pobrania. Jeśli typ filtra nie jest równy 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 jest nieokreślony lub nieznany w tej wersji.
FILE_TYPE_CAMPAIGN Kampania.
FILE_TYPE_MEDIA_PRODUCT Produkt medialny.
FILE_TYPE_INSERTION_ORDER Zamówienie reklamowe.
FILE_TYPE_LINE_ITEM Element zamówienia.
FILE_TYPE_AD_GROUP Grupa reklam w YouTube.
FILE_TYPE_AD Reklama w YouTube.
FILE_TYPE_LINE_ITEM_QA Element zamówienia – format kontroli jakości.
FILE_TYPE_AD_GROUP_QA Grupa reklam w 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 jest nieokreślony lub nieznany w tej wersji.
FILTER_TYPE_NONE Jeśli wybierzesz tę opcję, do pobierania nie zostanie zastosowany żaden filtr. Można jej użyć tylko wtedy, gdy w CreateSdfDownloadTaskRequest określono Advertiser.
FILTER_TYPE_ADVERTISER_ID Identyfikator reklamodawcy. Jeśli ta opcja jest zaznaczona, wszystkie identyfikatory filtrów muszą być identyfikatorami reklamodawców należącymi do Partner określonego w CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID Identyfikator kampanii. Jeśli ta opcja jest zaznaczona, wszystkie identyfikatory filtrów muszą być identyfikatorami kampanii należącymi do Advertiser lub Partner określonych w zasadzie CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Identyfikator produktu medialnego. Jeśli ta opcja jest zaznaczona, wszystkie identyfikatory filtrów muszą być identyfikatorami produktów medialnych należących do Advertiser lub Partner określonych w zasadzie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania FILE_TYPE_MEDIA_PRODUCT.
FILTER_TYPE_INSERTION_ORDER_ID Identyfikator zamówienia reklamowego. Jeśli ta opcja jest zaznaczona, wszystkie identyfikatory filtrów muszą być identyfikatorami zamówień reklamowych należących do Advertiser lub Partner określonych w zasadzie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania 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 ta opcja jest zaznaczona, wszystkie identyfikatory filtrów muszą być identyfikatorami elementów zamówienia należących do Advertiser lub Partner określonych w CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania 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 elementy 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 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 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 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 Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

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

string (int64 format)

Reklamy w YouTube do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tego samego 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 Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

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

InventorySourceFilter

Opcja filtrowania umożliwiająca filtrowanie pod kątem podmiotów Źródło 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 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.