- Tài nguyên: Mẫu quảng cáo
- HostingSource
- CreativeAttribute
- ReviewStatusInfo
- ApprovalStatus
- ReviewStatus
- ExchangeReviewStatus
- AssetAssociation
- Thành phần
- AssetRole
- ExitEvent
- ExitEventType
- TimerEvent
- CounterEvent
- AudioVideoOffset
- UniversalAdId
- UniversalAdRegistry
- ThirdPartyUrl
- ThirdPartyUrlType
- Chuyển mã
- CmTrackingAd
- ObaIcon
- ObaIconPosition
- ExpandingDirection
- Phương thức
Tài nguyên: Mẫu quảng cáo
Một mẫu quảng cáo duy nhất.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string, "advertiserId": string, "creativeId": string, "cmPlacementId": string, "displayName": string, "entityStatus": enum ( |
| Trường | |
|---|---|
name |
Chỉ có đầu ra. Tên tài nguyên của mẫu quảng cáo. |
advertiserId |
Chỉ có đầu ra. Mã nhận dạng duy nhất của nhà quảng cáo mà mẫu quảng cáo thuộc về. |
creativeId |
Chỉ có đầu ra. Mã nhận dạng riêng biệt của mẫu quảng cáo. Do hệ thống chỉ định. |
cmPlacementId |
Chỉ có đầu ra. Mã nhận dạng duy nhất của vị trí trên Campaign Manager 360 được liên kết với mẫu quảng cáo. Trường này chỉ áp dụng cho những mẫu quảng cáo được đồng bộ hoá từ Campaign Manager. |
displayName |
Bắt buộc. Tên hiển thị của mẫu quảng cáo. Phải được mã hoá theo UTF-8 với kích thước tối đa là 240 byte. |
entityStatus |
Bắt buộc. Kiểm soát việc mẫu quảng cáo có thể phân phát hay không. Các giá trị được chấp nhận là:
|
updateTime |
Chỉ có đầu ra. Dấu thời gian khi mẫu quảng cáo được người dùng hoặc hệ thống cập nhật lần gần đây nhất (ví dụ: quy trình xem xét mẫu quảng cáo). Do hệ thống chỉ định. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: |
createTime |
Chỉ có đầu ra. Dấu thời gian khi mẫu quảng cáo được tạo. Do hệ thống chỉ định. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: |
creativeType |
Bắt buộc. Không thể thay đổi. Loại mẫu quảng cáo. |
hostingSource |
Bắt buộc. Cho biết nơi lưu trữ mẫu quảng cáo. |
dynamic |
Chỉ có đầu ra. Cho biết liệu mẫu quảng cáo có linh hoạt hay không. |
dimensions |
Bắt buộc. Phương diện chính của mẫu quảng cáo. Áp dụng cho tất cả các loại mẫu quảng cáo. Giá trị của
|
additionalDimensions[] |
Không bắt buộc. Các phương diện bổ sung. Áp dụng khi
Nếu bạn chỉ định trường này, thì cả |
mediaDuration |
Chỉ có đầu ra. Thời lượng của mẫu quảng cáo đa phương tiện. Áp dụng khi
Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân và kết thúc bằng " |
creativeAttributes[] |
Chỉ có đầu ra. Danh sách các thuộc tính của mẫu quảng cáo do hệ thống tạo. |
reviewStatus |
Chỉ có đầu ra. Trạng thái hiện tại của quy trình xem xét mẫu quảng cáo. |
assets[] |
Bắt buộc. Các thành phần được liên kết với mẫu quảng cáo này. |
exitEvents[] |
Bắt buộc. Sự kiện thoát cho mẫu quảng cáo này. Điểm thoát (còn được gọi là thẻ nhấp chuột) là bất kỳ khu vực nào trong mẫu quảng cáo mà người dùng có thể nhấp hoặc nhấn vào để mở trang đích của nhà quảng cáo. Mỗi mẫu quảng cáo phải có ít nhất một lượt thoát. Bạn có thể thêm một lệnh thoát vào mẫu quảng cáo theo bất kỳ cách nào sau đây:
|
timerEvents[] |
Không bắt buộc. Sự kiện tuỳ chỉnh về bộ tính giờ cho mẫu quảng cáo đa phương tiện. Đồng hồ đo thời gian theo dõi thời gian mà người dùng xem và tương tác với một phần cụ thể của mẫu quảng cáo đa phương tiện. Một mẫu quảng cáo có thể có nhiều sự kiện trong bộ tính giờ. Mỗi sự kiện được tính giờ riêng. Để trống hoặc không đặt giá trị này cho những mẫu quảng cáo chỉ chứa thành phần hình ảnh. |
counterEvents[] |
Không bắt buộc. Sự kiện bộ đếm cho mẫu quảng cáo đa phương tiện. Bộ đếm theo dõi số lần người dùng tương tác với bất kỳ phần nào của mẫu quảng cáo đa phương tiện theo cách đã định (di chuột, nhấp chuột bên ngoài, nhấp chuột, nhấn, tải dữ liệu, nhập dữ liệu qua bàn phím, v.v.). Bất kỳ sự kiện nào có thể được ghi lại trong mẫu quảng cáo đều có thể được ghi lại dưới dạng bộ đếm. Để trống hoặc không đặt giá trị này cho những mẫu quảng cáo chỉ chứa thành phần hình ảnh. |
appendedTag |
Không bắt buộc. Thẻ theo dõi HTML của bên thứ ba sẽ được thêm vào thẻ mẫu quảng cáo. |
integrationCode |
Không bắt buộc. Thông tin về mã nhận dạng được dùng để liên kết mẫu quảng cáo này với một hệ thống bên ngoài. Phải được mã hoá UTF-8 và có độ dài không quá 10.000 ký tự. |
notes |
Không bắt buộc. Ghi chú của người dùng cho mẫu quảng cáo này. Phải được mã hoá UTF-8 và có độ dài không quá 20.000 ký tự. |
iasCampaignMonitoring |
Không bắt buộc. Cho biết liệu tính năng giám sát chiến dịch của Integral Ad Science (IAS) có được bật hay không. Để bật tính năng này cho mẫu quảng cáo, hãy đảm bảo rằng |
companionCreativeIds[] |
Không bắt buộc. Mã nhận dạng của mẫu quảng cáo đồng hành cho một mẫu quảng cáo dạng video. Bạn có thể chỉ định các mẫu quảng cáo hiển thị hiện có (có thành phần hình ảnh hoặc HTML5) để phân phát xung quanh trình phát video của nhà xuất bản. Quảng cáo đi kèm xuất hiện xung quanh trình phát video trong khi video đang phát và vẫn xuất hiện sau khi video kết thúc. Mẫu quảng cáo có chứa Trường này chỉ được hỗ trợ cho
|
skippable |
Không bắt buộc. Người dùng có thể chọn bỏ qua mẫu quảng cáo dạng video hay không. Trường này chỉ được hỗ trợ cho
|
skipOffset |
Không bắt buộc. Thời lượng phát video trước khi nút bỏ qua xuất hiện. Đây là trường bắt buộc khi Trường này chỉ được hỗ trợ cho
|
progressOffset |
Không bắt buộc. Thời lượng phát video trước khi lượt xem được tính. Đây là trường bắt buộc khi Trường này chỉ được hỗ trợ cho
|
universalAdId |
Không bắt buộc. Giá trị nhận dạng mẫu quảng cáo không bắt buộc do một sổ đăng ký cung cấp và là giá trị riêng biệt trên tất cả các nền tảng. Mã quảng cáo chung là một phần của tiêu chuẩn VAST 4.0. Bạn có thể sửa đổi chế độ này sau khi tạo mẫu quảng cáo. Trường này chỉ được hỗ trợ cho
|
thirdPartyUrls[] |
Không bắt buộc. URL theo dõi của bên thứ ba để theo dõi lượt tương tác với mẫu quảng cáo dạng video. Trường này chỉ được hỗ trợ cho
|
transcodes[] |
Chỉ có đầu ra. Mã hoá âm thanh/video. Display & Video 360 chuyển mã thành phần chính thành một số phiên bản thay thế sử dụng các định dạng tệp khác nhau hoặc có các thuộc tính khác nhau (độ phân giải, tốc độ bit âm thanh và tốc độ bit video), mỗi phiên bản được thiết kế cho các trình phát video hoặc băng thông cụ thể. Các bản chuyển mã này giúp hệ thống của nhà xuất bản có thêm nhiều lựa chọn cho mỗi lượt hiển thị trên video của bạn và đảm bảo rằng tệp phù hợp sẽ được phân phát dựa trên kết nối và kích thước màn hình của người xem. Trường này chỉ được hỗ trợ ở những
|
trackerUrls[] |
Không bắt buộc. URL theo dõi cho nhà cung cấp dịch vụ phân tích hoặc nhà cung cấp công nghệ quảng cáo bên thứ ba. Các URL phải bắt đầu bằng Chỉ URL chuẩn, không có thẻ IMG hoặc SCRIPT. Bạn chỉ có thể ghi trường này trong
|
jsTrackerUrl |
Không bắt buộc. URL đo lường bằng JavaScript của các nhà cung cấp dịch vụ xác minh bên thứ ba được hỗ trợ (ComScore, DoubleVerify, IAS, Moat). Thẻ tập lệnh HTML không được hỗ trợ. Bạn chỉ có thể ghi trường này trong
|
cmTrackingAd |
Không bắt buộc. Quảng cáo theo dõi Campaign Manager 360 được liên kết với mẫu quảng cáo. Không bắt buộc đối với
Chỉ có đầu ra cho các trường hợp khác. |
obaIcon |
Không bắt buộc. Chỉ định biểu tượng OBA cho mẫu quảng cáo dạng video. Trường này chỉ được hỗ trợ ở những
|
thirdPartyTag |
Không bắt buộc. Thẻ của bên thứ ba ban đầu được dùng cho mẫu quảng cáo. Bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo thẻ của bên thứ ba. Mẫu quảng cáo có thẻ của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
requireMraid |
Không bắt buộc. Cho biết rằng mẫu quảng cáo yêu cầu MRAID (hệ thống Định nghĩa giao diện quảng cáo đa truyền thông dành cho thiết bị di động). Đặt giá trị này nếu mẫu quảng cáo dựa vào cử chỉ trên thiết bị di động để tương tác, chẳng hạn như vuốt hoặc nhấn. Không bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo thẻ của bên thứ ba. Mẫu quảng cáo có thẻ của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
requireHtml5 |
Không bắt buộc. Cho biết rằng mẫu quảng cáo dựa vào HTML5 để hiển thị đúng cách. Không bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo thẻ của bên thứ ba. Mẫu quảng cáo có thẻ của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
requirePingForAttribution |
Không bắt buộc. Cho biết rằng mẫu quảng cáo sẽ đợi một ping trả về để phân bổ. Chỉ có hiệu lực khi bạn sử dụng quảng cáo theo dõi Campaign Manager 360 có thông số máy chủ quảng cáo của bên thứ ba và macro ${DC_DBM_TOKEN}. Không bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo thẻ của bên thứ ba hoặc mẫu quảng cáo thẻ VAST của bên thứ ba. Mẫu quảng cáo có thẻ của bên thứ ba là mẫu quảng cáo có
kết hợp với
Mẫu quảng cáo thẻ VAST của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
expandingDirection |
Không bắt buộc. Chỉ định hướng mở rộng của mẫu quảng cáo. Bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo mở rộng của bên thứ ba. Mẫu quảng cáo có thể mở rộng của bên thứ ba là mẫu quảng cáo có nguồn lưu trữ như sau:
kết hợp với
|
expandOnHover |
Không bắt buộc. Cho biết mẫu quảng cáo sẽ tự động mở rộng khi di chuột. Không bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo mở rộng của bên thứ ba. Mẫu quảng cáo có thể mở rộng của bên thứ ba là mẫu quảng cáo có nguồn lưu trữ như sau:
kết hợp với
|
vastTagUrl |
Không bắt buộc. URL của thẻ VAST cho mẫu quảng cáo thẻ VAST của bên thứ ba. Bắt buộc và chỉ hợp lệ đối với mẫu quảng cáo thẻ VAST của bên thứ ba. Mẫu quảng cáo thẻ VAST của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
vpaid |
Chỉ có đầu ra. Cho biết mẫu quảng cáo thẻ VAST của bên thứ ba yêu cầu VPAID (Giao diện quảng cáo trên trình phát video kỹ thuật số). Chỉ có đầu ra và chỉ hợp lệ đối với mẫu quảng cáo thẻ VAST của bên thứ ba. Mẫu quảng cáo thẻ VAST của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
html5Video |
Chỉ có đầu ra. Cho biết mẫu quảng cáo thẻ VAST của bên thứ ba yêu cầu hỗ trợ Video HTML5. Chỉ có đầu ra và chỉ hợp lệ đối với mẫu quảng cáo thẻ VAST của bên thứ ba. Mẫu quảng cáo thẻ VAST của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
lineItemIds[] |
Chỉ có đầu ra. Mã nhận dạng của các mục hàng mà mẫu quảng cáo này được liên kết. Để liên kết một mẫu quảng cáo với một mục hàng, hãy sử dụng |
mp3Audio |
Chỉ có đầu ra. Cho biết mẫu quảng cáo dạng âm thanh của bên thứ ba hỗ trợ MP3. Chỉ có đầu ra và chỉ hợp lệ cho mẫu quảng cáo âm thanh của bên thứ ba. Mẫu quảng cáo dạng âm thanh của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
oggAudio |
Chỉ có đầu ra. Cho biết mẫu quảng cáo dạng âm thanh của bên thứ ba hỗ trợ OGG. Chỉ có đầu ra và chỉ hợp lệ cho mẫu quảng cáo âm thanh của bên thứ ba. Mẫu quảng cáo âm thanh của bên thứ ba là mẫu quảng cáo có
kết hợp với
|
syntheticContentAttestationStatus |
Không bắt buộc. Có thêm nhãn cho mẫu quảng cáo là được tạo hoặc chỉnh sửa bằng AI hay không khi được phân phát ở những khu vực có quy định gắn nhãn AI tại địa phương. |
HostingSource
Các nguồn lưu trữ có thể có cho một mẫu quảng cáo. Cho biết nơi mẫu quảng cáo được tạo và lưu trữ.
| Enum | |
|---|---|
HOSTING_SOURCE_UNSPECIFIED |
Nguồn lưu trữ chưa được chỉ định hoặc không xác định trong phiên bản này. |
HOSTING_SOURCE_CM |
Một mẫu quảng cáo được đồng bộ hoá từ Campaign Manager 360. Các phương thức tạo và cập nhật không được hỗ trợ cho loại lưu trữ này. |
HOSTING_SOURCE_THIRD_PARTY |
Một mẫu quảng cáo do máy chủ quảng cáo của bên thứ ba (3PAS) lưu trữ. Các phương thức tạo và cập nhật được hỗ trợ cho loại lưu trữ này nếu
|
HOSTING_SOURCE_HOSTED |
Một mẫu quảng cáo được tạo trong DV360 và do Campaign Manager 360 lưu trữ. Các phương thức tạo và cập nhật được hỗ trợ cho loại lưu trữ này nếu
|
HOSTING_SOURCE_RICH_MEDIA |
Một mẫu quảng cáo đa phương tiện được tạo trong Studio và do Campaign Manager 360 lưu trữ. Các phương thức tạo và cập nhật không được hỗ trợ cho loại lưu trữ này. |
CreativeAttribute
Các thuộc tính có thể có của mẫu quảng cáo.
| Enum | |
|---|---|
CREATIVE_ATTRIBUTE_UNSPECIFIED |
Thuộc tính mẫu quảng cáo không được chỉ định hoặc không xác định trong phiên bản này. |
CREATIVE_ATTRIBUTE_VAST |
Mẫu quảng cáo là mẫu quảng cáo VAST. |
CREATIVE_ATTRIBUTE_VPAID_LINEAR |
Mẫu quảng cáo là mẫu quảng cáo VPAID tuyến tính. |
CREATIVE_ATTRIBUTE_VPAID_NON_LINEAR |
Mẫu quảng cáo là mẫu quảng cáo VPAID phi tuyến tính. |
ReviewStatusInfo
Trạng thái xem xét của mẫu quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "approvalStatus": enum ( |
| Trường | |
|---|---|
approvalStatus |
Thể hiện trạng thái phê duyệt cơ bản cần thiết để mẫu quảng cáo bắt đầu phân phát. Tóm tắt |
creativeAndLandingPageReviewStatus |
Trạng thái xem xét mẫu quảng cáo và trang đích của mẫu quảng cáo. |
contentAndPolicyReviewStatus |
Trạng thái xem xét nội dung và chính sách của mẫu quảng cáo. |
exchangeReviewStatuses[] |
Trao đổi trạng thái xem xét cho mẫu quảng cáo. |
Trạng thái phê duyệt
Các loại trạng thái phê duyệt có thể có. Đây là bản tóm tắt của creativeAndLandingPageReviewStatus và contentAndPolicyReviewStatus.
| Enum | |
|---|---|
APPROVAL_STATUS_UNSPECIFIED |
Giá trị loại không được chỉ định hoặc không xác định trong phiên bản này. |
APPROVAL_STATUS_PENDING_NOT_SERVABLE |
Mẫu quảng cáo vẫn đang được xem xét và không phân phát được. |
APPROVAL_STATUS_PENDING_SERVABLE |
Mẫu quảng cáo đã vượt qua quy trình xem xét mẫu quảng cáo và trang đích, có thể phân phát nhưng đang chờ quy trình xem xét bổ sung về nội dung và chính sách. |
APPROVAL_STATUS_APPROVED_SERVABLE |
Cả quy trình xem xét mẫu quảng cáo và trang đích cũng như quy trình xem xét nội dung và chính sách đều được phê duyệt. Mẫu quảng cáo có thể phân phát. |
APPROVAL_STATUS_REJECTED_NOT_SERVABLE |
Đã xảy ra vấn đề với mẫu quảng cáo và bạn phải khắc phục vấn đề này thì mẫu quảng cáo mới có thể phân phát. |
ReviewStatus
Các loại trạng thái đánh giá có thể có.
| Enum | |
|---|---|
REVIEW_STATUS_UNSPECIFIED |
Giá trị loại không được chỉ định hoặc không xác định trong phiên bản này. |
REVIEW_STATUS_APPROVED |
Mẫu quảng cáo được phê duyệt. |
REVIEW_STATUS_REJECTED |
Mẫu quảng cáo bị từ chối. |
REVIEW_STATUS_PENDING |
Mẫu quảng cáo đang chờ xem xét. |
ExchangeReviewStatus
Trạng thái xem xét của mẫu quảng cáo trên Sàn giao dịch.
| Biểu diễn dưới dạng JSON |
|---|
{ "exchange": enum ( |
| Trường | |
|---|---|
exchange |
Sàn giao dịch đang xem xét mẫu quảng cáo. |
status |
Trạng thái xem xét yêu cầu đổi trả. |
AssetAssociation
Mối liên kết thành phần cho mẫu quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "asset": { object ( |
| Trường | |
|---|---|
asset |
Không bắt buộc. Tài sản được liên kết. |
role |
Không bắt buộc. Vai trò của thành phần này đối với mẫu quảng cáo. |
Thành phần
Một thành phần duy nhất.
| Biểu diễn dưới dạng JSON |
|---|
{ "mediaId": string, "content": string } |
| Trường | |
|---|---|
mediaId |
Mã nhận dạng phương tiện của thành phần đã tải lên. Đây là giá trị nhận dạng riêng biệt của tài sản. Bạn có thể truyền mã nhận dạng này đến các lệnh gọi API khác, ví dụ: Không gian mã nhận dạng phương tiện được cập nhật vào ngày 5 tháng 4 năm 2023. Cập nhật mã nhận dạng nội dung nghe nhìn được lưu vào bộ nhớ đệm trước ngày 5 tháng 4 năm 2023 bằng cách truy xuất mã nhận dạng nội dung nghe nhìn mới từ các tài nguyên mẫu quảng cáo được liên kết hoặc tải tài sản lên lại. |
content |
Nội dung của thành phần. Đối với những thành phần được tải lên, nội dung là đường dẫn phân phát. |
AssetRole
Vai trò của thành phần này đối với mẫu quảng cáo.
| Enum | |
|---|---|
ASSET_ROLE_UNSPECIFIED |
Không chỉ định hoặc không xác định vai trò của tài sản trong phiên bản này. |
ASSET_ROLE_MAIN |
Thành phần này là thành phần chính của mẫu quảng cáo. |
ASSET_ROLE_BACKUP |
Tài sản này là tài sản dự phòng của mẫu quảng cáo. |
ASSET_ROLE_POLITE_LOAD |
Thành phần này là thành phần tải thông minh của mẫu quảng cáo. |
ASSET_ROLE_HEADLINE |
Dòng tiêu đề của mẫu quảng cáo gốc.
Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_LONG_HEADLINE |
Dòng tiêu đề dài của mẫu quảng cáo gốc.
Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_BODY |
Nội dung của mẫu quảng cáo gốc.
Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_LONG_BODY |
Văn bản nội dung dài của mẫu quảng cáo gốc.
Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_CAPTION_URL |
Một phiên bản ngắn gọn, thân thiện của URL trang đích để hiển thị trong mẫu quảng cáo. URL này giúp người dùng hình dung về trang web họ sẽ truy cập sau khi nhấp vào mẫu quảng cáo.
Ví dụ: nếu URL trang đích là "http://www.example.com/page", thì URL chú thích có thể là "example.com". Bạn không bắt buộc phải nhập giao thức (http://), nhưng URL không được chứa dấu cách hoặc ký tự đặc biệt. Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_CALL_TO_ACTION |
Văn bản sẽ dùng trên nút kêu gọi hành động của mẫu quảng cáo gốc.
Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_ADVERTISER_NAME |
Văn bản giúp nhận dạng nhà quảng cáo hoặc tên thương hiệu.
Vai trò này chỉ được hỗ trợ trong các
|
ASSET_ROLE_PRICE |
Giá mua ứng dụng của bạn trong Cửa hàng Google Play hoặc App Store của iOS (ví dụ: 5, 99 USD). Xin lưu ý rằng giá trị này không được tự động đồng bộ hoá với giá trị thực tế được nêu trong cửa hàng. Đây sẽ luôn là mẫu quảng cáo được cung cấp khi bạn lưu mẫu quảng cáo.
Các thành phần của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_ANDROID_APP_ID |
Mã nhận dạng của một ứng dụng Android trong Cửa hàng Google Play. Bạn có thể tìm thấy mã nhận dạng này trong URL của ứng dụng trên Cửa hàng Google Play sau "id". Ví dụ: trong Các thành phần của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_IOS_APP_ID |
Mã nhận dạng của một ứng dụng iOS trong Apple App Store. Bạn có thể tìm thấy mã nhận dạng này trong URL của Apple App Store dưới dạng chuỗi số ngay sau "id". Ví dụ: trong Các thành phần của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_RATING |
Mức phân loại của một ứng dụng trong Cửa hàng Google Play hoặc App Store của iOS. Xin lưu ý rằng giá trị này không được tự động đồng bộ hoá với điểm xếp hạng thực tế tại cửa hàng. Đây sẽ luôn là mẫu quảng cáo được cung cấp khi bạn lưu mẫu quảng cáo. Các thành phần của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_ICON |
Biểu tượng của một mẫu quảng cáo. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ASSET_ROLE_COVER_IMAGE |
Ảnh bìa của mẫu quảng cáo dạng video gốc. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ASSET_ROLE_BACKGROUND_COLOR |
Màu chính để sử dụng trong mẫu quảng cáo. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ASSET_ROLE_ACCENT_COLOR |
Màu nhấn để sử dụng trong mẫu quảng cáo. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ASSET_ROLE_REQUIRE_LOGO |
Mẫu quảng cáo có bắt buộc phải sử dụng một tài sản biểu trưng hay không. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ASSET_ROLE_REQUIRE_IMAGE |
Mẫu quảng cáo có bắt buộc phải sử dụng thành phần hình ảnh hay không. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ASSET_ROLE_ENABLE_ASSET_ENHANCEMENTS |
Liệu có thể áp dụng tính năng nâng cao thành phần cho mẫu quảng cáo hay không. Vai trò này chỉ được hỗ trợ và bắt buộc ở những
|
ExitEvent
Sự kiện lượt thoát của mẫu quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{
"type": enum ( |
| Trường | |
|---|---|
type |
Bắt buộc. Loại sự kiện thoát. |
url |
Bắt buộc. URL của trang đích sau khi nhấp vào sự kiện thoát. Bạn phải cung cấp thông tin này khi
|
name |
Không bắt buộc. Tên của thẻ nhấp của sự kiện thoát. Tên phải là duy nhất trong một mẫu quảng cáo. Để trống hoặc không đặt giá trị này cho những mẫu quảng cáo chỉ chứa thành phần hình ảnh. |
reportingName |
Không bắt buộc. Tên dùng để xác định sự kiện này trong báo cáo. Để trống hoặc không đặt giá trị này cho những mẫu quảng cáo chỉ chứa thành phần hình ảnh. |
ExitEventType
Loại sự kiện thoát.
| Enum | |
|---|---|
EXIT_EVENT_TYPE_UNSPECIFIED |
Loại sự kiện thoát không được chỉ định hoặc không xác định trong phiên bản này. |
EXIT_EVENT_TYPE_DEFAULT |
Sự kiện thoát là sự kiện mặc định. |
EXIT_EVENT_TYPE_BACKUP |
Sự kiện thoát là sự kiện thoát dự phòng. Có thể có nhiều sự kiện thoát dự phòng trong một mẫu quảng cáo. |
TimerEvent
Sự kiện bộ tính giờ của mẫu quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string, "reportingName": string } |
| Trường | |
|---|---|
name |
Bắt buộc. Tên của sự kiện hẹn giờ. |
reportingName |
Bắt buộc. Tên dùng để xác định sự kiện hẹn giờ này trong báo cáo. |
CounterEvent
Sự kiện bộ đếm của mẫu quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string, "reportingName": string } |
| Trường | |
|---|---|
name |
Bắt buộc. Tên của sự kiện bộ đếm. |
reportingName |
Bắt buộc. Tên dùng để xác định sự kiện bộ đếm này trong báo cáo. |
AudioVideoOffset
Thời lượng phát của một đoạn âm thanh hoặc video.
| Biểu diễn dưới dạng JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "percentage": string, "seconds": string // End of mutually exclusive fields. } |
| Trường | |
|---|---|
| Giá trị của độ lệch. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
percentage |
Không bắt buộc. Độ lệch tính bằng tỷ lệ phần trăm thời lượng của âm thanh hoặc video. |
seconds |
Không bắt buộc. Độ lệch tính bằng giây kể từ khi bắt đầu phát âm thanh hoặc video. |
| Kết thúc các trường loại trừ lẫn nhau. | |
UniversalAdId
Giá trị nhận dạng mẫu quảng cáo do một sổ đăng ký cung cấp và là giá trị riêng biệt trên tất cả các nền tảng. Đây là một phần của tiêu chuẩn VAST 4.0.
| Biểu diễn dưới dạng JSON |
|---|
{
"id": string,
"registry": enum ( |
| Trường | |
|---|---|
id |
Không bắt buộc. Giá trị nhận dạng riêng biệt của mẫu quảng cáo. |
registry |
Không bắt buộc. Sổ đăng ký cung cấp giá trị nhận dạng riêng biệt của mẫu quảng cáo. |
UniversalAdRegistry
Sổ đăng ký này cung cấp giá trị nhận dạng riêng biệt cho mẫu quảng cáo trong một Mã quảng cáo chung.
| Enum | |
|---|---|
UNIVERSAL_AD_REGISTRY_UNSPECIFIED |
Sổ đăng ký quảng cáo chung chưa được chỉ định hoặc không xác định trong phiên bản này. |
UNIVERSAL_AD_REGISTRY_OTHER |
Sử dụng một trình cung cấp tuỳ chỉnh để cung cấp Mã quảng cáo chung. |
UNIVERSAL_AD_REGISTRY_AD_ID |
Sử dụng Ad-ID để cung cấp Mã quảng cáo chung. |
UNIVERSAL_AD_REGISTRY_CLEARCAST |
Sử dụng clearcast.co.uk để cung cấp Mã quảng cáo chung. |
UNIVERSAL_AD_REGISTRY_DV360 |
Sử dụng Display & Video 360 để cung cấp Mã nhận dạng quảng cáo chung. |
UNIVERSAL_AD_REGISTRY_CM |
Sử dụng Campaign Manager 360 để cung cấp Mã nhận dạng quảng cáo chung. |
ThirdPartyUrl
URL theo dõi của bên thứ ba để theo dõi lượt tương tác với mẫu quảng cáo âm thanh hoặc mẫu quảng cáo dạng video.
| Biểu diễn dưới dạng JSON |
|---|
{
"type": enum ( |
| Trường | |
|---|---|
type |
Không bắt buộc. URL theo dõi cần theo dõi loại tương tác |
url |
Không bắt buộc. URL theo dõi được dùng để theo dõi lượt tương tác. Cung cấp một URL có đường dẫn hoặc chuỗi truy vấn không bắt buộc, bắt đầu bằng |
ThirdPartyUrlType
URL theo dõi của bên thứ ba cần theo dõi loại tương tác.
| Enum | |
|---|---|
THIRD_PARTY_URL_TYPE_UNSPECIFIED |
Loại URL của bên thứ ba chưa được chỉ định hoặc không xác định trong phiên bản này. |
THIRD_PARTY_URL_TYPE_IMPRESSION |
Được dùng để tính số lượt hiển thị của mẫu quảng cáo sau khi quá trình đệm âm thanh hoặc video hoàn tất. |
THIRD_PARTY_URL_TYPE_CLICK_TRACKING |
Dùng để theo dõi lượt nhấp của người dùng vào âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_START |
Được dùng để theo dõi số lần người dùng bắt đầu phát âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FIRST_QUARTILE |
Được dùng để theo dõi số lần âm thanh hoặc video phát đến 25% thời lượng. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT |
Được dùng để theo dõi số lần âm thanh hoặc video phát đến 50% thời lượng. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_THIRD_QUARTILE |
Được dùng để theo dõi số lần âm thanh hoặc video phát tới 75% thời lượng. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_COMPLETE |
Dùng để theo dõi số lần âm thanh hoặc video phát đến hết. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MUTE |
Được dùng để theo dõi số lần người dùng tắt tiếng âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE |
Được dùng để theo dõi số lần người dùng tạm dừng âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_REWIND |
Được dùng để theo dõi số lần người dùng phát lại âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_FULLSCREEN |
Được dùng để theo dõi số lần người dùng mở rộng trình phát sang chế độ toàn màn hình. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_STOP |
Dùng để theo dõi số lần người dùng dừng âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_CUSTOM |
Dùng để theo dõi số lần người dùng thực hiện một lượt nhấp tuỳ chỉnh, chẳng hạn như nhấp vào một điểm phát video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP |
Được dùng để theo dõi số lần âm thanh hoặc video bị bỏ qua. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS |
Được dùng để theo dõi số lần âm thanh hoặc video phát đến một khoảng thời gian được xác định bằng progressOffset. |
Chuyển mã
Biểu thị thông tin về tệp âm thanh hoặc video được chuyển mã.
| Biểu diễn dưới dạng JSON |
|---|
{
"name": string,
"mimeType": string,
"transcoded": boolean,
"dimensions": {
object ( |
| Trường | |
|---|---|
name |
Không bắt buộc. Tên của tệp được chuyển mã. |
mimeType |
Không bắt buộc. Loại MIME của tệp được chuyển mã. |
transcoded |
Không bắt buộc. Cho biết liệu quá trình chuyển mã có thành công hay không. |
dimensions |
Không bắt buộc. Kích thước của video được chuyển mã. |
bitRateKbps |
Không bắt buộc. Tốc độ bit chuyển mã của video được chuyển mã, tính bằng kilobit mỗi giây. |
frameRate |
Không bắt buộc. Tốc độ khung hình của video được chuyển mã, tính bằng khung hình/giây. |
audioBitRateKbps |
Không bắt buộc. Tốc độ bit của luồng âm thanh trong video được chuyển mã hoặc tốc độ bit của âm thanh được chuyển mã, tính bằng kilobit mỗi giây. |
audioSampleRateHz |
Không bắt buộc. Tốc độ lấy mẫu cho luồng âm thanh của video được chuyển mã hoặc tốc độ lấy mẫu cho âm thanh được chuyển mã, tính bằng hertz. |
fileSizeBytes |
Không bắt buộc. Kích thước của tệp được chuyển mã, tính bằng byte. |
CmTrackingAd
Quảng cáo theo dõi Campaign Manager 360.
| Biểu diễn dưới dạng JSON |
|---|
{ "cmPlacementId": string, "cmCreativeId": string, "cmAdId": string } |
| Trường | |
|---|---|
cmPlacementId |
Không bắt buộc. Mã vị trí của quảng cáo theo dõi Campaign Manager 360. |
cmCreativeId |
Không bắt buộc. Mã mẫu quảng cáo của quảng cáo theo dõi trên Campaign Manager 360. |
cmAdId |
Không bắt buộc. Mã quảng cáo của quảng cáo theo dõi Campaign Manager 360. |
ObaIcon
Biểu tượng OBA cho mẫu quảng cáo
| Biểu diễn dưới dạng JSON |
|---|
{ "resourceUrl": string, "resourceMimeType": string, "position": enum ( |
| Trường | |
|---|---|
resourceUrl |
Không bắt buộc. URL của tài nguyên biểu tượng OBA. |
resourceMimeType |
Không bắt buộc. Loại MIME của tài nguyên biểu tượng OBA. |
position |
Không bắt buộc. Vị trí của biểu tượng OBA trên mẫu quảng cáo. |
dimensions |
Không bắt buộc. Kích thước của biểu tượng OBA. |
program |
Không bắt buộc. Chương trình của biểu tượng OBA. Ví dụ: "Lựa chọn quảng cáo". |
landingPageUrl |
Bắt buộc. URL trang đích của biểu tượng OBA. Bạn chỉ được phép sử dụng URL của các miền sau:
|
clickTrackingUrl |
Bắt buộc. URL theo dõi lượt nhấp của biểu tượng OBA. Bạn chỉ được phép sử dụng URL của các miền sau:
|
viewTrackingUrl |
Bắt buộc. URL theo dõi lượt xem của biểu tượng OBA. Bạn chỉ được phép sử dụng URL của các miền sau:
|
ObaIconPosition
Vị trí của biểu tượng OBA trên mẫu quảng cáo.
| Enum | |
|---|---|
OBA_ICON_POSITION_UNSPECIFIED |
Bạn chưa chỉ định vị trí của biểu tượng OBA. |
OBA_ICON_POSITION_UPPER_RIGHT |
Ở phía trên bên phải của mẫu quảng cáo. |
OBA_ICON_POSITION_UPPER_LEFT |
Ở phía trên cùng bên trái của mẫu quảng cáo. |
OBA_ICON_POSITION_LOWER_RIGHT |
Ở phía dưới bên phải của mẫu quảng cáo. |
OBA_ICON_POSITION_LOWER_LEFT |
Ở phía dưới cùng bên trái của mẫu quảng cáo. |
ExpandingDirection
Hướng mở rộng của mẫu quảng cáo có thể mở rộng của bên thứ ba.
| Enum | |
|---|---|
EXPANDING_DIRECTION_UNSPECIFIED |
Bạn chưa chỉ định hướng mở rộng. |
EXPANDING_DIRECTION_NONE |
Không mở rộng theo hướng nào. |
EXPANDING_DIRECTION_UP |
Mở rộng lên trên. |
EXPANDING_DIRECTION_DOWN |
Mở rộng xuống dưới. |
EXPANDING_DIRECTION_LEFT |
Mở rộng sang trái. |
EXPANDING_DIRECTION_RIGHT |
Mở rộng sang phải. |
EXPANDING_DIRECTION_UP_AND_LEFT |
Mở rộng lên trên và sang trái. |
EXPANDING_DIRECTION_UP_AND_RIGHT |
Mở rộng lên trên và sang bên phải. |
EXPANDING_DIRECTION_DOWN_AND_LEFT |
Mở rộng xuống dưới và sang bên trái. |
EXPANDING_DIRECTION_DOWN_AND_RIGHT |
Mở rộng xuống dưới và sang bên phải. |
EXPANDING_DIRECTION_UP_OR_DOWN |
Mở rộng lên trên hoặc xuống dưới. |
EXPANDING_DIRECTION_LEFT_OR_RIGHT |
Mở rộng sang trái hoặc phải. |
EXPANDING_DIRECTION_ANY_DIAGONAL |
Có thể mở rộng theo hướng đường chéo bất kỳ. |
Phương thức |
|
|---|---|
|
Tạo mẫu quảng cáo mới. |
|
Xoá một mẫu quảng cáo. |
|
Nhận một mẫu quảng cáo. |
|
Liệt kê các mẫu quảng cáo của một nhà quảng cáo. |
|
Cập nhật mẫu quảng cáo hiện có. |