Sử dụng Early Ad Break Notification API
- Giá trị nhận dạng của luồng phát trực tiếp tương ứng mà bạn đang tạo điểm chèn quảng cáo. Giá trị nhận dạng này có thể là một trong những giá trị sau:
- "Khoá thành phần" của sự kiện phát trực tiếp.
- "Khoá thành phần tuỳ chỉnh" của sự kiện phát trực tiếp cho phép bạn quản lý không gian khoá của riêng mình bằng cách chỉ định chuỗi giá trị nhận dạng của riêng bạn.
- "Mã nguồn nội dung" và "Mã nội dung" của sự kiện phát trực tiếp.
Lưu ý: Bạn phải được cấp quyền sử dụng loại giá trị nhận dạng này. Để biết thêm thông tin, hãy liên hệ với người quản lý tài khoản của bạn.
- Thời lượng dự kiến của điểm chèn quảng cáo tiếp theo. Thời lượng cần gần với thời lượng thực tế của điểm chèn quảng cáo nhất có thể.
Ngoài các trường bắt buộc này, bạn cũng có thể gửi các thông số nhắm mục tiêu tuỳ chỉnh, tên của mẫu nhóm quảng cáo cần áp dụng hoặc dữ liệu Cue Out theo chuẩn SCTE35 (nếu có).
Điều kiện tiên quyết
Để sử dụng API EABN, bạn phải tạo một tài khoản dịch vụ và thêm tài khoản đó vào mạng Google Ad Manager.
Tạo một tài khoản dịch vụ
Để tạo tài khoản dịch vụ gọi API EABN, hãy hoàn tất các bước sau: – Nếu bạn có tài khoản Google Cloud, hãy sử dụng mô-đun IAM để tạo tài khoản dịch vụ. Để biết thêm thông tin, hãy xem bài viết Tạo và quản lý tài khoản dịch vụ. – Nếu bạn không có tài khoản Google Cloud, hãy hoàn tất các bước sau để tạo tài khoản trong Bảng điều khiển API của Google:
- Tạo dự án mới hoặc chọn dự án hiện có.
- Trên trang Thông tin xác thực, hãy nhấp vào Quản lý tài khoản dịch vụ.
- Trên trang Tài khoản dịch vụ, hãy nhấp vào TẠO TÀI KHOẢN DỊCH VỤ.
- Trên trang Tạo tài khoản dịch vụ, hãy nhập thông tin tài khoản. Sau đó, hãy nhấp vào TẠO.
Sau khi tạo tài khoản dịch vụ, hãy sao chép khoá JSON của tài khoản dùng để xác thực.
Thêm tài khoản dịch vụ vào mạng Google Ad Manager
Để thêm tài khoản dịch vụ vào mạng, hãy hoàn tất các bước trong bài viết Thêm người dùng tài khoản dịch vụ để truy cập API.
Bật API
Sau khi bạn tạo tài khoản dịch vụ, hãy cung cấp cho người quản lý tài khoản của bạn những thông tin sau để bật API cho tài khoản của bạn:
- Địa chỉ email của Tài khoản Google Cloud
- Tài khoản dịch vụ của bạn
- Mã mạng của Mạng Google Ad Manager.
Sau khi người quản lý tài khoản bật API, hãy hoàn tất các bước sau để bật API:
- Trong thư viện API của Google, hãy tìm "API Video Google Ad Manager".
- Nhấp vào BẬT.
Lưu ý: Nếu API không xuất hiện trong kết quả tìm kiếm, hãy liên hệ với người quản lý tài khoản của bạn để xác nhận rằng tài khoản của bạn đã được bật API DAI.
Sử dụng API
Bạn có thể gọi API EABN bằng các yêu cầu JSON/REST.
Ủy quyền
Để thực hiện các lệnh gọi được uỷ quyền đến API EABN, bạn cần tạo thông tin xác thực tài khoản dịch vụ OAuth2 bằng khoá JSON từ tài khoản dịch vụ và phạm vi https://www.googleapis.com/auth/video-ads
. Để biết thêm thông tin, hãy xem bài viết Sử dụng OAuth 2.0 cho ứng dụng từ máy chủ đến máy chủ.
Bạn phải thêm mã uỷ quyền thu được dưới dạng tiêu đề Auth cho mỗi lệnh gọi đến API EABN.
Gửi thông báo chèn quảng cáo sớm
Để gửi thông báo về điểm chèn quảng cáo sớm, hãy gửi một yêu cầu POST đến một trong ba URL EABN hợp lệ, tuỳ thuộc vào cách bạn muốn chỉ định sự kiện phát trực tiếp. Các phần sau đây giải thích sự khác biệt giữa các URL và cung cấp ví dụ về yêu cầu và phản hồi.
URL
Có 3 URL hợp lệ để gửi thông báo chèn quảng cáo sớm. Bạn có thể sử dụng cả 3 loại để tạo điểm chèn quảng cáo (POST
) hoặc lấy danh sách điểm chèn quảng cáo được chỉ định (GET
).
Để sử dụng khoá tài sản của sự kiện phát trực tiếp, hãy sử dụng:
POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks
Để sử dụng khoá thành phần tuỳ chỉnh của sự kiện phát trực tiếp, hãy sử dụng:
POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks
Để sử dụng Mã nguồn nội dung và phương pháp Content ID, hãy sử dụng:
POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks
Đối với tất cả các tham số:
network_code
đại diện cho mã mạng của mạng Google Ad Manager.asset_key
đại diện cho khoá thành phần xuất hiện trong trang chi tiết về sự kiện phát trực tiếp.custom_asset_key
đại diện cho khoá thành phần tuỳ chỉnh của sự kiện phát trực tiếp.content_source_id
biểu thị mã nhận dạng của một nguồn nội dung trong Google Ad Manager.content_id
đại diện cho mã nhận dạng của một nội dung trong Google Ad Manager.
Lưu ý: Bạn phải liên kết cặp content_source_id
/content_id
đã chỉ định với một luồng phát trực tiếp trong Google Ad Manager.
Nội dung yêu cầu – chỉ dùng để tạo Điểm chèn quảng cáo (POST)
Đối tượng | ||
---|---|---|
| Bắt buộc | Thời lượng của điểm chèn quảng cáo này, sử dụng định dạng thời lượng chuẩn của Google (xx.xxx giây, trong đó xx.xxx là số giây) |
| Không bắt buộc | Cặp khoá-giá trị cần được đưa vào yêu cầu quảng cáo cho điểm chèn này để nhắm mục tiêu theo tiêu chí tuỳ chỉnh trong AM360, được phân tách bằng
và có sự tham gia của
.
|
| Không bắt buộc | Tên mẫu nhóm quảng cáo |
| Không bắt buộc | Dữ liệu được mã hoá định dạng base-64 từ điểm cue out scte35. Có thể bao gồm
hoặc
lệnh.
|
Yêu cầu mẫu
Tạo điểm chèn quảng cáo
POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
"expectedDuration": "30s",
"scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
"customParams": "param1=value1¶m2=value2",
"podTemplateName": "podtemplate"
}
Nội dung phản hồi
Phần nội dung phản hồi chứa tất cả các thông số được gửi trong đối tượng adBreak
, cũng như một trường name
bổ sung chứa mã nhận dạng chuẩn trên toàn Google của điểm chèn quảng cáo đã tạo. Trường này được trả về theo định dạng sau:
networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}
Ví dụ về phản hồi
HTTP/1.1 200 OK
{
"name": "networks/.../assets/.../adBreaks/1",
"expectedDuration": "30s",
"scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
"customParams": "param1=value1¶m2=value2",
"podTemplateName": "podtemplate"
}
Liệt kê các Điểm chèn quảng cáo được chỉ định
GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
Nội dung phản hồi
Phần nội dung phản hồi chứa các điểm chèn quảng cáo cùng với trường breakState
bổ sung cho mỗi điểm chèn quảng cáo được chỉ định cho luồng. Trường breakState
hỗ trợ các giá trị sau:
// Ad break decisioning has started.
BREAK_STATE_DECISIONED
// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE
Ví dụ về phản hồi
HTTP/1.1 200 OK
{
"name": "networks/.../assets/.../adBreaks/1",
"expectedDuration": "30s",
"breakState": "BREAK_STATE_COMPLETE"
}