Method: sdfdownloadtasks.create

Tạo tác vụ tải xuống SDF. Trả về Operation.

Tác vụ tải xuống SDF là một hoạt động không đồng bộ và diễn ra trong thời gian dài. Loại metadata của toán tử này là SdfDownloadTaskMetadata. Nếu yêu cầu thành công, loại response của thao tác sẽ là SdfDownloadTask. Phản hồi sẽ không bao gồm các tệp tải xuống và phải được truy xuất bằng media.download. Bạn có thể truy xuất trạng thái hoạt động bằng sdfdownloadtask.operations.get.

Bạn có thể xem mọi lỗi trong error.message. Lưu ý error.details dự kiến sẽ trống.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng 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.
}
Trường
version

enum (SdfVersion)

Bắt buộc. Phiên bản SDF của tệp đã tải xuống. Nếu bạn đặt thành SDF_VERSION_UNSPECIFIED, thì giá trị này sẽ mặc định là phiên bản do nhà quảng cáo hoặc đối tác xác định theo root_id. Nhà quảng cáo kế thừa phiên bản SDF từ đối tác của mình trừ phi được định cấu hình khác.
Trường kết hợp root_id. Bắt buộc. Mã nhận dạng gốc xác định ngữ cảnh của yêu cầu tải xuống. Bạn phải đặt đúng một trường. root_id chỉ có thể là một trong những trạng thái sau đây:
partnerId

string (int64 format)

Mã nhận dạng của đối tác cần tải SDF xuống.
advertiserId

string (int64 format)

Mã nhận dạng của nhà quảng cáo cần tải xuống SDF.
Trường kết hợp filtering_option. Bắt buộc. Các tuỳ chọn chỉ định loại thực thể và dải ô cần tải xuống. Bạn phải đặt đúng một trường. filtering_option chỉ có thể là một trong những trạng thái sau đây:
parentEntityFilter

object (ParentEntityFilter)

Bộ lọc trên các loại tệp đã chọn. Các thực thể trong mỗi tệp được lọc theo một nhóm các thực thể bộ lọc đã chọn. Các thực thể bộ lọc phải cùng loại hoặc thuộc loại mẹ của các loại tệp đã chọn.
idFilter

object (IdFilter)

Lọc các thực thể theo mã nhận dạng thực thể.
inventorySourceFilter

object (InventorySourceFilter)

Lọc trên Nguồn khoảng không quảng cáo theo mã nhận dạng.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một thực thể mới tạo của Operation.

Phạm vi cấp phép

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.

ParentEntityFilter

Một tuỳ chọn lọc giúp lọc những loại tệp đã chọn thuộc về một nhóm các thực thể bộ lọc đã chọn.

Biểu diễn dưới dạng JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Trường
fileType[]

enum (FileType)

Bắt buộc. Loại tệp sẽ được trả về.
filterType

enum (FilterType)

Bắt buộc. Loại bộ lọc dùng để lọc các thực thể đã tìm nạp.
filterIds[]

string (int64 format)

Mã của loại bộ lọc được chỉ định. Tham số này được dùng để lọc các thực thể cần tìm nạp. Nếu loại bộ lọc không phải là FILTER_TYPE_NONE, bạn phải chỉ định ít nhất một mã nhận dạng.

FileType

Các loại tệp có thể tải xuống được.

Enum
FILE_TYPE_UNSPECIFIED Giá trị mặc định khi loại không được chỉ định hoặc không xác định trong phiên bản này.
FILE_TYPE_CAMPAIGN Chiến dịch.
FILE_TYPE_MEDIA_PRODUCT Sản phẩm truyền thông.
FILE_TYPE_INSERTION_ORDER Đơn đặt hàng quảng cáo.
FILE_TYPE_LINE_ITEM Mục hàng.
FILE_TYPE_AD_GROUP Nhóm quảng cáo trên YouTube.
FILE_TYPE_AD Quảng cáo trên YouTube.

FilterType

Các loại có thể lọc được.

Enum
FILTER_TYPE_UNSPECIFIED Giá trị mặc định khi loại không được chỉ định hoặc không xác định trong phiên bản này.
FILTER_TYPE_NONE Nếu được chọn, sẽ không có bộ lọc nào được áp dụng cho tệp đã tải xuống. Chỉ có thể sử dụng nếu Advertiser được chỉ định trong CreateSdfDownloadTaskRequest.
FILTER_TYPE_ADVERTISER_ID Mã nhận dạng nhà quảng cáo. Nếu được chọn, tất cả mã bộ lọc phải là Mã nhà quảng cáo thuộc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID Mã chiến dịch. Nếu được chọn, tất cả mã bộ lọc phải là Mã chiến dịch thuộc Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Mã sản phẩm nội dung nghe nhìn. Nếu được chọn, tất cả mã bộ lọc phải là mã sản phẩm đa phương tiện thuộc Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest. Chỉ có thể dùng để tải FILE_TYPE_MEDIA_PRODUCT xuống.
FILTER_TYPE_INSERTION_ORDER_ID Mã đơn đặt hàng quảng cáo. Nếu được chọn, tất cả mã bộ lọc phải là mã đơn đặt hàng quảng cáo thuộc Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest. Chỉ có thể dùng để tải FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP và FILE_TYPE_AD xuống.
FILTER_TYPE_LINE_ITEM_ID Mã mục hàng. Nếu được chọn, tất cả mã bộ lọc phải là Mã mục hàng thuộc Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest. Chỉ có thể dùng để tải FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP và FILE_TYPE_AD xuống.

IdFilter

Một lựa chọn lọc sẽ lọc các thực thể theo mã nhận dạng thực thể.

Biểu diễn dưới dạng JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ]
}
Trường
campaignIds[]

string (int64 format)

Chiến dịch cần tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Sản phẩm đa phương tiện cần tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Đơn đặt hàng quảng cáo cần tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Mục hàng cần tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Nhóm quảng cáo trên YouTube để tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Quảng cáo trên YouTube để tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest.

InventorySourceFilter

Một lựa chọn lọc để lọc các thực thể Nguồn khoảng không quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "inventorySourceIds": [
    string
  ]
}
Trường
inventorySourceIds[]

string (int64 format)

Nguồn khoảng không quảng cáo để tải xuống theo mã nhận dạng. Tất cả mã nhận dạng phải thuộc cùng một Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest. Để trống để tải tất cả Nguồn khoảng không quảng cáo xuống cho Nhà quảng cáo hoặc Đối tác đã chọn.