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

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 thông 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 Đo lường mở trong Trường Verifications. Trường này chứa một hoặc nhiều Các phần tử Verification 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 để xác minh việc phát lại mẫu quảng cáo. Chỉ JavaScriptResource được hỗ trợ. Để biết thêm thông tin, vui lòng xem Phòng thí nghiệm công nghệ của IAB và Quy cách 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/{pod_id}/profile/{profile_name}/{segment_number}.{segment_format}

Tham số đường dẫn

Tham số truy vấn

Chú thích chân trang

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

Nội dung phản hồi

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

Phương thức: Mẫu giai đoạn 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, nội dung phản hồi sẽ chứa một Đối tượng PodTemplateResponse.

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

Sau khi gặp giá trị nhận dạng nội dung nghe nhìn của quảng cáo trong khi phát, hãy ngay lập tức yêu cầu bằng media_verification_url có được từ luồng điểm cuối, ở trên. Những yêu cầu này không cần thiết cho tính năng báo hiệu phía máy chủ luồng mà máy chủ 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 không thay đổi giá trị.

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 xác minh nội dung nghe nhìn thành công và tất cả các ping đều đã 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 URL hết hạn.
• HTTP/1.1 404 Not Found nếu trước đó có yêu cầu xác minh 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 đã gửi ping tại địa chỉ này bất cứ lúc nào.

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 — theo thời gian siêu dữ liệu 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 siêu dữ liệu phải được nối vào quảng cáo URL xác minh trước khi thực hiện mỗi 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 quảng cáo Giao diện người dùng. Không dùng được điểm cuối siêu dữ liệu cho các luồng báo hiệu phía máy chủ, nơi 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 phiên bản của PodMetadata.

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

Siêu dữ liệu có ba phần riêng biệt: tags, ads và breaks quảng cáo. Mục nhập trỏ vào dữ liệu là phần tags. Từ đó, hãy lặp lại các thẻ và tìm mục nhập đầu tiên có tên là tiền tố cho mã nhận dạng nội dung nghe nhìn của quảng cáo trong luồng video. Ví dụ: bạn có thể có ID phương tiệ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, URL khớp với id phương tiện quảng cáo. Sau khi tìm thấy đúng đối tượng tiền tố nội dung nghe nhìn quảng cáo, bạn có thể tra cứu mã quảng cáo, mã điểm chèn quảng cáo và loại sự kiện. Sau đó, mã quảng cáo được dùng để lập chỉ mục Các đối tượng ads và mã điểm chèn quảng cáo được dùng để lập chỉ mục cá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,
}

AdBreak

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