Package google.ads.drx.video.v1

Chỉ mục

AdBreakNotificationService

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

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

API để tạo Đ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 bài viết Tổng quan về OAuth 2.0.

ListAdBreaks

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 bài viết Tổng quan về OAuth 2.0.

VideoContentIngestionService

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 được liên kết của nó trong Google Ad Manager.

UpdateVideoContent

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

API để tạo nội dung mới hoặc cập nhật siêu dữ liệu của nội dung đó nếu nội dung đã tồn tại 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.

Yêu cầu mẫu sẽ 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 bài viết Tổng quan về OAuth 2.0.

Điểm chèn 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 sự kiện phát trực tiếp.

Trường
name

string

Chỉ có đầ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 là "networks//Asset//adBreaks/".

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

asset_key là khoá của Sự kiện phát trực tiếp trong Google Ad Manager, trong đó có khoảng nghỉ quảng cáo được tạo.

ad_break_id là khoá của Điểm chèn quảng cáo. CHỈ ĐẦU RA.

expected_duration

Duration

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

custom_params

string

Cặp khoá-giá trị được đưa vào các yêu cầu quảng cáo cho điểm chèn này để nhắm mục tiêu theo tiêu chí tuỳ chỉnh trong Ad Manager. Ví dụ: "key1=value&key2=value2,value22"

scte_35_cue_out

string

Dữ liệu được mã hoá Base 64 từ điểm cue out scte35. Có thể bao gồm lệnh splice_insert() hoặc time_signal(). Ví dụ: - với time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAAAA nay/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - với splice_insert khiếu nại ((): "/DAvAAAAAAAA///wFAVIAAAACPf+/+c2nALv4AUAAA lòngsz1AAAAAA)

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.

BreakState

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

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

ClosedCaptionFormat

Các định dạng có thể chứa tệp phụ đề.

Enum
CLOSED_CAPTION_FORMAT_UNSPECIFIED Chưa chỉ định định dạng phụ đề.
TTML application/ttaf+xml
WEB_VTT text/vtt

ClosedCaptionUrlInfo

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

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ụ đề chi tiết.

url

string

URL đến tệp phụ đề chi tiết.

CreateAdBreakRequest

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

Trường
parent

string

Trường này xác định LiveStreamEvent mà điểm chèn quảng cáo này cần liên kết bằng cách sử dụng khoá tài sản sự kiện phát trực tiếp. Tài sản phải có định dạng "networks/{network_code}/Asset/{asset_code}"

custom_parent

string

Trường này xác định LiveStreamEvent mà điểm chèn quảng cáo này sẽ được liên kết bằng cách sử dụng khoá thành phần tuỳ chỉnh. Tên này phải có định dạng "networks/{network_code}/customAssets/{asset_code}"

content

string

Đây là một cách khác để xác định LiveStreamEvent, nếu sự kiện này được liên kết với một nội dung trong GAM. Tài sản phải có định dạng "networks/{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.

DynamicAdInsertionInfo

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

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 gần nhất của tệp video được tham chiếu trong video_ingest_url_info.

closed_caption_url_info[]

ClosedCaptionUrlInfo

URL tới tệp phụ đề.

fw_caid

string

Mã tài sản tuỳ chỉnh FreeWheel được dùng để nhắm mục tiêu quảng cáo.

GracenoteMetadata

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

Trường
gracenote_id

string

Bắt buộc. Tham chiếu đến mã Gracenote của nội dung. Phải có một trong các tiền tố hợp lệ sau: 1. "EP" – tập của chương trình dài tập 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 mã chuỗi chương trình Gracenote. Phải có tiền tố là "SH".

ListAdBreaksRequest

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

Trường
parent

string

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

custom_parent

string

Không bắt buộc. Trường này xác định LiveStreamEvent mà điểm chèn quảng cáo này sẽ được liên kết bằng cách sử dụng khoá tài sản tuỳ chỉnh. Tài sản phải có định dạng "networks/{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 này được liên kết với một nội dung trong GAM. URL này phải có định dạng "networks/{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 cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ đị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ị lớn hơn 100 sẽ bị buộc thành 100.

page_token

string

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

Khi phân trang, tất cả các tham số khác được 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

Câu trả lời cho AdBreakNotificationService.ListAdBreaks.

Trường
ad_breaks[]

AdBreak

Chỉ có đầu ra. Danh sách Điểm chèn quảng cáo khớp với sự kiện LiveStreamEvent đã yêu cầu.

next_page_token

string

Một 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 bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.

Metadata

Siêu dữ liệu tuỳ chỉnh của nội dung.

Trường
key_values

map<string, Value>

Xác định siêu dữ liệu tuỳ chỉnh của nội dung dưới dạng một cặp khoá-giá trị. Đối với giá trị, hệ thống chỉ chấp nhận chuỗi hoặc danh sách chuỗi.

SyndicatedVideoContentNames

Danh sách tên của tất cả nội dung được cung cấp.

Trường
syndicated_video_content[]

string

Trường lặp lại của tên nội dung được cung cấp. Các URL này phải có định dạng "networks/{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 chứa trường này.

UpdateVideoContentRequest

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

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.

Trường
name

string

Chỉ có đầ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 mà nội dung này thuộc về.

content_source_id là mã 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 hình thành như một phần của yêu cầu quảng cáo để xác định quảng cáo nào Ad Manager có thể phân phát 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 thuộc tính này, giá trị mặc định sẽ được kích hoạt.

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 chỉ đị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 cấp mili giây.

cue_points[]

Duration

Xác định các điểm dừng. Điểm chèn quảng cáo là các thời điểm khi có thể chèn quảng cáo vào trong video. Điểm dừng được hỗ trợ xuống đến mức mili giây. Đây là trường bắt buộc nếu video có 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 tuỳ 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 của nội dung liên quan đến phân phối.

dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

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

VideoContentStatus

Các lựa 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 một nội dung.

Enum
ACTIVE Quảng cáo nhắm mục tiêu theo nội dung sẽ được phân phát.
BLOCKED Không có quảng cáo nào được phân phát cho nội dung này nếu trạng thái là BỊ CHẶN.
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à BỊ XÓA, thì quảng cáo tự quảng bá hoặc quảng cáo được 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 nội dung đó. Để chặn quảng cáo, hãy đặt trạng thái thành BỊ CHẶN.

VideoContentSyndicationInfo

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.

Trường
Trường hợp hợp nhất syndication. VideoContentSyndiationMetadata chỉ có thể chứa một trong các siêu dữ liệu sau. syndication chỉ có thể là một trong những trạng thái sau đây:
canonical_video_content

string

Tên của nội dung chính tắc. URL này phải có định dạng "networks/{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 chứa trường này.

syndicated_video_content_names

SyndicatedVideoContentNames

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

VideoFormat

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

Enum
VIDEO_FORMAT_UNSPECIFIED Chưa chỉ định định dạng video.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

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

Trường
video_format

VideoFormat

Định dạng của video.

video_preconditioned

VideoPreconditioned

Để cho biết nội dung có được điều chỉnh cho quảng cáo trong video hay không. Tức là các phân đoạn của bạn đã được chia nhỏ tại thời điểm chèn quảng cáo.

url

string

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

VideoPreconditioned

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

Enum
NO Chưa được điều kiện hoá.
YES Video đã được điều chỉnh/chia nhỏ.