- Yêu cầu HTTP
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter (Bộ lọc nguồn khoảng không quảng cáo)
- Hãy làm thử!
Tạo tác vụ tải xuống SDF. Trả về một Operation
.
Tác vụ tải xuống SDF là một hoạt động không đồng bộ và chạy 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 mà 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 ý rằng error.details
dự kiến sẽ trống.
Yêu cầu HTTP
POST https://displayvideo.googleapis.com/v2/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 ( |
Trường | |
---|---|
version |
Bắt buộc. Phiên bản SDF của tệp đã tải xuống. Nếu bạn đặt thành |
Trường 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: |
|
partnerId |
Mã của đối tác để tải SDF xuống. |
advertiserId |
Mã nhận dạng của nhà quảng cáo cần tải SDF xuống. |
Trường 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: |
|
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 với hoặc là loại gốc của loại tệp đã chọn. |
idFilter |
Lọc trên các thực thể theo mã nhận dạng thực thể của chúng. |
inventorySourceFilter |
Lọc trên Nguồn khoảng không quảng cáo theo mã nhận dạng của chú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 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 Tổng quan về OAuth 2.0.
ParentEntityFilter
Một chế độ lọc dùng để 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 ( |
Trường | |
---|---|
fileType[] |
Bắt buộc. Các loại tệp sẽ được trả về. |
filterType |
Bắt buộc. Loại bộ lọc dùng để lọc các thực thể đã tìm nạp. |
filterIds[] |
Mã của loại bộ lọc được chỉ định. Thuộc tính 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à |
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ể có có thể được 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 đượ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ận dạng nhà quảng cáo và thuộc về 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 về Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest . |
FILTER_TYPE_MEDIA_PRODUCT_ID |
Mã sản phẩm đa phương tiện. Nếu được chọn, tất cả các mã bộ lọc phải là mã sản phẩm truyền thông thuộc về Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest . Chỉ có thể sử 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 về Advertiser hoặc Partner được chỉ định trong CreateSdfDownloadTaskRequest . Chỉ có thể sử dụng để tải xuống FILE_TYPE_INSERTION_ORDER , FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP và FILE_TYPE_AD . |
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ể sử dụng để tải xuống FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP và FILE_TYPE_AD . |
IdFilter
Tuỳ chọn lọc 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[] |
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 |
mediaProductIds[] |
Sản phẩm đa phương tiệ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 |
insertionOrderIds[] |
Đơn đặt hà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 |
lineItemIds[] |
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 |
adGroupIds[] |
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 |
adGroupAdIds[] |
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 |
InventorySourceFilter
Tuỳ chọn lọc để lọc theo 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[] |
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 |