REST Resource: advertisers.adGroupAds

Tài nguyên: AdGroupAd

Một quảng cáo duy nhất được liên kết với một nhóm quảng cáo.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "advertiserId": string,
  "adGroupAdId": string,
  "adGroupId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "adUrls": [
    {
      object (AdUrl)
    }
  ],

  // Union field ad_details can be only one of the following:
  "displayVideoSourceAd": {
    object (DisplayVideoSourceAd)
  },
  "mastheadAd": {
    object (MastheadAd)
  },
  "inStreamAd": {
    object (InStreamAd)
  },
  "nonSkippableAd": {
    object (NonSkippableAd)
  },
  "bumperAd": {
    object (BumperAd)
  },
  "audioAd": {
    object (AudioAd)
  },
  "videoDiscoverAd": {
    object (VideoDiscoveryAd)
  },
  "videoPerformanceAd": {
    object (VideoPerformanceAd)
  }
  // End of list of possible types for union field ad_details.
}
Trường
name

string

Tên tài nguyên của quảng cáo.
advertiserId

string (int64 format)

Mã nhận dạng duy nhất của nhà quảng cáo mà quảng cáo thuộc về.
adGroupAdId

string (int64 format)

Mã nhận dạng duy nhất của quảng cáo. Do hệ thống chỉ định.
adGroupId

string (int64 format)

Mã nhận dạng riêng biệt của nhóm quảng cáo chứa quảng cáo.
displayName

string

Tên hiển thị của quảng cáo.

Phải được mã hoá UTF-8 với kích thước tối đa là 255 byte.
entityStatus

enum (EntityStatus)

Trạng thái thực thể của quảng cáo.
adUrls[]

object (AdUrl)

Danh sách URL mà quảng cáo sử dụng.
Trường nhóm ad_details. Thông tin chi tiết về quảng cáo. ad_details chỉ có thể là một trong những trạng thái sau:
displayVideoSourceAd

object (DisplayVideoSourceAd)

Thông tin chi tiết về một quảng cáo lấy từ mẫu quảng cáo trên Display & Video 360.
mastheadAd

object (MastheadAd)

Thông tin chi tiết về một quảng cáo được phân phát trên danh sách video trên Trang chủ của YouTube.
inStreamAd

object (InStreamAd)

Thông tin chi tiết về một quảng cáo trong luồng có thể bỏ qua sau 5 giây, được dùng cho mục tiêu tiếp thị về mức độ nhận biết thương hiệu hoặc phạm vi tiếp cận.
nonSkippableAd

object (NonSkippableAd)

Thông tin chi tiết về quảng cáo dạng video ngắn trong luồng phát không thể bỏ qua, có thời lượng từ 6 đến 15 giây, được dùng cho mục tiêu tiếp thị phạm vi tiếp cận.
bumperAd

object (BumperAd)

Thông tin chi tiết về một quảng cáo dạng video ngắn không thể bỏ qua, có thời lượng từ 6 giây trở xuống, được dùng để tăng phạm vi tiếp cận.
audioAd

object (AudioAd)

Thông tin chi tiết về một quảng cáo dạng âm thanh được dùng cho mục tiêu tiếp thị phạm vi tiếp cận.
videoDiscoverAd

object (VideoDiscoveryAd)

Thông tin chi tiết về quảng cáo quảng bá video xuất hiện ở những nơi khám phá.
videoPerformanceAd

object (VideoPerformanceAd)

Thông tin chi tiết về một quảng cáo được dùng trong chiến dịch Video thúc đẩy hành động để thúc đẩy hành động cho doanh nghiệp, dịch vụ hoặc sản phẩm.

DisplayVideoSourceAd

Quảng cáo lấy từ mẫu quảng cáo trên DV360.

Biểu diễn dưới dạng JSON 
{
  "creativeId": string
}
Trường
creativeId

string (int64 format)

Mã nhận dạng của mẫu quảng cáo nguồn.

MastheadAd

Thông tin chi tiết về quảng cáo trên đầu trang chủ.

Biểu diễn dưới dạng JSON 
{
  "video": {
    object (YoutubeVideoDetails)
  },
  "headline": string,
  "description": string,
  "videoAspectRatio": enum (VideoAspectRatio),
  "autoplayVideoStartMillisecond": string,
  "autoplayVideoDuration": string,
  "callToActionButtonLabel": string,
  "callToActionFinalUrl": string,
  "callToActionTrackingUrl": string,
  "showChannelArt": boolean,
  "companionYoutubeVideos": [
    {
      object (YoutubeVideoDetails)
    }
  ]
}
Trường
video

object (YoutubeVideoDetails)

Video trên YouTube mà quảng cáo sử dụng.
headline

string

Dòng tiêu đề của quảng cáo.
description

string

Nội dung mô tả của quảng cáo.
videoAspectRatio

enum (VideoAspectRatio)

Tỷ lệ khung hình của video tự động phát trên YouTube trong quảng cáo trên đầu trang chủ.
autoplayVideoStartMillisecond

string (int64 format)

Khoảng thời gian tính bằng mili giây sau đó video sẽ bắt đầu phát.
autoplayVideoDuration

string (Duration format)

Khoảng thời gian video sẽ tự động phát.

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 "s". Ví dụ: "3.5s".
callToActionButtonLabel

string

Văn bản trên nút kêu gọi hành động.
callToActionFinalUrl

string

URL đích cho nút gọi hành động.
callToActionTrackingUrl

string

URL theo dõi cho nút kêu gọi hành động.
showChannelArt

boolean

Có hiển thị hình nền hoặc biểu ngữ xuất hiện ở đầu trang YouTube hay không.
companionYoutubeVideos[]

object (YoutubeVideoDetails)

Video xuất hiện bên cạnh Quảng cáo trên đầu trang chủ trên máy tính. Không được quá 2.

YoutubeVideoDetails

Thông tin chi tiết về một video trên YouTube.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "unavailableReason": enum (VideoUnavailableReason)
}
Trường
id

string

Mã video trên YouTube mà bạn có thể tìm kiếm trên trang web YouTube.
unavailableReason

enum (VideoUnavailableReason)

Lý do không có dữ liệu video.

VideoUnavailableReason

Các lý do có thể khiến một video không xem được.

Enum
VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Không xác định hoặc không chỉ định.
VIDEO_UNAVAILABLE_REASON_PRIVATE Video ở chế độ riêng tư.
VIDEO_UNAVAILABLE_REASON_DELETED Video bị xoá.

VideoAspectRatio

Các tỷ lệ khung hình có thể có của một video trên YouTube.

Enum
VIDEO_ASPECT_RATIO_UNSPECIFIED Chưa chỉ định hoặc không xác định.
VIDEO_ASPECT_RATIO_WIDESCREEN Video bị kéo giãn và phần trên cùng cũng như dưới cùng bị cắt.
VIDEO_ASPECT_RATIO_FIXED_16_9 Video sử dụng tỷ lệ khung hình cố định là 16:9.

InStreamAd

Thông tin chi tiết về quảng cáo trong luồng phát.

Biểu diễn dưới dạng JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Trường
commonInStreamAttribute

object (CommonInStreamAttribute)

Thuộc tính quảng cáo chung.
customParameters

map (key: string, value: string)

Tham số tuỳ chỉnh để truyền các giá trị tuỳ chỉnh đến mẫu URL theo dõi.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CommonInStreamAttribute

Các thuộc tính chung cho quảng cáo trong luồng phát, quảng cáo không thể bỏ qua và quảng cáo đệm.

Biểu diễn dưới dạng JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabel": string,
  "actionHeadline": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "companionBanner": {
    object (ImageAsset)
  }
}
Trường
displayUrl

string

Địa chỉ trang web xuất hiện cùng với quảng cáo.
finalUrl

string

Địa chỉ URL của trang web mà mọi người sẽ được chuyển đến sau khi nhấp vào quảng cáo.
trackingUrl

string

Địa chỉ URL được tải ở chế độ nền cho mục đích theo dõi.
actionButtonLabel

string

Văn bản trên nút kêu gọi hành động.
actionHeadline

string

Dòng tiêu đề của biểu ngữ kêu gọi hành động.
video

object (YoutubeVideoDetails)

Video trên YouTube của quảng cáo.
companionBanner

object (ImageAsset)

Hình ảnh xuất hiện bên cạnh quảng cáo dạng video.

ImageAsset

Siêu dữ liệu của một thành phần hình ảnh.

Biểu diễn dưới dạng JSON 
{
  "mimeType": string,
  "fullSize": {
    object (Dimensions)
  },
  "fileSize": string
}
Trường
mimeType

string

Loại MIME của thành phần hình ảnh.
fullSize

object (Dimensions)

Siêu dữ liệu cho hình ảnh này ở kích thước ban đầu.
fileSize

string (int64 format)

Kích thước tệp của thành phần hình ảnh tính bằng byte.

NonSkippableAd

Thông tin chi tiết về quảng cáo không thể bỏ qua.

Biểu diễn dưới dạng JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  },
  "customParameters": {
    string: string,
    ...
  }
}
Trường
commonInStreamAttribute

object (CommonInStreamAttribute)

Thuộc tính quảng cáo chung.
customParameters

map (key: string, value: string)

Tham số tuỳ chỉnh để truyền các giá trị tuỳ chỉnh đến mẫu URL theo dõi.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

BumperAd

Thông tin chi tiết về quảng cáo đệm.

Biểu diễn dưới dạng JSON 
{
  "commonInStreamAttribute": {
    object (CommonInStreamAttribute)
  }
}
Trường
commonInStreamAttribute

object (CommonInStreamAttribute)

Thuộc tính quảng cáo chung.

AudioAd

Thông tin chi tiết về quảng cáo dạng âm thanh.

Biểu diễn dưới dạng JSON 
{
  "displayUrl": string,
  "finalUrl": string,
  "trackingUrl": string,
  "video": {
    object (YoutubeVideoDetails)
  }
}
Trường
displayUrl

string

Địa chỉ trang web xuất hiện cùng với quảng cáo.
finalUrl

string

Địa chỉ URL của trang web mà mọi người sẽ được chuyển đến sau khi nhấp vào quảng cáo.
trackingUrl

string

Địa chỉ URL được tải ở chế độ nền cho mục đích theo dõi.
video

object (YoutubeVideoDetails)

Video trên YouTube của quảng cáo.

VideoDiscoveryAd

Thông tin chi tiết về quảng cáo khám phá dạng video.

Biểu diễn dưới dạng JSON 
{
  "headline": string,
  "description1": string,
  "description2": string,
  "video": {
    object (YoutubeVideoDetails)
  },
  "thumbnail": enum (Thumbnail)
}
Trường
headline

string

Dòng tiêu đề của quảng cáo.
description1

string

Dòng văn bản đầu tiên của quảng cáo.
description2

string

Dòng văn bản thứ hai cho quảng cáo.
video

object (YoutubeVideoDetails)

Video trên YouTube mà quảng cáo đó quảng bá.
thumbnail

enum (Thumbnail)

Hình thu nhỏ được dùng trong quảng cáo.

Hình thu nhỏ

Các lựa chọn có thể có về hình thu nhỏ trong quảng cáo khám phá dạng video.

Enum
THUMBNAIL_UNSPECIFIED Không xác định hoặc không chỉ định.
THUMBNAIL_DEFAULT Hình thu nhỏ mặc định có thể được tạo tự động hoặc do người dùng tải lên.
THUMBNAIL_1 Hình thu nhỏ 1, được tạo từ video.
THUMBNAIL_2 Hình thu nhỏ 2, được tạo từ video.
THUMBNAIL_3 Hình thu nhỏ 3, được tạo từ video.

VideoPerformanceAd

Thông tin chi tiết về quảng cáo dạng video nâng cao hiệu suất.

Biểu diễn dưới dạng JSON 
{
  "finalUrl": string,
  "trackingUrl": string,
  "actionButtonLabels": [
    string
  ],
  "headlines": [
    string
  ],
  "longHeadlines": [
    string
  ],
  "descriptions": [
    string
  ],
  "displayUrlBreadcrumb1": string,
  "displayUrlBreadcrumb2": string,
  "domain": string,
  "videos": [
    {
      object (YoutubeVideoDetails)
    }
  ],
  "customParameters": {
    string: string,
    ...
  },
  "companionBanners": [
    {
      object (ImageAsset)
    }
  ]
}
Trường
finalUrl

string

Địa chỉ URL của trang web mà mọi người sẽ được chuyển đến sau khi nhấp vào quảng cáo.
trackingUrl

string

Địa chỉ URL được tải ở chế độ nền cho mục đích theo dõi.
actionButtonLabels[]

string

Danh sách thành phần văn bản xuất hiện trên nút kêu gọi hành động.
headlines[]

string

Danh sách dòng tiêu đề xuất hiện trên biểu ngữ kêu gọi hành động.
longHeadlines[]

string

Danh sách dòng tiêu đề độc lập xuất hiện trên biểu ngữ kêu gọi hành động.
descriptions[]

string

Danh sách nội dung mô tả xuất hiện trên biểu ngữ kêu gọi hành động.
displayUrlBreadcrumb1

string

Phần đầu tiên sau miền trong URL hiển thị.
displayUrlBreadcrumb2

string

Phần thứ hai sau miền trong URL hiển thị.
domain

string

Miền của URL hiển thị.
videos[]

object (YoutubeVideoDetails)

Danh sách thành phần video trên YouTube mà quảng cáo này sử dụng.
customParameters

map (key: string, value: string)

Tham số tuỳ chỉnh để truyền các giá trị tuỳ chỉnh đến mẫu URL theo dõi.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
companionBanners[]

object (ImageAsset)

Danh sách biểu ngữ đi kèm mà quảng cáo này sử dụng.

AdUrl

Các URL bổ sung liên quan đến quảng cáo, bao gồm cả các beacon.

Biểu diễn dưới dạng JSON 
{
  "type": enum (AdUrlType),
  "url": string
}
Trường
type

enum (AdUrlType)

Loại URL quảng cáo.
url

string

Giá trị chuỗi URL.

AdUrlType

Các loại URL quảng cáo có thể có.

Enum
AD_URL_TYPE_UNSPECIFIED Không xác định hoặc không chỉ định.
AD_URL_TYPE_BEACON_IMPRESSION Một pixel theo dõi 1x1 để ping khi một lượt hiển thị của mẫu quảng cáo được phân phối.
AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Báo hiệu lượt hiển thị DCM có thể mở rộng. Tại thời điểm phân phát, chỉ số này được mở rộng thành một số beacon.
AD_URL_TYPE_BEACON_CLICK URL theo dõi để ping khi sự kiện nhấp chuột được kích hoạt.
AD_URL_TYPE_BEACON_SKIP URL theo dõi để ping khi sự kiện bỏ qua được kích hoạt.

Phương thức

get

 Lấy một quảng cáo trong nhóm quảng cáo.

list

 Liệt kê quảng cáo của nhóm quảng cáo.