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ả cá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 Các thông số nhắm mục tiêu khác.
Ghi đè thông số luồng Không bắt buộc Ghi đè các giá trị mặc định của thông 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 pháp: 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 được hỗ trợ:

pod/{integer}

Giá trị nhận dạng bằng số cho đ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.
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 được 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ột mã thông báo HMAC đã ký và đượ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

GETadai.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&sd6PD8

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 có thể phát phù hợp với định dạng và các 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/{pod_id}.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/{pod_id}.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_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ố
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 một yêu cầu thành công đến điểm cuối stream trả về.
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

Mã nhận dạng tuỳ chỉnh đã liên kết với sự kiện này trong Google Ad Manager
stream_id string

Mã luồng của 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 của bạn.

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 của phiên của người dùng hiện tại. Giá trị này được một yêu cầu thành công đến điểm cuối stream trả về.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa một đối tượng PodTemplateResponse 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. Những yêu cầu này không cần thiết đối với luồng báo hiệu phía máy chủ, nơi máy chủ bắt đầu quy trình 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 do 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 thời gian 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 của quảng cáo sẽ 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 sẽ trả về thông tin dùng để tạo giao diện người dùng 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ột mã nhận dạng nội dung nghe nhìn của quảng cáo có dạng 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ã 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 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

Giá trị nhận dạng luồng 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ì hoạt động của luồng báo hiệu phía máy chủ, phải được ping mỗi {PollingFrequency} giây một lần. Đượ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ủa các phân khúc thẻ được lập chỉ mục theo tiền tố thẻ.
ads map[string, object(Ad)]

Bản đồ của 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ủa 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ã quảng cáo của thẻ này.
ad_break_id string

Mã đ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.

Điểm chèn quảng cáo

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ã 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à phương tiện chặn.
icons [object(Icon)]

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

Danh sách trình bao bọc, 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> 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 không bắt buộc (SIMID) sẽ hiển thị trong khi phát quảng cáo.

PodTemplateResponse

PodTemplateResponse biểu thị tải trọng JSON được trả về VTP để ghép nhóm.
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à khoảng thời gian của các phân đoạn giai đoạn tính bằng mili giây.

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ề 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ã 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ợ các 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 các sự kiện theo dõi yêu cầu 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 có thể chạy tập lệnh này bên ngoài trình duyệt hay không.

TrackingEvent

TrackingEvent chứa các URL mà ứng dụng sẽ 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 cần được ping.

UniversalAdID

UniversalAdID dùng để cung cấp một 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 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 xuất hiện dưới dạng đoạn mã đồ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ã vị trí cho quảng cáo đồng hành này.
api_framework string

Khung API cho đồ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 kéo dài thời gian hay không.
ad_parameters string

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