Package google.ads.drx.video.v1

Chỉ mục

Dịch vụ thông báo ngắt quảng cáo

Dịch vụ API cho phép nhà xuất bản tạo điểm chèn quảng cáo trong luồng trực tiếp.

Tạo quảng cáo xen giữa

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API để tạo quảng cáo xen giữa trong sự kiện phát trực tiếp.

Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.
Liệt kêquảng cáo

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

API để liệt kê các điểm chèn quảng cáo trong sự kiện phát trực tiếp.

Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

Dịch vụ nhập nội dung video

Dịch vụ API để nhập nội dung cho phép tạo hoặc cập nhật nội dung video và siêu dữ liệu liên quan trong Google Ad Manager.

Cập nhậtNội dungVideo

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API để tạo nội dung mới hoặc cập nhật siêu dữ liệu nếu nội dung đã có trong Ad Manager. Trả về nội dung khi thành công hoặc google.rpc.Code khi không thành công.

Một yêu cầu mẫu có dạng như sau:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
Phạm vi cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

Ngắt quảng cáo

Siêu dữ liệu về điểm chèn quảng cáo dùng để quyết định quảng cáo cho một điểm chèn quảng cáo trong một sự kiện video trực tiếp.

Các trường
name

string

Chỉ đầu ra. Tên tài nguyên của điểm chèn quảng cáo. Trường này sẽ có định dạng "mạng//assets//adBreaks/".

network_code là mã mạng trong Google Ad Manager chứa nội dung này.

asset_key là khóa của Sự kiện truyền trực tiếp trong Google Ad Manager mà tại đó ngắt quảng cáo được tạo.

ad_break_id là khóa của Điểm chèn quảng cáo. CHỈ OUTPUT.
expected_duration

Duration

Bắt buộc. Thời lượng ngắt dự kiến.
custom_params

string

Cặp khóa-giá trị cần bao gồm trong yêu cầu quảng cáo cho điểm chèn này để nhắm mục tiêu tiêu chí tùy chỉnh trong Ad Manager. Ví dụ: 'key1=value&key2=value2,value22'
scte_35_cue_out

string

Dữ liệu được mã hóa cơ sở 64 từ tín hiệu scte35. Có thể bao gồm lệnh splice_insert() hoặc time_signal(). Ví dụ: - với time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - with splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALvhAUsz1JAAAAKAA="
pod_template_name

string

Tên mẫu nhóm Google Ad Manager.
break_state

BreakState

Trạng thái hiện tại của điểm chèn quảng cáo.

Ngắt trạng thái

Trạng thái của điểm chèn quảng cáo.

Enum
BREAK_STATE_UNSPECIFIED Trạng thái Ngắt quảng cáo không xác định.
BREAK_STATE_DECISIONED Thời điểm quyết định quảng cáo đã bắt đầu nhưng chưa phân phối cho người dùng.
BREAK_STATE_COMPLETE Ngắt quảng cáo đã được phân phối đến người dùng.

Định dạng phụ đề chi tiết

Định dạng mà tệp phụ đề có thể ở đó.

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED Định dạng phụ đề không được chỉ định.
TTML ứng dụng/ttaf+xml
WEB_VTT văn bản/vtt

Thông tin url đóng phụ đề

Siêu dữ liệu cho một tệp phụ đề.

Các trường
language_code

string

Mã ngôn ngữ IETF BCP-47 thể hiện ngôn ngữ của tệp phụ đề.
closed_caption_format

ClosedCaptionFormat

Định dạng của tệp phụ đề.
url

string

Url tới tệp phụ đề chi tiết.

Tạo Yêu cầu quảng cáo

Yêu cầu đối với AdBreakNotificationService.CreateAdBreak.

Các trường
parent

string

Trường này xác định Sự kiện phát trực tiếp mà điểm chèn quảng cáo này phải được liên kết bằng cách sử dụng khóa nội dung luồng trực tiếp. Nội dung này phải có định dạng "mạng/{network_code}/assets/{asset_code}"
custom_parent

string

Trường này xác định Sự kiện phát trực tiếp mà điểm chèn quảng cáo này cần liên kết bằng cách sử dụng khóa nội dung tùy chỉnh. Tệp phải có định dạng "mạng/{network_code}/customAssets/{asset_code}"
content

string

Đây là một cách khác để xác định LiveStreamEvent nếu sự kiện đó được liên kết với một nội dung trong GAM. Nội dung này phải có định dạng "mạng/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
ad_break

AdBreak

Bắt buộc. Điểm chèn quảng cáo thực tế.
ad_break_id

string

Đây là ad_break_id mà người dùng có thể cung cấp thông qua yêu cầu.

Thông tin Chèn Quảng cáo Động

Thông tin liên quan đến Chèn quảng cáo động.

Các trường
video_ingest_url_info

VideoIngestUrlInfo

Đường liên kết đến tệp m3u8 chính dùng để điều chỉnh và tạo danh sách phát.
media_update_time

Timestamp

Thời gian sửa đổi lần cuối tệp video được tham chiếu trong video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

URL đến tệp phụ đề.
fw_caid

string

ID nội dung tùy chỉnh Freewheel dùng để nhắm mục tiêu quảng cáo.

Siêu dữ liệu về Gracenote

Siêu dữ liệu Gracenote cho nội dung.

Các trường
gracenote_id

string

Bắt buộc. Đề cập đến ID Gracenote cho nội dung. Phải có một trong các tiền tố hợp lệ sau: 1. 'EP' - tập của một loạt 2. 'MV' - phim 3. 'SP' - sự kiện thể thao
gracenote_series_id

string

Không bắt buộc. Trường này đề cập đến ID chuỗi Gracenote. Phải có tiền tố là 'SH'.

Liệt kêAdBreaksRequest

Yêu cầu đối với AdBreakNotificationService.ListAdBreaks.

Các trường
parent

string

Không bắt buộc. Trường này xác định Sự kiện phát trực tiếp mà điểm chèn quảng cáo này phải được liên kết bằng cách sử dụng khóa nội dung luồng trực tiếp. Nội dung này phải có định dạng "mạng/{network_code}/assets/{asset_code}"
custom_parent

string

Không bắt buộc. Trường này xác định Sự kiện phát trực tiếp mà điểm chèn quảng cáo này cần liên kết bằng cách sử dụng khóa nội dung tùy chỉnh. Tệp phải có định dạng "mạng/{network_code}/customAssets/{asset_code}"
content

string

Không bắt buộc. Đây là một cách khác để xác định LiveStreamEvent nếu sự kiện đó được liên kết với một nội dung trong GAM. Nội dung này phải có định dạng "mạng/{network_code}/sources/{content_source_id}/content/{cms_content_id}"
page_size

int32

Không bắt buộc. Số lượng điểm chèn quảng cáo tối đa để trả về. Dịch vụ có thể trả lại ít hơn giá trị này. Nếu không xác định, hệ thống sẽ trả về tối đa 10 điểm chèn quảng cáo. Giá trị tối đa là 100; các giá trị trên 100 sẽ bị ép gán thành 100.
page_token

string

Không bắt buộc. Đã nhận được mã thông báo trang từ cuộc gọi ListAdBreaks trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác mà bạn cung cấp cho ListAdBreaks phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

ListAdBreaksResponse

Phản hồi cho AdBreakNotificationService.ListAdBreaks.

Các trường
ad_breaks[]

AdBreak

Chỉ đầu ra. Danh sách các điểm chèn quảng cáo khớp với Sự kiện trực tiếp.
next_page_token

string

Mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo nào.

Siêu dữ liệu

Siêu dữ liệu tùy chỉnh của nội dung.

Các trường
key_values

map<string, Value>

Xác định siêu dữ liệu tùy chỉnh của nội dung dưới dạng một cặp khóa-giá trị. Chỉ các chuỗi hoặc danh sách các chuỗi được chấp nhận cho các giá trị.

Tên nội dung video được phân phối

Danh sách tên của tất cả nội dung tổng hợp.

Các trường
syndicated_video_content[]

string

Trường tên trùng lặp của nội dung tổng hợp. Chúng phải có định dạng "mạng/{network_code}/sources/{content_source_id}/content/{cms_content_id}" và phải thuộc cùng mạng như nội dung chứa trường này.

Cập nhậtNội dungVideoYêu cầu

Yêu cầu [VideoContentImportService.UpdateVideoContentRequest][].

Các trường
video_content

VideoContent

Bắt buộc. Siêu dữ liệu của nội dung.

VideoContent

Siêu dữ liệu của nội dung.

Các trường
name

string

Chỉ đầu ra. Tên tài nguyên của nội dung video. Trường này có định dạng: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

network_code là mã mạng trong Google Ad Manager chứa nội dung này.

content_source_id là ID nguồn nội dung trong Google Ad Manager mà nội dung này thuộc về.

cms_content_id là ID nội dung CMS trong Google Ad Manager, được tạo như một phần của yêu cầu quảng cáo để xác định quảng cáo mà Ad Manager có thể phân phối cho video tương ứng. Giá trị này có thể là số hoặc chữ số.
status

VideoContentStatus

Trạng thái của nội dung. Nếu bạn bỏ qua bước này, giá trị mặc định sẽ hoạt động.
title

string

Bắt buộc. Tiêu đề của nội dung.
update_time

Timestamp

Bắt buộc. Thời gian sửa đổi gần đây nhất của nội dung.
publish_time

Timestamp

Thời gian xuất bản nội dung. Đây là trường bắt buộc nếu video được thiết kế để đưa vào Quy tắc quảng cáo có xác định thời gian bắt đầu và kết thúc.
duration

Duration

Thời lượng của nội dung. Thời lượng được hỗ trợ xuống đến mili giây.
cue_points[]

Duration

Xác định điểm dừng. Điểm dừng là vị trí chèn quảng cáo vào video. Điểm dừng được hỗ trợ tới mức mili giây. Đây là trường bắt buộc nếu video chứa điểm chèn quảng cáo trong video.
thumbnail_url

string

Url hình thu nhỏ của nội dung.
metadata

Metadata

Xác định siêu dữ liệu tùy chỉnh của nội dung.
gracenote_metadata

GracenoteMetadata

Siêu dữ liệu liên quan đến Gracenote của nội dung.
syndication_metadata

VideoContentSyndicationInfo

Siêu dữ liệu liên quan đến phân phối nội dung.
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

Siêu dữ liệu liên quan đến Chèn quảng cáo động của nội dung.

Trạng thái nội dung video

Tùy chọn trạng thái để phân phát hoặc không phân phát quảng cáo được nhắm mục tiêu cho nội dung.

Enum
ACTIVE Quảng cáo được nhắm mục tiêu theo nội dung sẽ được phân phối.
BLOCKED Sẽ không có quảng cáo nào được phân phát dựa trên nội dung này nếu trạng thái là BLOCKED.
DELETED Nội dung sẽ được lưu trữ trong Ad Manager. Nếu Ad Manager nhận được yêu cầu quảng cáo cho một nội dung được đánh dấu là ĐÃ XÓA, thì quảng cáo cho cùng một công ty hoặc quảng cáo nhắm mục tiêu đến đơn vị khoảng không quảng cáo hoặc tiêu chí nhắm mục tiêu khác vẫn có thể phân phát dựa trên đó. Để chặn quảng cáo, hãy đặt trạng thái thành BLOCKED.

Thông tin phân phối nội dung video

Siêu dữ liệu dùng để chỉ định mối quan hệ giữa nội dung chính tắc và nội dung tổng hợp.

Các trường
Trường nhóm syndication. VideoContentSyndiationMetadata chỉ có thể chứa một trong những nội dung sau đây. syndication chỉ có thể là một trong những loại sau đây:
canonical_video_content

string

Tên của nội dung chính tắc. Nội dung này phải có định dạng "mạng/{network_code}/sources/{content_source_id}/content/{cms_content_id}" và phải thuộc cùng một mạng với nội dung có chứa trường này.
syndicated_video_content_names

SyndicatedVideoContentNames

Bộ sưu tập nội dung tổng hợp

Định dạng video

Các định dạng mà trong đó nội dung video có thể được mã hóa.

Enum
VIDEO_FORMAT_UNSPECIFIED Định dạng video không được xác định.
HLS ứng dụng/x-mpegURL
DASH ứng dụng/dash+xml

Thông tin về VideoIngestUrl

Siêu dữ liệu xác định đường liên kết đến tệp m3u8 dùng để điều chỉnh và tạo danh sách phát.

Các trường
video_format

VideoFormat

Định dạng của video.
video_preconditioned

VideoPreconditioned

Để cho biết liệu nội dung đã được điều chỉnh cho quảng cáo giữa video hay chưa, điều đó có nghĩa là các phân đoạn của bạn đã được tách ra tại thời điểm ngắt quảng cáo.
url

string

Đường liên kết đến tệp m3u8.

Video được điều chỉnh trước

Trạng thái điều chỉnh của nội dung video.

Enum
NO Chưa được điều chỉnh.
YES Video đã được điều chỉnh/được ghép.