- 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.
| 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 sở hữu mẫu quảng cáo. |
creativeId |
Chỉ có đầu ra. Mã nhận dạng duy nhấ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í 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 cập nhật lần gần đây nhất, do người dùng hoặc hệ thống (ví dụ: 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 mẫu quảng cáo có phải là mẫu quảng cáo động 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. 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, 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. 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 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ối thoát. Bạn có thể thêm một lối thoát vào mẫu quảng cáo của mình theo bất kỳ cách nào sau đây:
|
timerEvents[] |
Không bắt buộc. Sự kiện tuỳ chỉnh của bộ tính giờ cho mẫu quảng cáo đa phương tiện. Bộ tính giờ 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 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ới độ 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ới độ 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 bạn đã đặt |
companionCreativeIds[] |
Không bắt buộc. Mã 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ó (với 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 đồng hành xuất hiện xung quanh trình phát video trong khi video đang phát và vẫn hiển thị sau khi video kết thúc. Mẫu quảng cáo chứa Trường này chỉ được hỗ trợ cho
|
skippable |
Không bắt buộc. Liệu 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. Trường này là 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 tính là một lượt xem. Trường này là 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 cơ quan đăng ký cung cấp, 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 tên 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 các 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. Chuyển mã â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ể. Những tệp chuyển mã này giúp hệ thống của nhà xuất bản có thêm lựa chọn cho mỗi lượt hiển thị trên video của bạn, đồng thời đảm bảo phân phát tệp phù hợp 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ợ trong
|
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. URL phải bắt đầu bằng Chỉ URL chuẩn, không có thẻ IMG hoặc SCRIPT. Trường này chỉ có thể ghi trong
|
jsTrackerUrl |
Không bắt buộc. URL đo lườ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ợ. Trường này chỉ có thể ghi trong
|
cmTrackingAd |
Không bắt buộc. Quảng cáo được 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ợ trong
|
thirdPartyTag |
Không bắt buộc. Thẻ của bên thứ ba gốc đượ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 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 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ác 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ệ cho mẫu quảng cáo thẻ của bên thứ ba. Mẫu quảng cáo 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 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ệ cho mẫu quảng cáo thẻ của bên thứ ba. Mẫu quảng cáo 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 mẫu quảng cáo sẽ đợi ping trả về để phân bổ. Chỉ hợp lệ khi sử dụng quảng cáo được theo dõi của Campaign Manager 360 với tham 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ệ cho 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 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ệ cho mẫu quảng cáo mở rộng của bên thứ ba. Mẫu quảng cáo mở rộng của bên thứ ba là mẫu quảng cáo có nguồn lưu trữ 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 người dùng di chuột qua. Không bắt buộc và chỉ hợp lệ cho mẫu quảng cáo mở rộng của bên thứ ba. Mẫu quảng cáo mở rộng của bên thứ ba là mẫu quảng cáo có nguồn lưu trữ 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ệ cho 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ệ cho 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ã của các mục hàng mà mẫu quảng cáo này liên kết. Để liên kết mẫu quảng cáo với 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 có hỗ trợ MP3. Chỉ có đầu ra và chỉ hợp lệ cho mẫu quảng cáo dạng â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 có hỗ trợ OGG. Chỉ có đầu ra và chỉ hợp lệ cho mẫu quảng cáo dạng â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
|
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 phân phát ở những khu vực có quy định về việc 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 tạo và lưu trữ mẫu quảng cáo.
| Enum | |
|---|---|
HOSTING_SOURCE_UNSPECIFIED |
Nguồn lưu trữ không được chỉ định hoặc không xác định trong phiên bản này. |
HOSTING_SOURCE_CM |
Mẫu quảng cáo được đồng bộ hoá từ Campaign Manager 360. 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ẫ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 dịch vụ lưu trữ này nếu
|
HOSTING_SOURCE_HOSTED |
Một mẫu quảng cáo được tạo trong DV360 và được lưu trữ trong Campaign Manager 360. Các phương thức tạo và cập nhật được hỗ trợ cho loại dịch vụ lưu trữ này nếu
|
HOSTING_SOURCE_RICH_MEDIA |
Mẫu quảng cáo đa phương tiện được tạo trong Studio và được lưu trữ trong Campaign Manager 360. 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
Xem xét trạng thái của mẫu quảng cáo.
| Biểu diễn dưới dạng JSON |
|---|
{ "approvalStatus": enum ( |
| Trường | |
|---|---|
approvalStatus |
Đại diện cho sự 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 về |
creativeAndLandingPageReviewStatus |
Trạng thái xem xét mẫu quảng cáo và trang đích cho mẫu quảng cáo. |
contentAndPolicyReviewStatus |
Trạng thái xem xét nội dung và đánh giá việc tuân thủ chính sách cho mẫu quảng cáo. |
exchangeReviewStatuses[] |
Trạng thái xem xét của sàn giao dịch đối với 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 thể phân phát. |
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, đồng thời có thể phân phát, nhưng đang chờ đánh giá việc tuân thủ chính sách 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 đánh giá việc tuân thủ chính sách về nội dung đều được phê duyệt. Mẫu quảng cáo có thể phân phát. |
APPROVAL_STATUS_REJECTED_NOT_SERVABLE |
Có một vấn đề với mẫu quảng cáo mà bạn phải khắc phục thì mẫu quảng cáo mới có thể phân phát. |
ReviewStatus
Các loại trạng thái xem xét 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 sàn giao dịch đối với mẫu quảng cáo.
| 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 của sàn giao dịch. |
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 nội dung đa 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 nội dung đa 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 đa phương tiệ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 đa phương tiệ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 lại thành phần lên. |
content |
Nội dung của thành phần. Đối với 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 |
Vai trò của thành phần không được chỉ định hoặc không xác định 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 |
Thành phần này là thành phầ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
|
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
|
ASSET_ROLE_BODY |
Văn bản nội dung của mẫu quảng cáo gốc.
Vai trò này chỉ được hỗ trợ trong
|
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
|
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 cho người dùng biết trang web mà 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". Giao thức (http://) là không bắt buộc, 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
|
ASSET_ROLE_CALL_TO_ACTION |
Văn bản 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
|
ASSET_ROLE_ADVERTISER_NAME |
Văn bản giúp nhận diện nhà quảng cáo hoặc tên thương hiệu.
Vai trò này chỉ được hỗ trợ trong
|
ASSET_ROLE_PRICE |
Giá mua ứng dụng của bạn trong Cửa hàng Google Play hoặc cửa hàng ứng dụng 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 đăng trong cửa hàng. Đây sẽ luôn là mã nhận dạng được cung cấp khi lưu mẫu quảng cáo.
Tài sả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 phần "id". Ví dụ: trong Tài sản của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_IOS_APP_ID |
Mã của một ứng dụng iOS trong cửa hàng ứng dụng của Apple. 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 Tài sản của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_RATING |
Điểm xếp hạng của một ứng dụng trong Cửa hàng Google Play hoặc cửa hàng ứng dụng 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ế trong cửa hàng. Đây sẽ luôn là mã nhận dạng được cung cấp khi lưu mẫu quảng cáo. Tài sản của vai trò này ở chế độ chỉ có thể đọc. |
ASSET_ROLE_ICON |
Biểu tượng của mẫu quảng cáo. Vai trò này chỉ được hỗ trợ và bắt buộc trong
|
ASSET_ROLE_COVER_IMAGE |
Ảnh bìa của mẫu quảng cáo video gốc. Vai trò này chỉ được hỗ trợ và bắt buộc trong
|
ASSET_ROLE_BACKGROUND_COLOR |
Màu chính dùng trong mẫu quảng cáo. Vai trò này chỉ được hỗ trợ và bắt buộc trong
|
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 trong
|
ASSET_ROLE_REQUIRE_LOGO |
Mẫu quảng cáo có phải sử dụng thành phần biểu trưng hay không. Vai trò này chỉ được hỗ trợ và bắt buộc trong
|
ASSET_ROLE_REQUIRE_IMAGE |
Liệu mẫu quảng cáo 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 trong
|
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 trong
|
ExitEvent
Sự kiện 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 của 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 chuột 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à một 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 trong 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 truy cập. |
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 â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 theo tỷ lệ phần trăm của thời lượng âm thanh hoặc video. |
seconds |
Không bắt buộc. Độ lệch tính bằng giây so với thời điểm bắt đầu của â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 cơ quan đă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. Cơ quan đăng ký cung cấp giá trị nhận dạng riêng biệt cho mẫu quảng cáo. |
UniversalAdRegistry
Sổ đăng ký cung cấp giá trị nhận dạng mẫu quảng cáo riêng biệt trong Mã quảng cáo chung.
| Enum | |
|---|---|
UNIVERSAL_AD_REGISTRY_UNSPECIFIED |
Sổ đăng ký quảng cáo chung không được chỉ định hoặc không xác định trong phiên bản này. |
UNIVERSAL_AD_REGISTRY_OTHER |
Sử dụng 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 các lượt tương tác với mẫu quảng cáo dạng âm thanh hoặc video.
| Biểu diễn dưới dạng JSON |
|---|
{
"type": enum ( |
| Trường | |
|---|---|
type |
Không bắt buộc. Loại tương tác cần được theo dõi bằng URL theo dõi |
url |
Không bắt buộc. URL theo dõi 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
Loại tương tác cần được theo dõi bằng URL theo dõi của bên thứ ba.
| Enum | |
|---|---|
THIRD_PARTY_URL_TYPE_UNSPECIFIED |
Loại URL của bên thứ ba không được chỉ định hoặc không xác định được trong phiên bản này. |
THIRD_PARTY_URL_TYPE_IMPRESSION |
Dùng để tính số lượt hiển thị của mẫu quảng cáo sau khi quá trình lưu vào vùng đệ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 |
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 |
Dùng để theo dõi số lần âm thanh hoặc video phát tới 25% thời lượng. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_MIDPOINT |
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 |
Dùng để theo dõi số lần âm thanh hoặc video phát đến 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 |
Dùng để theo dõi số lần người dùng tắt âm thanh hoặc video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PAUSE |
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 |
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 |
Dùng để theo dõi số lần người dùng mở rộng trình phát sang kích thước 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 sóng video. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_SKIP |
Dùng để theo dõi số lần âm thanh hoặc video bị bỏ qua. |
THIRD_PARTY_URL_TYPE_AUDIO_VIDEO_PROGRESS |
Dùng để theo dõi số lần âm thanh hoặc video phát đến một độ lệch do progressOffset xác định. |
Chuyển mã
Đại diện cho thông tin về tệp âm thanh hoặc video đã 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 đã chuyển mã. |
mimeType |
Không bắt buộc. Loại MIME của tệp đã 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/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 cho luồng âm thanh của video đã chuyển mã hoặc tốc độ bit cho âm thanh đã chuyển mã, tính bằng kilobit/giây. |
audioSampleRateHz |
Không bắt buộc. Tốc độ lấy mẫu cho luồng âm thanh của video đã chuyển mã hoặc tốc độ lấy mẫu cho âm thanh đã chuyển mã, tính bằng hertz. |
fileSizeBytes |
Không bắt buộc. Kích thước của tệp đã chuyển mã, tính bằng byte. |
CmTrackingAd
Quảng cáo theo dõi của 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 trong Campaign Manager 360. |
cmCreativeId |
Không bắt buộc. Mã mẫu quảng cáo của quảng cáo được 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 được theo dõi trong 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. Chỉ cho phép 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. Chỉ cho phép 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. Chỉ cho phép 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 |
Vị trí biểu tượng OBA không được chỉ định. |
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 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 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 |
Hướng mở rộng không được chỉ định. |
EXPANDING_DIRECTION_NONE |
Không mở rộng theo bất kỳ 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 bên 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 bên trái hoặc bên phải. |
EXPANDING_DIRECTION_ANY_DIAGONAL |
Có thể mở rộng theo hướng chéo bất kỳ. |
Phương thức |
|
|---|---|
|
Tạo mẫu quảng cáo mới. |
|
Xoá mẫu quảng cáo. |
|
Lấy 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ó. |