API VOD phân phát theo 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 luồng DAI theo yêu cầu.

Dịch vụ: dai.google.com

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

Phương thức: tạo luồng

Phương thức này tạo một luồng trực tiếp từ thiết bị, trả về tất cả tài nguyên cần thiết để ứng dụng khách phát và theo dõi quảng cáo, đồng thời hiển thị các phần tử trên giao diện người dùng.

Phương thức
create stream POST: /ondemand/pods/api/v1/network/{network_code}/stream

Tạo một phiên VOD phân phát nhóm DAI.

Yêu cầu HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/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.

Nội dung yêu cầu

Nội dung yêu cầu thuộc loại application/json và phải chứa một đối tượng CreateStreamRequest.

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 CreateStreamResponse mới.

Phương thức: register stream

Phương thức này đăng ký một luồng trên phụ trợ DAI của Google từ thiết bị, trả về tất cả tài nguyên cần thiết để ứng dụng khách theo dõi quảng cáo và hiển thị các phần tử giao diện người dùng. Không giống như phương thức create stream, phương thức này không trả về tệp kê khai quảng cáo có thể phát. Thay vào đó, thao tác này được thực hiện trong một lệnh gọi máy chủ riêng: decision ad pods.

Phương thức
register stream POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration

Đăng ký một phiên VOD phân phát nhóm DAI.

Yêu cầu HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

Tham số đường dẫn

Thông số
network_code string

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

Nội dung yêu cầu

Nội dung yêu cầu thuộc loại application/json và phải chứa một đối tượng StreamRegistrationRequest.

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 StreamRegistrationResponse mới.

Phương thức: truy xuất nhóm quảng cáo

Phương thức này tuân theo lệnh gọi register stream từ một thiết bị và cần thiết để truy xuất tệp kê khai quảng cáo có thể phát để ghép trong tệp kê khai nội dung.

Phương thức
decision ad pods POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Quyết định nhóm quảng cáo cho một phiên VOD phân phát nhóm DAI.

Yêu cầu HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

Tham số đường dẫn

Thông số
network_code string

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

stream_id string

stream_id nhận được từ lệnh gọi stream_registration.

Nội dung yêu cầu

Nội dung yêu cầu thuộc loại application/json và phải chứa một đối tượng AdPodDecisionRequest.

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 AdPodDecisionResponse mới.

Phương thức: siêu dữ liệu nhóm quảng cáo

Phương thức này trả về tất cả thông tin cần thiết để ứng dụng khách theo dõi quảng cáo và hiển thị chính xác các phần tử thích hợp trên giao diện người dùng.

Phương thức
ad pods metadata GET: /ondemand/pods/api/v1/network/.../metadata

Truy xuất siêu dữ liệu nhóm quảng cáo cho một phiên cụ thể. URL này được trả về trong thuộc tính StreamRegistrationResponse metadata_url.

Yêu cầu HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

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 Ad pods metadata.

Dữ liệu

PodMetadata

PodMetadata chứa thông tin siêu dữ liệu về quảng cáo, chương trình 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)],
  "polling_frequency": number,
}
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 đồ điểm chèn quảng cáo được lập chỉ mục theo mã điểm chèn quảng cáo.
polling_frequency number

Tần suất thăm dò URL siêu dữ liệu được đề xuất (tính bằng giây). Được điền sẵn cho các luồng VOD bằng cách sử dụng tính năng Quyết định theo yêu cầu.

TagSegment

TagSegment chứa thông tin tham chiếu đến một quảng cáo, chương trình quảng cáo và loại sự kiện. Bạn không nên ping TagSegment có type="progress" đến điểm xác minh phương tiệ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 trong thẻ này.
ad_break_id string

Mã của điểm chèn quảng cáo trong 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 duy nhất trong luồng phát. Nó 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 khoảng nghỉ hợp lệ là: pre, mid và post.
duration number

Tổng thời lượng quảng cáo cho khoảng thời gian 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à mọi nội dung chặn.
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 luồng phát.
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 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 về quảng cáo.
advertiser string

Giá trị 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 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)]

Các mục xác minh Đo lường mở không bắt buộc liệt kê những 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 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à bảng tin.
icons [object(Icon)]

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

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

Mã 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)]

Các thành phần đi kèm 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ẽ xuất hiện trong quá trình phát quảng cáo.

MatchOpts

MatchOpts chỉ định các yêu cầu nghiêm ngặt về việc so khớp nội dung nghe nhìn cho một luồng phát.
Biểu diễn dưới dạng JSON
{
  "audio_channels": boolean,
  "audio_sample_rate": boolean,
}
Trường
audio_channels boolean

So khớp các kênh âm thanh giữa nội dung và quảng cáo.
audio_sample_rate boolean

Điều chỉnh tốc độ lấy mẫu âm thanh giữa nội dung và quảng cáo.

CreateStreamRequest

CreateStreamRequest mô tả thông tin có trong các yêu cầu HTTP đến API phân phát nhóm VOD. Luồng tạo được VTP (đối tác công nghệ video) khởi tạo thay cho SDK và nhà xuất bản cho mọi người dùng. Luồng được tạo sẽ dẫn đến các nhóm quảng cáo được quyết định để VTP ghép. Điều này trái ngược với quy trình StreamRegistrationRequest+AdPodDecisionRequest, quy trình này đăng ký một luồng và quyết định adpod trong nhiều yêu cầu.
Biểu diễn dưới dạng JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(CreateStreamOptions),
}
Trường
encoding_profiles [object(EncodingProfile)]

Danh sách hồ sơ mã hoá. Bắt buộc.
ad_tag string

Thẻ quảng cáo cơ sở để đưa ra quyết định. Bắt buộc.
cuepoints number

Danh sách các điểm đánh dấu, tính bằng giây. Bắt buộc khi phản hồi của thẻ quảng cáo sử dụng độ lệch thời gian theo vị trí.
manifest_type string

Các loại tệp kê khai hợp lệ là: hls và dash. Mặc định: hls. Không bắt buộc.
enable_hls_asset_list boolean

Cho biết liệu quảng cáo xen kẽ trong danh sách tài sản HLS có được bật hay không. Khi được bật, DAI sẽ trả về URL danh sách thành phần cho mỗi điểm chèn quảng cáo. Bạn có thể dùng URL này cho quảng cáo xen kẽ HLS.
targeting_parameters string

Các thông số nhắm mục tiêu bổ sung của Ad Manager. Không bắt buộc.
content_duration_seconds number

ContentDurationSeconds là thời lượng của nội dung tính bằng giây. Bắt buộc khi phản hồi của thẻ quảng cáo sử dụng độ lệch thời gian theo phần trăm.
decision_timing_options object(DecisionTimingOptions)

Cho biết thời điểm cần đưa ra quyết định về nhóm quảng cáo.
enable_inline_manifests boolean

Cho biết liệu bản kê khai điểm chèn quảng cáo có được nội tuyến trong phản hồi JSON hay không.
dai_options object(CreateStreamOptions)

DAIOptions để tạo luồng.

CreateStreamOptions

CreateStreamOptions đại diện cho các lựa chọn có trong quy trình tạo luồng một bước.
Biểu diễn dưới dạng JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
  "tracking_mode": string,
  "emsg_version": uint32,
}
Trường
dash_profile string

Hồ sơ MPEG-DASH cần sử dụng, "live" hoặc "on-demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Cho phép nhà xuất bản ghi đè chính sách chia sẻ dữ liệu mặc định của mạng.
sam_id string

sam_id là khoá gỡ lỗi SAM cho phiên, không bắt buộc.
session_title string

session_title là tiêu đề phiên SAM cho luồng truyền phát, không bắt buộc.
dash_inband_event_stream boolean

dash_inband_event_stream cho biết rằng DAI chèn thông báo ID3 dưới dạng sự kiện trong băng tần (trong nội dung nghe nhìn) bằng cách sử dụng phần tử InbandEventStream, thay vì dưới dạng phần tử EventStream (trong tệp kê khai).
distinct_ad_profiles boolean

Nếu được đặt thành true, thì điều này có nghĩa là máy chủ sẽ sử dụng mọi hồ sơ quảng cáo có sẵn tối đa một lần khi so khớp các hồ sơ mã hoá được yêu cầu.
tracking_mode string

tracking_mode là loại hoạt động theo dõi quảng cáo cần dùng cho luồng phát, không bắt buộc. Các giá trị hợp lệ là: "ad_media", "server", "client".
emsg_version uint32

emsg_version buộc sử dụng một phiên bản emsg cụ thể cho ID3 trong nội dung nghe nhìn. Chỉ được hỗ trợ khi dash_inband_event_stream là true.

StreamRegistrationRequest

StreamRegistrationRequest đăng ký một luồng phát từ thiết bị để đưa ra quyết định về nhóm quảng cáo trong tương lai. Điều này trái ngược với CreateStreamRequest, yêu cầu này tạo một luồng và quyết định adpod trong một yêu cầu duy nhất.
Biểu diễn dưới dạng JSON
{
  "targeting_parameters": map[string, string],
  "dai_options": object(StreamRegistrationOptions),
}
Trường
targeting_parameters string

Các thông số nhắm mục tiêu bổ sung của Ad Manager. Không bắt buộc.
dai_options object(StreamRegistrationOptions)

DAIOptions để đăng ký luồng phát.

StreamRegistrationOptions

StreamRegistrationOptions liệt kê các lựa chọn có sẵn để tạo luồng
Biểu diễn dưới dạng JSON
{
  "sam_id": string,
  "tracking_mode": string,
  "emsg_version": uint32,
  "skippable_ads_supported": boolean,
}
Trường
sam_id string

sam_id là khoá gỡ lỗi SAM cho phiên, không bắt buộc.
tracking_mode string

tracking_mode là loại hoạt động theo dõi quảng cáo cần dùng cho luồng phát, không bắt buộc. Các giá trị hợp lệ là: "ad_media", "server", "client".
emsg_version uint32

emsg_version buộc sử dụng một phiên bản emsg cụ thể cho ID3 trong nội dung nghe nhìn. Chỉ được hỗ trợ khi dash_inband_event_stream là true.
skippable_ads_supported boolean

Cho biết liệu quảng cáo có thể bỏ qua có được hỗ trợ hay không.

StreamRegistrationResponse

StreamRegistrationResponse đại diện cho phản hồi json được gửi lại cho ứng dụng khách để phản hồi một StreamRegistrationRequest. Nội dung này bao gồm mã nhận dạng luồng phát và tất cả các URL mà thiết bị sẽ cần. Bạn có thể tham chiếu mã nhận dạng luồng phát trong yêu cầu quyết định về nhóm quảng cáo tiếp theo. Điều này trái ngược với CreateStreamResponse, đại diện cho một phản hồi để tạo luồng và quyết định adpod cùng một lúc.
Biểu diễn dưới dạng JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "valid_for": string,
  "valid_until": string,
  "metadata_url": string,
}
Trường
stream_id string

StreamID là giá trị nhận dạng riêng biệt cho luồng phát hiện tại của người xem này.
media_verification_url string

MediaVerificationURL là tiền tố URL sẽ được dùng trong các yêu cầu xác minh nội dung nghe nhìn quảng cáo như mô tả bên dưới. Không có đối với các luồng báo hiệu phía máy khách.
valid_for string

ValidFor là khoảng thời gian mà luồng này có hiệu lực, theo định dạng "00h00m00s".
valid_until string

ValidUntil là ngày và giờ mà luồng này còn hiệu lực.
metadata_url string

MetadataURL là URL siêu dữ liệu sẽ được dùng để yêu cầu siêu dữ liệu adpod.

DecisionTimingOptions

DecisionTimingOptions mô tả các lựa chọn về thời gian để đưa ra quyết định về thời điểm chèn quảng cáo trong luồng phát.
Biểu diễn dưới dạng JSON
{
  "type": string,
  "on_create_breaks": [],
}
Trường
type string

Loại mô tả thời điểm nhóm quảng cáo được quyết định cho luồng phát. Các loại hợp lệ là: on_create (mặc định), on_demand. Khi loại là on_demand, quảng cáo sẽ được quyết định một cách chậm trễ khi tệp kê khai được yêu cầu cho một điểm chèn quảng cáo cụ thể. Khi loại là on_create, tất cả quảng cáo đều được quyết định khi sự kiện phát trực tiếp được tạo.
on_create_breaks string

OnCreateBreaks là danh sách các breakID VMAP phân biệt chữ hoa chữ thường cần được quyết định khi tạo luồng. Bạn chỉ được phép sử dụng trường này nếu loại là on_demand. Bạn có thể dùng các giá trị nhận dạng điểm chèn quảng cáo đặc biệt "preroll" và "postroll" để cho biết rằng điểm chèn quảng cáo đầu video hoặc cuối video sẽ được quyết định tại thời điểm tạo luồng phát.

EncodingProfile

EncodingProfile mô tả quá trình mã hoá một biến thể nội dung duy nhất. Tệp này có thể chỉ chứa chế độ cài đặt video, chỉ chứa chế độ cài đặt âm thanh (trong trường hợp loại nội dung nghe nhìn), cả chế độ cài đặt video và âm thanh hoặc không chứa chế độ cài đặt nào trong trường hợp phụ đề.
Biểu diễn dưới dạng JSON
{
  "profile_name": string,
  "type": string,
  "container_type": string,
  "video_settings": object(VideoSettings),
  "audio_settings": object(AudioSettings),
  "subtitle_settings": object(SubtitleSettings),
}
Trường
profile_name string

Tên do nhà xuất bản cung cấp cho hồ sơ. Riêng biệt cho mỗi luồng. Bắt buộc.
type string

Các loại hợp lệ là: media, iframe, subtitles. Bắt buộc.
container_type string

Các loại hợp lệ là: mpeg2ts, fmp4cmaf và hls_packed_audio. Bắt buộc đối với Loại phương tiện và iframe.
video_settings object(VideoSettings)

Bạn phải có chế độ cài đặt video nếu loại vùng chứa là iframe. Nếu không, các phần này chỉ xuất hiện nếu hồ sơ có chứa video.
audio_settings object(AudioSettings)

Chế độ cài đặt âm thanh sẽ xuất hiện nếu hồ sơ có chứa âm thanh. Bạn chỉ được phép sử dụng chế độ cài đặt âm thanh nếu loại vùng chứa là nội dung nghe nhìn.
subtitle_settings object(SubtitleSettings)

Bạn phải thiết lập phụ đề cho phụ đề Loại.

VideoSettings

VideoSettings mô tả video của một cấu hình mã hoá. Nếu có một chế độ cài đặt video, thì tất cả các chế độ cài đặt khác cũng phải có.
Biểu diễn dưới dạng JSON
{
  "codec": string,
  "bitrate": int32,
  "frames_per_second": number,
  "resolution": object(Resolution),
}
Trường
codec string

Chuỗi codec RFC6381 của video.
bitrate int32

Tốc độ bit tối đa của video trong hồ sơ mã hoá.
frames_per_second number

Số khung hình/giây của video.
resolution object(Resolution)

Độ phân giải chiều rộng x chiều cao của video.

AudioSettings

AudioSettings mô tả âm thanh của một hồ sơ mã hoá. Nếu có một chế độ cài đặt âm thanh, thì tất cả các chế độ cài đặt âm thanh đều phải có.
Biểu diễn dưới dạng JSON
{
  "codec": string,
  "bitrate": int32,
  "channels": int32,
  "sample_rate": int64,
}
Trường
codec string

Chuỗi codec RFC6381 của âm thanh.
bitrate int32

Tốc độ bit âm thanh tối đa của hồ sơ mã hoá.
channels int32

Số lượng kênh âm thanh (bao gồm cả kênh tần số thấp).
sample_rate int64

Tốc độ lấy mẫu của âm thanh, tính bằng hertz.

SubtitleSettings

SubtitleSettings mô tả phụ đề của một hồ sơ mã hoá.
Biểu diễn dưới dạng JSON
{
  "format": string,
  "language": string,
}
Trường
format string

Định dạng của phụ đề: webvtt cho hls, webvtt hoặc ttml cho dash.
language string

Ngôn ngữ cần chèn vào tệp kê khai.

Độ phân giải

Độ phân giải mô tả chiều rộng x chiều cao của video.
Biểu diễn dưới dạng JSON
{
  "width": int32,
  "height": int32,
}
Trường
width int32

Chiều rộng của video, tính bằng pixel. Bắt buộc.
height int32

Chiều cao của video, tính bằng pixel. Bắt buộc.

AdPodDecisionRequest

AdPodDecisionRequest đại diện cho một yêu cầu quyết định nhóm quảng cáo cho một luồng đã đăng ký trước đó.
Biểu diễn dưới dạng JSON
{
  "encoding_profiles": [object(EncodingProfile)],
  "ad_tag": string,
  "cuepoints": [],
  "manifest_type": string,
  "enable_hls_asset_list": boolean,
  "targeting_parameters": map[string, string],
  "content_duration_seconds": number,
  "decision_timing_options": object(DecisionTimingOptions),
  "enable_inline_manifests": boolean,
  "dai_options": object(AdPodDecisionOptions),
}
Trường
encoding_profiles [object(EncodingProfile)]

Danh sách hồ sơ mã hoá. Bắt buộc.
ad_tag string

Thẻ quảng cáo cơ sở để đưa ra quyết định. Bắt buộc.
cuepoints number

Danh sách các điểm đánh dấu, tính bằng giây. Bắt buộc khi phản hồi của thẻ quảng cáo sử dụng độ lệch thời gian theo vị trí.
manifest_type string

Các loại tệp kê khai hợp lệ là: hls và dash. Mặc định: hls. Không bắt buộc.
enable_hls_asset_list boolean

Cho biết liệu quảng cáo xen kẽ trong danh sách tài sản HLS có được bật hay không. Khi được bật, DAI sẽ trả về URL danh sách thành phần cho mỗi điểm chèn quảng cáo. Bạn có thể dùng URL này cho quảng cáo xen kẽ HLS.
targeting_parameters string

Các thông số nhắm mục tiêu bổ sung của Ad Manager. Không bắt buộc.
content_duration_seconds number

ContentDurationSeconds là thời lượng của nội dung tính bằng giây. Bắt buộc khi phản hồi của thẻ quảng cáo sử dụng độ lệch thời gian theo phần trăm.
decision_timing_options object(DecisionTimingOptions)

Cho biết thời điểm cần đưa ra quyết định về nhóm quảng cáo.
enable_inline_manifests boolean

Cho biết liệu bản kê khai điểm chèn quảng cáo có được nội tuyến trong phản hồi JSON hay không.
dai_options object(AdPodDecisionOptions)

DAIOptions để đưa ra quyết định về nhóm quảng cáo.

AdPodDecisionResponse

AdPodDecisionResponse đại diện cho một phản hồi đối với các nhóm quảng cáo quyết định cho một luồng đã đăng ký trước đó. Tệp này chứa danh sách các nhóm quảng cáo được quyết định cho luồng đó.
Biểu diễn dưới dạng JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
}
Trường
valid_for string

ValidFor là khoảng thời gian mà luồng này có hiệu lực, theo định dạng "00h00m00s".
valid_until string

ValidUntil là ngày và giờ mà luồng này còn hiệu lực.
ad_pods [object(AdPod)]

Danh sách nhóm quảng cáo được sắp xếp theo thứ tự chèn.

CreateStreamResponse

CreateStreamResponse đại diện cho phản hồi json được gửi lại cho ứng dụng khách để phản hồi một CreateStreamRequest.
Biểu diễn dưới dạng JSON
{
  "valid_for": string,
  "valid_until": string,
  "ad_pods": [object(AdPod)],
  "stream_id": string,
  "media_verification_url": string,
  "pod_metadata": object(PodMetadata),
  "metadata_url": string,
}
Trường
valid_for string

ValidFor là khoảng thời gian mà luồng này có hiệu lực, theo định dạng "00h00m00s".
valid_until string

ValidUntil là ngày và giờ mà luồng này còn hiệu lực.
ad_pods [object(AdPod)]

Danh sách nhóm quảng cáo được sắp xếp theo thứ tự chèn.
stream_id string

StreamID là giá trị nhận dạng riêng biệt cho luồng phát hiện tại của người xem này.
media_verification_url string

MediaVerificationURL là tiền tố URL sẽ được dùng trong các yêu cầu xác minh nội dung nghe nhìn quảng cáo như mô tả bên dưới. Không có đối với các luồng báo hiệu phía máy khách.
pod_metadata object(PodMetadata)

PodMetadata chứa thông tin bổ sung cần thiết để hiển thị nhóm trên thiết bị và kích hoạt quy trình xác minh. Như mô tả trong tài liệu về Dynamic Ad Insertion Linear API. Chỉ được đưa vào các luồng báo hiệu phía máy khách.
metadata_url string

MetadataURL là URL siêu dữ liệu sẽ được dùng để yêu cầu siêu dữ liệu adpod.

AdPod

AdPod đại diện cho một điểm chèn quảng cáo đã được quyết định và sẵn sàng phát.
Biểu diễn dưới dạng JSON
{
  "manifest_uris": map[string, string],
  "multivariant_uri": string,
  "mpd_uri": string,
  "manifests": map[string, string],
  "multivariant_manifest": string,
  "mpd_manifest": string,
  "asset_list_uri": string,
  "start": number,
  "duration": number,
  "type": string,
  "midroll_index": number,
}
Trường
manifest_uris string

ManifestURIs là bản đồ tên hồ sơ mã hoá thành manifest_uris biến thể HLS cho nội dung HLS.
multivariant_uri string

MultivariantURI là URI cho tệp kê khai nhiều biến thể của nội dung HLS.
mpd_uri string

MPDURI là URI cho MPD của nội dung DASH.
manifests string

Manifests là một bản đồ tên hồ sơ mã hoá cho tệp kê khai biến thể HLS. Chỉ được điền sẵn nếu luồng có enable_inline_manifests được đặt thành true.
multivariant_manifest string

MultivariantManifest là tệp kê khai nhiều biến thể cho nội dung HLS. Chỉ được điền sẵn nếu luồng có enable_inline_manifests được đặt thành true.
mpd_manifest string

MPDManifest là tệp kê khai MPD cho nội dung DASH. Chỉ được điền sẵn nếu luồng có enable_inline_manifests được đặt thành true.
asset_list_uri string

AssetListURI là URI cho danh sách tài sản quảng cáo xen kẽ HLS đối với nội dung HLS. Chỉ được điền sẵn nếu luồng phát đã bật quảng cáo xen kẽ trong danh sách tài sản HLS.
start number

Thời gian bắt đầu của nhóm quảng cáo trong dòng thời gian của thành phần (không bao gồm các nhóm quảng cáo trước đó) tính bằng giây có dấu phẩy động.
duration number

Thời lượng của nhóm quảng cáo tính bằng giây dưới dạng số thực.
type string

Loại điểm chèn quảng cáo.
midroll_index number

Chỉ mục dựa trên 1 của quảng cáo trong video trong một luồng phát, dựa trên mã điểm chèn VMAP. Bị bỏ qua đối với quảng cáo trước video và quảng cáo sau video.

AdPodDecisionOptions

AdPodDecisionOptions đại diện cho các lựa chọn bổ sung cho luồng phát.
Biểu diễn dưới dạng JSON
{
  "dash_profile": string,
  "match_options": object(MatchOpts),
  "data_sharing_policy_code": string,
  "sam_id": string,
  "session_title": string,
  "dash_inband_event_stream": boolean,
  "distinct_ad_profiles": boolean,
}
Trường
dash_profile string

Hồ sơ MPEG-DASH cần sử dụng, "live" hoặc "on-demand".
match_options object(MatchOpts)

data_sharing_policy_code string

Cho phép nhà xuất bản ghi đè chính sách chia sẻ dữ liệu mặc định của mạng.
sam_id string

sam_id là khoá gỡ lỗi SAM cho phiên, không bắt buộc.
session_title string

session_title là tiêu đề phiên SAM cho luồng truyền phát, không bắt buộc.
dash_inband_event_stream boolean

dash_inband_event_stream cho biết rằng DAI chèn thông báo ID3 dưới dạng sự kiện trong băng tần (trong nội dung nghe nhìn) bằng cách sử dụng phần tử InbandEventStream, thay vì dưới dạng phần tử EventStream (trong tệp kê khai).
distinct_ad_profiles boolean

Nếu được đặt thành true, thì điều này có nghĩa là máy chủ sẽ sử dụng mọi hồ sơ quảng cáo có sẵn tối đa một lần khi so khớp các hồ sơ mã hoá được yêu cầu.

Luồng

Luồng được dùng để hiển thị danh sách tất cả các 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,
  "valid_for": string,
  "valid_until": string,
  "media_verification_url": string,
}
Trường
stream_id string

Mã nhận dạng luồng phát.
valid_for string

Thời lượng phát trực tiếp hợp lệ, theo định dạng "00h00m00s".
valid_until string

Ngày mà luồng có hiệu lực, theo định dạng RFC 3339.
media_verification_url string

URL xác minh nội dung nghe nhìn.

Biểu tượng

Biểu tượng chứa thông tin về một 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 bao bọc. Không bao gồm Mã giao dịch nếu mã này không tồn tại.
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

Giá trị nhận dạng hệ thống quảng cáo.
ad_id string

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

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

Mã quảng cáo của mẫu quảng cáo được dùng cho quảng cáo bao bọc.
deal_id string

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

Xác minh

Xác minh chứa thông tin về chức năng Đo lường mở, giúp đo lường khả năng xem và xác minh của bên thứ ba. Hiện tại, chỉ các tài nguyên JavaScript mới được hỗ trợ. Truy cập 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 để xác minh.
parameters string

Một chuỗi không rõ ràng được truyền để khởi động mã xác minh.

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 cho tải trọng javascript.
api_framework string

APIFramework là tên của khung video thực hiện 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à máy khách sẽ ping trong một số trường hợp nhất định.
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 riêng biệt của mẫu quảng cáo đượ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ã nhận dạng 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 cho trang web đăng ký nơi Mã nhận dạng quảng cáo chung của mẫu quảng cáo đã chọn được lập danh mục.

Companion

Companion chứa thông tin về quảng cáo đi kèm có thể xuất hiện 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 về 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à một quảng cáo đồng hành thuộc loại tĩnh.
height int32

Chiều cao tính bằng pixel của quảng cáo đồng hành này.
width int32

Chiều rộng tính bằng pixel của quảng cáo đồng hành này.
resource string

Đối với các quảng cáo đi kèm tĩnh và quảng cáo đi kèm 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 cần được hiển thị dưới dạng quảng cáo đồng hành.
type string

Loại quảng cáo đồng hành này. Đó có thể là tĩnh, iframe hoặc HTML.
ad_slot_id string

Mã nhận dạng vị trí cho quảng cáo đi kèm này.
api_framework string

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

Danh sách các sự kiện theo dõi cho video đồ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 quá trình 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

Mẫu quảng cáo này có thể yêu cầu kéo dài thời lượng hay không.
ad_parameters string

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