Method: sdfdownloadtasks.create

Tạo một Lệnh tải xuống SDF. Trả về một Operation.

SDF Download Task là một thao tác không đồng bộ, chạy trong thời gian dài. Loại metadata của thao tác này là SdfDownloadTaskMetadata. Nếu yêu cầu thành công, loại thao tác response sẽ là SdfDownloadTask. Phản hồi sẽ không bao gồm các tệp tải xuống. Bạn phải truy xuất các tệp này bằng media.download.

Bạn có thể truy xuất trạng thái của thao tác bằng sdfdownloadtasks.operations.get.

Bạn có thể tìm thấy mọi lỗi trong error.message. Xin lưu ý rằng error.details dự kiến sẽ trống.

Yêu cầu HTTP

POST https://displayvideo.googleapis.com/v4/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 với cấu trúc sau:

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

enum (SdfVersion)

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

string (int64 format)

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

string (int64 format)

Mã nhận dạng của nhà quảng cáo để tải SDF xuống.
Kết thúc các trường loại trừ lẫn nhau.
Bắt buộc. Các lựa chọn chỉ định loại thực thể và phạm vi cần tải xuống. Bạn phải đặt đúng một trường. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
parentEntityFilter

object (ParentEntityFilter)

Lọc theo 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 thực thể bộ lọc đã chọn. Các thực thể bộ lọc phải thuộc cùng loại hoặc thuộc loại gốc 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 Nguồn dữ liệu kho hàng theo mã nhận dạng.
Kết thúc các trường loại trừ lẫn nhau.

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 uỷ quyền

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 OAuth 2.0 Overview.

ParentEntityFilter

Một lựa chọn lọc để lọc theo các loại tệp đã chọn thuộc một nhóm 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. Cá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ể được tìm nạp.
filterIds[]

string (int64 format)

Mã nhận dạng của loại bộ lọc được chỉ định. Tham số này 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.

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 nghe nhìn.
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.
FILE_TYPE_LINE_ITEM_QA Mục hàng – Định dạng QA.
FILE_TYPE_AD_GROUP_QA Nhóm quảng cáo trên YouTube – Định dạng QA.

FilterType

Các loại có thể lọ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 bạn chọn chế độ này, thì sẽ không có bộ lọc nào được áp dụng cho nội dung tải xuống. Chỉ có thể dùng nếu bạn chỉ định một Advertiser 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ã nhận dạng bộ lọc phải là Mã nhận dạng 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 của 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_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA 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 về Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest. Chỉ có thể dùng để tải FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA và FILE_TYPE_AD xuống.

IdFilter

Một lựa chọn lọc giúp 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
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    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)

Các sản phẩm nghe nhìn có thể 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)

Các 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 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.
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.
lineItemQaIds[]

string (int64 format)

Không bắt buộc. Mục hàng, theo mã nhận dạng, để tải xuống ở định dạng QA. 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.
adGroupQaIds[]

string (int64 format)

Không bắt buộc. Nhóm quảng cáo trên YouTube, theo mã nhận dạng, để tải xuống ở định dạng QA. 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.