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

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

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 đố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

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

Tham số truy vấn

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.

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

Tham số truy vấn

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.

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

Tham số truy vấn

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

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

Tham số truy vấn

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.

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.

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

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

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

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

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

Quảng cáo

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

PodTemplateResponse

{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}

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,
}