API VOD cho tính năng 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 video theo yêu cầu (VOD) của DAI. Hỗ trợ luồng HLS và DASH.

Dịch vụ: dai.google.com

Đường dẫn của phương thức stream tương ứng với https://dai.google.com

Phương thức: luồng

Yêu cầu HTTP

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

Tiêu đề yêu cầu

Authorization: DCLKDAI key="<api-key>"

Tham số đường dẫn

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:

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 Stream mới. Đối với luồng beacon phía máy chủ, Stream này chỉ chứa các trường stream_id và stream_manifest.

Đo lường mở

Trường Verifications chứa thông tin để xác minh tính năng Đo lường mở cho các luồng không phát đi beacon phía máy chủ. Verifications 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 mà bạn cần để xác minh việc phát mẫu quảng cáo bằng mã đo lường của bên thứ ba. 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: xác minh nội dung nghe nhìn

Sau khi bạn gặp giá trị nhận dạng nội dung nghe nhìn quảng cáo trong khi phát, hãy tạo ngay một yêu cầu bằng cách sử dụng media_verification_url từ điểm cuối stream. media_verification_url là một đường dẫn tuyệt đối. Bạn không cần yêu cầu xác minh nội dung nghe nhìn cho các 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.

Yêu cầu HTTP

GET {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 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 đó đối với 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 quảng cáo (HLS)

Giá trị nhận dạng nội dung nghe nhìn của quảng cáo sẽ được mã hoá trong siêu dữ liệu theo thời gian của HLS bằng khoá TXXX, dành riêng cho các khung "thông tin văn bản do người dùng xác định". Nội dung của khung sẽ không được mã hoá và sẽ luôn bắt đầu bằng văn bản "google_".

Toàn bộ nội dung văn bản của khung phải được thêm vào media_verification_url cho mỗi yêu cầu xác minh quảng cáo.

Mã nội dung nghe nhìn quảng cáo (DASH)

Giá trị nhận dạng nội dung nghe nhìn của quảng cáo sẽ được chèn vào tệp kê khai thông qua việc sử dụng phần tử EventStream của DASH.

Mỗi EventStream sẽ có URI mã nhận dạng giao thức là urn:google:dai:2018. Các tệp này sẽ chứa các sự kiện có thuộc tính messageData chứa mã nhận dạng nội dung nghe nhìn của quảng cáo bắt đầu bằng “google_”. Bạn phải thêm toàn bộ nội dung của thuộc tính messageData vào media_verification_url cho mỗi yêu cầu xác minh quảng cáo.

Dữ liệu phản hồi

Luồng

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

Quảng cáo

{
  "seq": number,
  "start": 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,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

Sự kiện

{
  "time": number,
  "type": string,
}

Phụ đề

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

Biểu tượ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

{
  "url": string,
}

FallbackImage

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

Xác minh

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

Companion

{
  "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)],
}

InteractiveFile

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}