Method: sdfdownloadtasks.create

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

Zadanie pobierania SDF to długotrwała operacja asynchroniczna. Typ operacji metadata to SdfDownloadTaskMetadata. Jeśli żądanie zostało wykonane, operacja response ma typ 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 można znaleźć w error.message. Wartość atrybutu error.details powinna być pusta.

Żądanie HTTP

POST https://displayvideo.googleapis.com/v4/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 ustawisz wartość SDF_VERSION_UNSPECIFIED, domyślnie zostanie wybrana wersja określona przez reklamodawcę lub partnera z identyfikatorem root_id. Reklamodawca dziedziczy wersję SDF od swojego partnera, chyba że skonfigurowano inaczej.
Pole unii root_id. Wymagane. Identyfikator katalogu głównego określa kontekst żądania pobierania. Musisz ustawić dokładnie 1 pole. root_id może być tylko jednym z tych elementów:
partnerId

string (int64 format)

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

string (int64 format)

Identyfikator reklamodawcy, którego dane mają być pobrane w pliku SDF.
Pole unii filtering_option. Wymagane. Opcje określające typy i zakresy elementów do pobrania. Musisz ustawić dokładnie 1 pole. filtering_option może być tylko jednym z tych elementów:
parentEntityFilter

object (ParentEntityFilter)

Filtrowanie według wybranych typów plików. Elementy w każdym pliku są filtrowane przez wybrany zbiór elementów filtra. Elementy filtra muszą być tego samego typu co wybrane typy plików lub typu nadrzędnego.
idFilter

object (IdFilter)

Filtrowanie według identyfikatorów elementów.
inventorySourceFilter

object (InventorySourceFilter)

Filtrowanie źródeł zasobów reklamowych według ich identyfikatorów.

Treść odpowiedzi

Jeśli operacja się powiedzie, 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 OAuth 2.0 Overview.

ParentEntityFilter

Opcja filtrowania według wybranych typów plików należących do wybranego zbioru elementów 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 elementów.
filterIds[]

string (int64 format)

Identyfikatory określonego typu filtra. Służy do filtrowania pobieranych jednostek. Jeśli typ filtra nie jest 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 to pole jest zaznaczone, pobieranie nie będzie podlegać filtrom. Można go użyć tylko wtedy, gdy w sekcji CreateSdfDownloadTaskRequest określono ustawienie 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ślonych w polu 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 multimedialnego. Jeśli ta opcja jest zaznaczona, wszystkie identyfikatory filtrów muszą być identyfikatorami produktów medialnych należącymi do Advertiser lub Partner określonych w 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 wersji 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żącymi do Advertiser lub Partner określonych w elementach zamówienia CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania plików 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 pola 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 pola 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 pola 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 pola 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 pola 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 pola 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 pola Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

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

InventorySourceFilter

Opcja filtrowania według typu zasobu reklamowego.

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 pola Advertiser lub Partner określonego w zasadzie CreateSdfDownloadTaskRequest. Pozostaw puste pole, aby pobrać wszystkie źródła zasobów reklamowych wybranego reklamodawcy lub partnera.