Method: sdfdownloadtasks.create

Tworzy zadanie pobierania SDF. Zwraca wartość Operation.

Zadanie pobierania pliku SDF to długo trwająca operacja asynchroniczna. Typ metadata tej operacji to SdfDownloadTaskMetadata. Jeśli żądanie się powiedzie, typ operacji response to SdfDownloadTask. Odpowiedź nie będzie zawierać pobranych plików, które należy pobrać za pomocą media.download. Stan operacji można pobrać za pomocą funkcji sdfdownloadtask.operations.get.

Wszystkie 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)

To pole jest wymagane. Wersja SDF pobranego pliku. Jeśli ma wartość SDF_VERSION_UNSPECIFIED, domyślnie przyjmuje się wersję określoną przez reklamodawcę lub partnera określonego przez root_id. O ile nie zostało skonfigurowane inaczej, reklamodawca dziedziczy wersję SDF od swojego partnera.
Pole sumy root_id. To pole jest 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 ma zostać pobrany plik SDF.
Pole sumy filtering_option. To pole jest wymagane. Opcje określające typy i zakresy encji do pobrania. Musisz ustawić dokładnie 1 pole. filtering_option może mieć tylko jedną z tych wartości:
parentEntityFilter

object (ParentEntityFilter)

Filtry według wybranych typów plików. Elementy w każdym pliku są filtrowane według wybranego zestawu elementów. Elementy filtra muszą być tego samego typu co wybrane typy plików lub być ich typem nadrzędnym.
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 artykule Omówienie protokołu OAuth 2.0.

ParentEntityFilter

Opcja filtrowania, która filtruje według wybranych typów plików należących do wybranego zestawu elementów filtra.

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

enum (FileType)

To pole jest wymagane. Typy plików, które zostaną zwrócone.
filterType

enum (FilterType)

To pole jest wymagane. Typ filtra używany do filtrowania pobranych elementów.
filterIds[]

string (int64 format)

Identyfikatory określonego typu filtra. Służy do filtrowania elementów do pobrania. Jeśli typ filtra jest inny niż 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.

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 pobranych plików nie zostanie zastosowany żaden filtr. Tej opcji można użyć tylko wtedy, gdy w elemencie CreateSdfDownloadTaskRequest określono Advertiser.
FILTER_TYPE_ADVERTISER_ID Identyfikator reklamodawcy. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami reklamodawcy należącymi do identyfikatora Partner określonego w zasadzie CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID Identyfikator kampanii. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami kampanii należącymi do identyfikatora Advertiser lub Partner określonego w polu CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Identyfikator produktu multimedialnego. Jeśli wybierzesz tę opcję, wszystkie identyfikatory filtrów muszą być identyfikatorami produktów multimedialnych należących do Advertiser lub Partner określonego w CreateSdfDownloadTaskRequest. Można go użyć tylko do pobierania pliku 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 należących do Advertiser lub Partner określonego w kolumnie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania plików FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP 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 należące do identyfikatorów Advertiser lub Partner określonych w kolumnie CreateSdfDownloadTaskRequest. Można go używać tylko do pobierania plików FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP 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
  ]
}
Pola
campaignIds[]

string (int64 format)

Kampanie do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Produkty medialne do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Zamówienia reklamowe do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Elementy zamówienia do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Grupy reklam w YouTube do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Reklamy w YouTube do pobrania według identyfikatora. Wszystkie identyfikatory muszą należeć do tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest.

InventorySourceFilter

Opcja filtrowania wg elementów źródła 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 tej samej wartości Advertiser lub Partner określonej w zasadzie CreateSdfDownloadTaskRequest. Pozostaw to pole puste, aby pobrać wszystkie źródła zasobów reklamowych dla wybranego reklamodawcy lub partnera.