API trực tiếp phân phát nhóm Chèn quảng cáo động

API Chèn quảng cáo động cho phép bạn yêu cầu và theo dõi các sự kiện phát trực tiếp DAI.

Dịch vụ: dai.google.com

Tất cả URI đều liên quan đến https://dai.google.com.

Phương thức: luồng

Phương thức
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Đăng ký phiên phát trực tiếp phân phát nhóm DAI.

Yêu cầu HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

Tham số đường dẫn

Thông số
network_code string

Mã mạng Google Ad Manager của nhà xuất bản.

custom_asset_key string

Giá trị nhận dạng tuỳ chỉnh liên kết sự kiện này trong Google Ad Manager.

Nội dung yêu cầu

Nội dung yêu cầu thuộc loại application/x-www-form-urlencoded và chứa các tham số sau:

Thông số
Thông số nhắm mục tiêu DFP Không bắt buộc Thông số nhắm mục tiêu bổ sung.
Ghi đè thông số luồng phát Không bắt buộc Ghi đè giá trị mặc định của tham số tạo luồng.
Xác thực HMAC Không bắt buộc Xác thực bằng mã thông báo dựa trên HMAC.

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 đối tượng Stream mới.

Đo lường mở

API DAI chứa thông tin để xác minh tính năng Đo lường mở trong trường Verifications. Trường này chứa một hoặc nhiều phần tử Verification liệt kê các tài nguyên và siêu dữ liệu cần thiết để thực thi mã đo lường của bên thứ ba nhằm xác minh việc phát mẫu quảng cáo. Chỉ hỗ trợ JavaScriptResource. Để biết thêm thông tin, vui lòng xem IAB Tech Lab và thông số kỹ thuật VAST 4.1.

Phương thức: phân đoạn nhóm

Phương thức
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Tạo luồng DAI cho mã sự kiện đã cho.

Yêu cầu HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

Tham số đường dẫn

Thông số
network_code string

Mã mạng Google Ad Manager của nhà xuất bản.

custom_asset_key string

Giá trị nhận dạng tuỳ chỉnh liên kết sự kiện này trong Google Ad Manager.

pod_identifier

Các định dạng sau đây được hỗ trợ:

pod/{integer}

Giá trị nhận dạng dạng số của điểm chèn quảng cáo hiện tại. Mã nhóm quảng cáo được chỉ định tăng dần cho mỗi sự kiện chèn quảng cáo, bắt đầu từ 1.

ad_break_id/{string}

Giá trị nhận dạng chuỗi cho điểm chèn quảng cáo hiện tại. Mã điểm chèn quảng cáo do nhà xuất bản cung cấp không có các quy tắc ràng buộc giống như Mã nhóm quảng cáo. Mọi mã điểm chèn quảng cáo không xác định được cung cấp cho điểm cuối đó sẽ tạo một Điểm chèn quảng cáo mới cho sự kiện phát trực tiếp.

profile_name string

Tên của hồ sơ mã hoá DAI của Google Ad Manager được yêu cầu. Hồ sơ mã hoá phải là một trong các hồ sơ mã hoá đã định cấu hình cho sự kiện đã chọn.

segment_number integer

Chỉ mục của phân khúc được yêu cầu trong nhóm quảng cáo hiện tại, bắt đầu từ 0.
segment_format string

Đuôi tệp liên kết với định dạng phân đoạn được yêu cầu. Các đuôi tệp được chấp nhận là: ts, mp4, vtt, aac, ac3 hoặc eac3.

Tham số truy vấn

Thông số
stream_id bắt buộc string

Mã luồng cho phiên của người dùng hiện tại. Giá trị này được trả về bằng một yêu cầu thành công đến điểm cuối stream.
sd required1 integer

Thời lượng của phân đoạn được yêu cầu, tính bằng mili giây.
so tùy chọn

Độ lệch của phân đoạn được yêu cầu trong nhóm quảng cáo, tính bằng mili giây. Nếu bạn bỏ qua tham số so, tham số này sẽ được tính bằng cách nhân thời lượng phân đoạn với số phân đoạn.
pd bắt buộc2 integer

Thời lượng của nhóm quảng cáo, tính bằng mili giây.
auth-token bắt buộc string

Mã thông báo HMAC đã ký, được mã hoá bằng URL cho nhóm quảng cáo hiện tại.
last tùy chọn boolean

Cho biết phân đoạn cuối cùng trong điểm chèn quảng cáo. Bỏ qua tham số này cho tất cả các phân khúc khác.
scte35 tùy chọn string

Tín hiệu SCTE-35 được mã hoá Base64 cho điểm chèn quảng cáo này.
cust_params tùy chọn string

Tập hợp các cặp khoá-giá trị, dùng để nhắm mục tiêu chiến dịch Ad Manager. Các cặp này phải được biểu thị dưới dạng một chuỗi truy vấn được mã hoá URL.

Ví dụ:
Thông số
  • section = sports
  • trang = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Chú thích chân trang

  1. Bạn không bắt buộc phải sử dụng sd cho các phân đoạn khởi chạy. ↩
  2. Bạn không bắt buộc phải sử dụng pd cho những sự kiện đã bật điểm chèn quảng cáo không có thời lượng. ↩

Ví dụ:

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ là một phân đoạn luồng phát được khớp với định dạng và tham số được chỉ định trong yêu cầu.

Phương thức: Tệp kê khai nhóm HLS

Truy xuất tệp kê khai nhóm quảng cáo HLS của một sự kiện phát trực tiếp đã sẵn sàng để trình phát video của ứng dụng tải và phát.

Phương thức
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API để truy xuất danh sách phát nhiều biến thể HLS cho một nhóm quảng cáo.

Yêu cầu HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

Tham số đường dẫn

Thông số
network_code string

Mã mạng Google Ad Manager của nhà xuất bản.
custom_asset_key string

Giá trị nhận dạng tuỳ chỉnh liên kết sự kiện này trong Google Ad Manager
pod_identifier

Các định dạng sau đây được hỗ trợ:

pod/{integer}

Giá trị nhận dạng dạng số của điểm chèn quảng cáo hiện tại. Mã nhóm quảng cáo được chỉ định tăng dần cho mỗi sự kiện chèn quảng cáo, bắt đầu từ 1.

ad_break_id/{string}

Giá trị nhận dạng chuỗi cho điểm chèn quảng cáo hiện tại. Mã điểm chèn quảng cáo do nhà xuất bản cung cấp không có các quy tắc ràng buộc giống như Mã nhóm quảng cáo. Mọi mã điểm chèn quảng cáo không xác định được cung cấp cho điểm cuối đó sẽ tạo một Điểm chèn quảng cáo mới cho sự kiện phát trực tiếp.

Tham số truy vấn

Thông số
stream_id Bắt buộc string

Mã luồng cho phiên của người dùng hiện tại. Giá trị này được trả về bằng một yêu cầu thành công đến điểm cuối stream.
pd Bắt buộc integer

Thời lượng của nhóm quảng cáo, tính bằng mili giây.
scte35 tùy chọn string

Tín hiệu SCTE-35 được mã hoá Base64 cho điểm chèn quảng cáo này.
cust_params tùy chọn string

Tập hợp các cặp khoá-giá trị, dùng để nhắm mục tiêu chiến dịch Ad Manager. Các cặp này phải được biểu thị dưới dạng một chuỗi truy vấn được mã hoá URL.

Ví dụ:
Thông số
  • section = sports
  • trang = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ là danh sách phát nhiều biến thể HLS.

Phương thức: Tệp kê khai nhóm DASH

Truy xuất tệp kê khai nhóm quảng cáo MPEG-DASH của một luồng phát trực tiếp đã sẵn sàng để trình phát video của ứng dụng tải và phát.

Phương thức
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API để truy xuất danh sách phát mpd MPEG-DASH cho một nhóm quảng cáo.

Yêu cầu HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

Tham số đường dẫn

Thông số
network_code string

Mã mạng Google Ad Manager của nhà xuất bản.
custom_asset_key string

Giá trị nhận dạng tuỳ chỉnh liên kết sự kiện này trong Google Ad Manager
stream_id string

Mã luồng cho phiên của người dùng hiện tại. Giá trị này được trả về bằng một yêu cầu thành công đến điểm cuối stream.
pod_id integer

Giá trị nhận dạng dạng số của điểm chèn quảng cáo hiện tại. Mã nhóm quảng cáo được chỉ định tăng dần cho mỗi sự kiện chèn quảng cáo, bắt đầu từ 1.

Tham số truy vấn

Thông số
pd Bắt buộc integer

Thời lượng của nhóm quảng cáo, tính bằng mili giây.
scte35 tùy chọn string

Tín hiệu SCTE-35 được mã hoá Base64 cho điểm chèn quảng cáo này.
cust_params tùy chọn string

Tập hợp các cặp khoá-giá trị, dùng để nhắm mục tiêu chiến dịch Ad Manager. Các cặp này phải được biểu thị dưới dạng một chuỗi truy vấn được mã hoá URL.

Ví dụ:
Thông số
  • section = sports
  • trang = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ là danh sách phát mpd MPEG-DASH.

Phương thức: Mẫu khoảng thời gian của nhóm DASH

Phương thức
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Yêu cầu mẫu khoảng thời gian DASH từ Google Ad Manager. Mẫu này chứa các macro mà bạn phải điền thông số luồng. Sau khi các macro này được điền sẵn, mẫu sẽ trở thành khoảng thời gian chèn quảng cáo và có thể được ghép vào tệp kê khai DASH.

Yêu cầu HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

Tham số đường dẫn

Thông số
network_code string

Mã mạng Google Ad Manager của nhà xuất bản.

custom_asset_key string

Giá trị nhận dạng tuỳ chỉnh liên kết sự kiện này trong Google Ad Manager.

Tham số truy vấn

Thông số
stream_id bắt buộc string

Mã luồng cho phiên của người dùng hiện tại. Giá trị này được trả về bằng một yêu cầu thành công đến điểm cuối stream.

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 đối tượng PodTemplateResponse mới.

Phương thức: Siêu dữ liệu về thời gian của nhóm quảng cáo

Phương thức
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Truy xuất siêu dữ liệu về thời gian của nhóm quảng cáo.

Yêu cầu HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

Tham số đường dẫn

Thông số
network_code string

Mã mạng Google Ad Manager của nhà xuất bản.

custom_asset_key string

Giá trị nhận dạng tuỳ chỉnh được liên kết với luồng phát trực tiếp này trong Google Ad Manager.

Tham số truy vấn

Thông số
stream_id Bắt buộc string

Mã luồng Ad Manager từ ứng dụng trình phát video của ứng dụng khách.
ad_break_id bắt buộc string

Mã điểm chèn quảng cáo sắp tới.

Mã điểm chèn quảng cáo do máy chủ Stitching hoặc VTP cung cấp và phải khớp với thông báo điểm chèn quảng cáo sớm, yêu cầu siêu dữ liệu về thời gian của nhóm quảng cáo và yêu cầu chuyển hướng phân khúc cho cùng một điểm chèn quảng cáo.

Các hạn chế sau đây áp dụng cho mã điểm chèn quảng cáo tuỳ chỉnh:

  • Phải có từ 1 đến 63 ký tự
  • Chỉ được chứa chữ thường, chữ số và dấu gạch nối.
  • Mã điểm chèn quảng cáo preroll được dành để truy xuất nhóm quảng cáo trước video. Bạn không thể sử dụng mã nhận dạng này để xác định bất kỳ nhóm quảng cáo nào khác.
auth-token bắt buộc string

auth-token được tạo theo cách tương tự như mã thông báo HMAC của quy trình phân phát nhóm pod cơ bản, nhưng được tạo từ các tham số sau:

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout tùy chọn integer

Số mili giây mà DAI có thể chặn yêu cầu này để chờ quyết định quảng cáo. Sử dụng tham số này cho các yêu cầu phải trả về quảng cáo đã điền sẵn trong yêu cầu đầu tiên, chẳng hạn như các khoảng nghỉ quảng cáo trước video.

Nếu hết thời gian chờ, yêu cầu sẽ trả về trạng thái đang chờ xử lý.

Nếu được đưa vào, giá trị thời gian chờ phải nằm trong khoảng từ 1000 đến 15.000 mili giây. Nếu bạn bỏ qua, hệ thống sẽ không trì hoãn phản hồi để chờ quyết định quảng cáo.
final tùy chọn boolean

Đặt thành true để cho DAI biết rằng đây là yêu cầu cuối cùng mà VTP sẵn sàng đưa ra cho nhóm quảng cáo này. Nếu chưa có quyết định quảng cáo (theo thời gian chờ không bắt buộc), DAI sẽ trả về danh sách quảng cáo vĩnh viễn cho yêu cầu này.

Giá trị mặc định là false.

Thông số quyết định quảng cáo
pd tùy chọn integer

Thời lượng của điểm chèn quảng cáo (tính bằng mili giây). Còn được gọi là thời lượng nhóm quảng cáo.

Nếu bạn sử dụng EABN, giá trị pd phải khớp với thời lượng được cung cấp trong thông báo về điểm chèn quảng cáo. Nếu thời lượng không khớp, giá trị EABN sẽ được ưu tiên.

cust_params tùy chọn string

Thông số tuỳ chỉnh để nhắm mục tiêu điểm chèn quảng cáo, như mô tả trong Trung tâm trợ giúp Ad Manager.
scte35 tùy chọn string

Tín hiệu SCTE-35 được mã hoá base64.

Nếu tín hiệu không hợp lệ, một thông báo sẽ được gửi trong tiêu đề HTTP X-Ad-Manager-Dai-Warning của phản hồi và yêu cầu sẽ được gửi mà không có giá trị scte35 không hợp lệ.

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 đối tượng AdPodTimingMetadataResponse mới.

Phương thức: xác minh nội dung nghe nhìn

Sau khi gặp mã nhận dạng nội dung đa phương tiện quảng cáo trong khi phát, hãy gửi ngay yêu cầu bằng cách sử dụng media_verification_url thu được từ điểm cuối luồng ở trên. Các yêu cầu này không cần thiết đối với luồng beacon phía máy chủ, trong đó máy chủ sẽ bắt đầu xác minh nội dung nghe nhìn.

Các yêu cầu đến điểm cuối media verification là idempotent.

Phương thức
media verification GET /{media_verification_url}/{ad_media_id}

Thông báo cho API về một sự kiện xác minh nội dung nghe nhìn.

Yêu cầu HTTP

GET https://{media-verification-url}/{ad-media-id}

Nội dung phản hồi

media verification trả về các phản hồi sau:

  • HTTP/1.1 204 No Content nếu quá trình xác minh nội dung nghe nhìn thành công và tất cả ping đều được gửi.
  • HTTP/1.1 404 Not Found nếu yêu cầu không thể xác minh nội dung nghe nhìn do định dạng URL không chính xác hoặc đã hết hạn.
  • HTTP/1.1 404 Not Found nếu yêu cầu xác minh trước đó cho giấy tờ tuỳ thân này đã thành công.
  • HTTP/1.1 409 Conflict nếu một yêu cầu khác đang gửi ping tại thời điểm này.

Mã nội dung nghe nhìn của quảng cáo

Giá trị nhận dạng nội dung nghe nhìn của quảng cáo sẽ được mã hoá trong một kênh siêu dữ liệu riêng biệt – siêu dữ liệu được tính giờ cho luồng truyền tải HLS hoặc emsg cho tệp mp4. Giá trị nhận dạng nội dung nghe nhìn trong quảng cáo luôn bắt đầu bằng chuỗi google_.

Toàn bộ nội dung văn bản của mục nhập siêu dữ liệu phải được thêm vào URL xác minh quảng cáo trước khi tạo từng yêu cầu xác minh quảng cáo.

Phương thức: siêu dữ liệu

Điểm cuối siêu dữ liệu tại metadata_url trả về thông tin dùng để tạo giao diện người dùng của quảng cáo. Điểm cuối siêu dữ liệu không dùng được cho luồng beacon phía máy chủ, trong đó máy chủ chịu trách nhiệm bắt đầu quy trình xác minh nội dung nghe nhìn quảng cáo.

Phương thức
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Truy xuất thông tin siêu dữ liệu quảng cáo.

Yêu cầu HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Nội dung phản hồi

Nếu thành công, phản hồi sẽ trả về một thực thể của PodMetadata.

Phân tích cú pháp siêu dữ liệu

Siêu dữ liệu có 3 phần riêng biệt: tags, ads và breaks quảng cáo. Điểm truy cập vào dữ liệu là phần tags. Từ đó, hãy lặp lại các thẻ và tìm mục đầu tiên có tên là tiền tố của mã nội dung nghe nhìn quảng cáo có trong luồng video. Ví dụ: bạn có thể có mã nhận dạng nội dung nghe nhìn quảng cáo như sau:

google_1234567890

Sau đó, bạn sẽ thấy một đối tượng thẻ có tên google_12345. Trong trường hợp này, mã nhận dạng này khớp với mã nội dung nghe nhìn quảng cáo. Sau khi tìm thấy đối tượng tiền tố nội dung đa phương tiện quảng cáo chính xác, bạn có thể tra cứu mã nhận dạng quảng cáo, mã nhận dạng điểm chèn quảng cáo và loại sự kiện. Sau đó, mã nhận dạng quảng cáo được dùng để lập chỉ mục đối tượng ads và mã nhận dạng điểm chèn quảng cáo được dùng để lập chỉ mục đối tượng breaks.

Dữ liệu phản hồi

Luồng

Luồng được dùng để hiển thị danh sách tài nguyên cho một luồng mới tạo ở định dạng JSON.
Biểu diễn dưới dạng JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
Trường
stream_id string

Mã nhận dạng luồng trên GAM.
media_verification_url string

URL xác minh nội dung nghe nhìn được dùng làm điểm cuối cơ sở để theo dõi các sự kiện phát.
metadata_url string

URL siêu dữ liệu dùng để thăm dò ý kiến về thông tin định kỳ về các sự kiện quảng cáo phát trực tiếp sắp tới.
session_update_url string

URL cập nhật của phiên dùng để cập nhật các thông số nhắm mục tiêu cho luồng này. Giá trị ban đầu của các tham số nhắm mục tiêu được ghi lại trong yêu cầu tạo luồng ban đầu.
heartbeat_url string

URL nhịp tim, dùng để duy trì luồng báo hiệu phía máy chủ, phải được ping mỗi {PollingFrequency} giây. Được điền sẵn cho các luồng báo hiệu phía máy chủ.
polling_frequency number

Tần suất thăm dò, tính bằng giây, khi yêu cầu metadata_url hoặc heartbeat_url.
pod_manifest_url string

Mẫu URL tệp kê khai nhóm được dùng để tạo URL truy xuất tệp kê khai nhóm của luồng, tương ứng với URL của danh sách phát nhiều biến thể trong HLS hoặc MPD trong DASH. Được điền sẵn cho các sự kiện Trực tiếp thuộc loại Chèn quảng cáo động POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

Định dạng tệp kê khai là định dạng của tệp kê khai được truy xuất từ pod_manifest_url, dash hoặc hls.

PodMetadata

PodMetadata chứa thông tin siêu dữ liệu về quảng cáo, điểm chèn quảng cáo và thẻ mã nhận dạng nội dung nghe nhìn.
Biểu diễn dưới dạng JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
Trường
tags map[string, object(TagSegment)]

Bản đồ các phân đoạn thẻ được lập chỉ mục theo tiền tố thẻ.
ads map[string, object(Ad)]

Bản đồ quảng cáo được lập chỉ mục theo mã quảng cáo.
ad_breaks map[string, object(AdBreak)]

Bản đồ các điểm chèn quảng cáo được lập chỉ mục theo mã điểm chèn quảng cáo.

TagSegment

TagSegment chứa thông tin tham chiếu đến một quảng cáo, điểm chèn quảng cáo và loại sự kiện. Không được ping TagSegment có type="progress" đến điểm cuối xác minh nội dung nghe nhìn quảng cáo.
Biểu diễn dưới dạng JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Trường
ad string

Mã nhận dạng của quảng cáo của thẻ này.
ad_break_id string

Mã của điểm chèn quảng cáo của thẻ này.
type string

Loại sự kiện của thẻ này.

AdBreak

AdBreak mô tả một điểm chèn quảng cáo trong luồng. Thẻ này chứa thời lượng, loại (giữa/trước/sau) và số lượng quảng cáo.
Biểu diễn dưới dạng JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Trường
type string

Các loại điểm chèn quảng cáo hợp lệ là: trước, giữa và sau.
duration number

Tổng thời lượng quảng cáo cho điểm chèn quảng cáo này, tính bằng giây.
expected_duration number

Thời lượng dự kiến của điểm chèn quảng cáo (tính bằng giây), bao gồm tất cả quảng cáo và bất kỳ bảng thông tin nào.
ads number

Số lượng quảng cáo trong điểm chèn quảng cáo.
Quảng cáo mô tả một quảng cáo trong sự kiện phát trực tiếp.
Biểu diễn dưới dạng JSON
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Trường
ad_break_id string

Mã của điểm chèn quảng cáo của quảng cáo này.
position number

Vị trí của quảng cáo này trong điểm chèn quảng cáo, bắt đầu từ 1.
duration number

Thời lượng của quảng cáo, tính bằng giây.
title string

Tiêu đề không bắt buộc của quảng cáo.
description string

Nội dung mô tả không bắt buộc của quảng cáo.
advertiser string

Mã nhận dạng nhà quảng cáo (không bắt buộc).
ad_system string

Hệ thống quảng cáo không bắt buộc.
ad_id string

Mã nhận dạng cho quảng cáo (không bắt buộc).
creative_id string

Mã mẫu quảng cáo (không bắt buộc).
creative_ad_id string

Mã quảng cáo của mẫu quảng cáo (không bắt buộc).
deal_id string

Mã giao dịch (không bắt buộc).
clickthrough_url string

URL của trang đích khi nhấp (không bắt buộc).
click_tracking_urls string

URL theo dõi lượt nhấp (không bắt buộc).
verifications [object(Verification)]

Mục xác minh Đo lường mở (không bắt buộc) liệt kê các tài nguyên và siêu dữ liệu cần thiết để thực thi mã đo lường của bên thứ ba nhằm xác minh việc phát mẫu quảng cáo.
slate boolean

Bool không bắt buộc cho biết mục nhập hiện tại là slate.
icons [object(Icon)]

Danh sách biểu tượng, bị bỏ qua nếu trống.
wrappers [object(Wrapper)]

Danh sách các Trình bao bọc, bị bỏ qua nếu trống.
universal_ad_id object(UniversalAdID)

Mã nhận dạng cho quảng cáo chung (không bắt buộc).
extensions string

Danh sách không bắt buộc gồm tất cả các nút <Extension> (Tiện ích) trong VAST.
companions [object(Companion)]

Quảng cáo đồng hành không bắt buộc có thể xuất hiện cùng với quảng cáo này.
interactive_file object(InteractiveFile)

Mẫu quảng cáo tương tác (SIMID) không bắt buộc sẽ hiển thị trong khi phát quảng cáo.

PodTemplateResponse

PodTemplateResponse đại diện cho tải trọng JSON được trả về cho VTP để nối các pod.
Biểu diễn dưới dạng JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
Trường
dash_period_template string

DashPeriodTemplate là mẫu xml cho khoảng thời gian cần được điền dữ liệu thích hợp trước khi nối.
segment_duration_ms int64

SegmentDurationMS là thời lượng của các phân đoạn thời gian tính bằng mili giây.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse chứa thông tin về Nhóm quảng cáo và cách tạo URL phân đoạn cho nhóm quảng cáo đó.
Biểu diễn dưới dạng JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
Trường
status string

Trạng thái quyết định cho nhóm quảng cáo.
ads [object(AdRendering)]

Mảng các đối tượng Quảng cáo mô tả cách hiển thị URL của phân khúc quảng cáo, được lập chỉ mục bắt đầu từ 0.
slate object(SlateRendering)

Bảng thông tin mô tả cách hiển thị URL của phân đoạn bảng thông tin.
dash_representations map[string, object(DASHRepresentation)]

Danh sách nội dung trình bày DASH cho nhóm quảng cáo đó sẽ được hiển thị trong tệp kê khai DASH.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

Danh sách các nhóm điều chỉnh DASH để nhóm quảng cáo đó hiển thị trong tệp kê khai DASH.

AdRendering

AdRendering mô tả cách hiển thị quảng cáo đã được quyết định.
Biểu diễn dưới dạng JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Trường
duration_ms number

Thời lượng của quảng cáo, tính bằng mili giây (int).
variants map[string, object(VariantRendering)]

Bộ từ điển của các đối tượng Biến thể (xem bên dưới), được lập chỉ mục theo mã biến thể/hồ sơ, như được định cấu hình từ giao diện người dùng.

SlateRendering

SlateRendering mô tả cách kết xuất nội dung trên bảng thông tin.
Biểu diễn dưới dạng JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
Trường
duration_ms number

Thời lượng của dòng giới thiệu, tính bằng mili giây (int).
variants map[string, object(VariantRendering)]

Bộ từ điển của các đối tượng Biến thể, được lập chỉ mục theo mã biến thể/hồ sơ. Thời lượng của danh sách phải lặp lại cho đến khi đạt đến độ dài danh sách cần thiết, chèn các điểm ngắt HLS giữa các lần lặp lại hoặc lặp lại các khoảng thời gian mới cho MPEG-DASH.

VariantRendering

VariantRendering mô tả một biến thể/hồ sơ trong quảng cáo/lịch phát sóng.
Biểu diễn dưới dạng JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
Trường
segment_extension string

Chuỗi, một trong các loại sau: ts, mp4, aac, ac3, ec3, m4a, m4v. Phần đuôi tệp của URL phân khúc.
segment_durations object(SegmentDurations)

Các đối tượng SegmentDurations. Bạn có thể dịch thời lượng của mỗi phân đoạn thành một URL phân đoạn.

SegmentDurations

SegmentDurations mô tả thời lượng của một chuỗi các phân đoạn, theo một đơn vị thời gian cụ thể.
Biểu diễn dưới dạng JSON
{
  "timescale": number,
  "values": [],
}
Trường
timescale number

Tỷ lệ thời gian là số đơn vị trên giây (int) Dự kiến là: 1000 đối với HLS (mili giây) 90000 đối với video DASH (PTS) Tốc độ lấy mẫu âm thanh đối với âm thanh DASH.
values number

Mảng các thời lượng phân đoạn int, tính bằng đơn vị tiến trình.

DASHRepresentation

DASHRepresentation mô tả các nút Representation (Đại diện) sẽ được hiển thị trong tệp kê khai DASH.
Biểu diễn dưới dạng JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
Trường
codecs string

Bộ mã hoá và giải mã của nội dung trình bày.
bandwidth number

Băng thông của bản trình bày.
width number

Chiều rộng của bản trình bày.
height number

Chiều cao của bản trình bày.
frame_rate string

Tốc độ khung hình của bản trình bày.
audio_sampling_rate number

Tốc độ lấy mẫu âm thanh của nội dung trình bày.
audio_channel_config object(SchemeIDURIAndValue)

Cấu hình kênh âm thanh của nội dung trình bày.

DASHAdaptationSet

DASHAdaptationSet mô tả các nút AdaptationSet sẽ được hiển thị trong tệp kê khai DASH.
Biểu diễn dưới dạng JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
Trường
content_type string

Loại nội dung của bộ nội dung điều chỉnh.
mime_type string

Loại MIME của nhóm nội dung điều chỉnh.
role object(SchemeIDURIAndValue)

Vai trò của bộ điều chỉnh.
inband_event_stream object(SchemeIDURIAndValue)

Luồng sự kiện trong băng thông của nhóm điều chỉnh.
min_frame_rate string

Tốc độ khung hình tối thiểu của nhóm điều chỉnh.
max_frame_rate string

Tốc độ khung hình tối đa của nhóm điều chỉnh.
scan_type string

Loại quét của nhóm điều chỉnh.
start_with_sap string

Bắt đầu với SAP của nhóm điều chỉnh.
segment_alignment boolean

Căn chỉnh phân đoạn của bộ điều chỉnh.
representations string

Biểu thị bộ điều chỉnh.

SchemeIDURIAndValue

SchemeIDURIAndValue là một cặp mã nhận dạng giao thức và giá trị của mã nhận dạng đó.
Biểu diễn dưới dạng JSON
{
  "scheme_id_uri": string,
  "value": string,
}
Trường
scheme_id_uri string

URI mã nhận dạng giao thức của giá trị.
value string

Giá trị của URI mã nhận dạng giao thức.

Biểu tượng

Biểu tượng chứa thông tin về Biểu tượng VAST.
Biểu diễn dưới dạng JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
Trường
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

ClickData chứa thông tin về một lượt nhấp vào biểu tượng.
Biểu diễn dưới dạng JSON
{
  "url": string,
}
Trường
url string

FallbackImage

FallbackImage chứa thông tin về hình ảnh dự phòng VAST.
Biểu diễn dưới dạng JSON
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Trường
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

Trình bao bọc chứa thông tin về quảng cáo trình bao bọc. Mã này không bao gồm mã giao dịch nếu không có.
Biểu diễn dưới dạng JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Trường
system string

Mã nhận dạng hệ thống quảng cáo.
ad_id string

Mã nhận dạng cho quảng cáo dùng cho quảng cáo trình bao bọc.
creative_id string

Mã mẫu quảng cáo dùng cho quảng cáo trình bao bọc.
creative_ad_id string

Mã quảng cáo mẫu quảng cáo dùng cho quảng cáo trình bao bọc.
deal_id string

Mã giao dịch không bắt buộc cho quảng cáo trình bao bọc.

Xác minh

Quy trình xác minh chứa thông tin cho tính năng Đo lường mở, giúp hỗ trợ đo lường khả năng xem và xác minh của bên thứ ba. Hiện tại, chúng tôi chỉ hỗ trợ tài nguyên JavaScript. Xem https://iabtechlab.com/standards/open-measurement-sdk/
Biểu diễn dưới dạng JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Trường
vendor string

Nhà cung cấp dịch vụ xác minh.
java_script_resources [object(JavaScriptResource)]

Danh sách tài nguyên JavaScript để xác minh.
tracking_events [object(TrackingEvent)]

Danh sách sự kiện theo dõi cho quy trình xác minh.
parameters string

Một chuỗi mờ được truyền đến mã xác minh khởi động.

JavaScriptResource

JavaScriptResource chứa thông tin để xác minh thông qua JavaScript.
Biểu diễn dưới dạng JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Trường
script_url string

URI đến tải trọng javascript.
api_framework string

APIFramework là tên của khung video thực thi mã xác minh.
browser_optional boolean

Liệu tập lệnh này có thể chạy bên ngoài trình duyệt hay không.

TrackingEvent

TrackingEvent chứa các URL mà ứng dụng phải ping trong một số trường hợp.
Biểu diễn dưới dạng JSON
{
  "event": string,
  "uri": string,
}
Trường
event string

Loại sự kiện theo dõi.
uri string

Sự kiện theo dõi sẽ được ping.

UniversalAdID

UniversalAdID được dùng để cung cấp giá trị nhận dạng mẫu quảng cáo duy nhất được duy trì trên các hệ thống quảng cáo.
Biểu diễn dưới dạng JSON
{
  "id_value": string,
  "id_registry": string,
}
Trường
id_value string

Mã quảng cáo chung của mẫu quảng cáo đã chọn cho quảng cáo.
id_registry string

Một chuỗi dùng để xác định URL của trang web đăng ký nơi mã nhận dạng quảng cáo toàn cầu của mẫu quảng cáo đã chọn được lập danh mục.

Companion

Thuộc tính đồng hành chứa thông tin về quảng cáo đồng hành có thể hiển thị cùng với quảng cáo.
Biểu diễn dưới dạng JSON
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
Trường
click_data object(ClickData)

Dữ liệu lượt nhấp cho quảng cáo đồng hành này.
creative_type string

Thuộc tính CreativeType trên nút <StaticResource> trong VAST nếu đây là tệp đồng hành thuộc loại tĩnh.
height int32

Chiều cao tính bằng pixel của thành phần đồng hành này.
width int32

Chiều rộng tính bằng pixel của thành phần đồng hành này.
resource string

Đối với các thành phần đồng hành tĩnh và iframe, đây sẽ là URL cần tải và hiển thị. Đối với quảng cáo đồng hành HTML, đây sẽ là đoạn mã HTML sẽ xuất hiện dưới dạng quảng cáo đồng hành.
type string

Loại của ứng dụng đồng hành này. Đó có thể là nội dung tĩnh, iframe hoặc HTML.
ad_slot_id string

Mã nhận dạng vị trí cho ứng dụng đồng hành này.
api_framework string

Khung API cho ứng dụng đồng hành này.
tracking_events [object(TrackingEvent)]

Danh sách sự kiện theo dõi cho ứng dụng đồng hành này.

InteractiveFile

InteractiveFile chứa thông tin về mẫu quảng cáo tương tác (tức là SIMID) sẽ hiển thị trong khi phát quảng cáo.
Biểu diễn dưới dạng JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Trường
resource string

URL của mẫu quảng cáo tương tác.
type string

Loại MIME của tệp được cung cấp dưới dạng tài nguyên.
variable_duration boolean

Liệu mẫu quảng cáo này có thể yêu cầu gia hạn thời lượng hay không.
ad_parameters string

Giá trị của nút <AdParameters> trong VAST.