REST Resource: advertisers.adGroups

资源：AdGroup

与订单项关联的单个广告组。

JSON 表示法 
{
  "name": string,
  "advertiserId": string,
  "adGroupId": string,
  "lineItemId": string,
  "displayName": string,
  "adGroupFormat": enum (AdGroupFormat),
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "entityStatus": enum (EntityStatus),
  "targetingExpansion": {
    object (TargetingExpansionConfig)
  },
  "productFeedData": {
    object (ProductFeedData)
  },
  "adGroupInventoryControl": {
    object (AdGroupInventoryControl)
  }
}
字段
name

string

仅限输出。标识符。广告组的资源名称。
advertiserId

string (int64 format)

仅限输出。广告组所属广告客户的唯一 ID。
adGroupId

string (int64 format)

仅限输出。广告组的唯一 ID。由系统分配。
lineItemId

string (int64 format)

必需。不可变。广告组所属订单项的唯一 ID。
displayName

string

必需。广告组的显示名称。

必须采用 UTF-8 编码，大小上限为 255 字节。
adGroupFormat

enum (AdGroupFormat)

必需。不可变。相应广告组中广告的格式。
bidStrategy

object (BiddingStrategy)

可选。广告组使用的出价策略。出价策略中只能使用 youtubeAndPartnersBid 和 demandGenBid 字段。
entityStatus

enum (EntityStatus)

必需。控制广告组是否可以花费预算并对广告资源出价。

如果广告组的父订单项处于非有效状态，即使广告组本身的状态为 ENTITY_STATUS_ACTIVE，也无法支出预算。
targetingExpansion

object (TargetingExpansionConfig)

可选。相应广告组的优化型定位设置。
productFeedData

object (ProductFeedData)

可选。相应广告组中商品 Feed 的设置。
adGroupInventoryControl

object (AdGroupInventoryControl)

可选。需求开发广告组必需的。指定广告组的广告资源控制设置。

AdGroupFormat

广告组的格式。

枚举
AD_GROUP_FORMAT_UNSPECIFIED 此版本中未指定格式值，或格式值未知。
AD_GROUP_FORMAT_IN_STREAM 插播广告。
AD_GROUP_FORMAT_VIDEO_DISCOVERY 信息流广告。
AD_GROUP_FORMAT_BUMPER 导视广告。
AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM 不可跳过的插播广告。
AD_GROUP_FORMAT_AUDIO 不可跳过的插播音频广告。
AD_GROUP_FORMAT_RESPONSIVE 自适应广告。
AD_GROUP_FORMAT_REACH 有效覆盖面广告组，包括插播广告和导视广告。
AD_GROUP_FORMAT_MASTHEAD 在 YouTube 首页顶部广告位展示的标头广告。
AD_GROUP_FORMAT_DEMAND_GEN

需求开发广告。

ProductFeedData

商品 Feed 的详细信息。

JSON 表示法 
{
  "productMatchType": enum (ProductMatchType),
  "productMatchDimensions": [
    {
      object (ProductMatchDimension)
    }
  ],
  "isFeedDisabled": boolean
}
字段
productMatchType

enum (ProductMatchType)

商品 Feed 如何选择商品。
productMatchDimensions[]

object (ProductMatchDimension)

用于匹配产品的维度列表。
isFeedDisabled

boolean

商品 Feed 是否已选择停止展示商品。

ProductMatchType

商品匹配方式的类型。

枚举
PRODUCT_MATCH_TYPE_UNSPECIFIED 未指定或未知。
PRODUCT_MATCH_TYPE_ALL_PRODUCTS 所有商品均已匹配。
PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS 已选择指定商品。
PRODUCT_MATCH_TYPE_CUSTOM_LABEL 按自定义标签匹配商品。

ProductMatchDimension

用于匹配商品的维度。

JSON 表示法 
{

  // Union field dimension can be only one of the following:
  "productOfferId": string,
  "customLabel": {
    object (CustomLabel)
  }
  // End of list of possible types for union field dimension.
}
字段
联合字段 dimension。用于匹配商品的维度和值。dimension 只能是下列其中一项：
productOfferId

string

要与具有相同优惠 ID 的商品匹配的商品优惠的 ID。
customLabel

object (CustomLabel)

要匹配具有相应标签的所有商品的自定义标签。

CustomLabel

自定义标签的键和值。

JSON 表示法 
{
  "key": enum (CustomLabelKey),
  "value": string
}
字段
key

enum (CustomLabelKey)

标签的键。
value

string

标签的值。

CustomLabelKey

自定义标签的键

枚举
CUSTOM_LABEL_KEY_UNSPECIFIED 未指定或未知。
CUSTOM_LABEL_KEY_0 键索引 0。
CUSTOM_LABEL_KEY_1 关键指数 1。
CUSTOM_LABEL_KEY_2 关键指数 2.
CUSTOM_LABEL_KEY_3 关键指数 3。
CUSTOM_LABEL_KEY_4 关键指数 4.

AdGroupInventoryControl

广告组的广告资源控制设置。

JSON 表示法 
{

  // Union field inventory_controls can be only one of the following:
  "adGroupInventoryStrategy": enum (AdGroupInventoryStrategy),
  "selectedInventories": {
    object (SelectedInventories)
  }
  // End of list of possible types for union field inventory_controls.
}
字段
联合字段 inventory_controls。广告组的广告资源控制设置。inventory_controls 只能是下列其中一项：
adGroupInventoryStrategy

enum (AdGroupInventoryStrategy)

广告资源策略。
selectedInventories

object (SelectedInventories)

所选的广告资源。

AdGroupInventoryStrategy

相应广告组的广告资源策略。

枚举
AD_GROUP_INVENTORY_STRATEGY_UNSPECIFIED 未指定或未知。
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_AND_DISPLAY_NETWORK_INVENTORY 相应广告组已选择启用所有 Google 和展示广告网络广告资源。
AD_GROUP_INVENTORY_STRATEGY_ALL_GOOGLE_INVENTORY 相应广告组已选择在所有 Google 广告资源中展示。

SelectedInventories

广告组的广告资源控制设置。

JSON 表示法 
{
  "allowYoutubeStream": boolean,
  "allowYoutubeShorts": boolean,
  "allowYoutubeFeed": boolean,
  "allowDiscover": boolean,
  "allowGmail": boolean,
  "allowGoogleDisplayNetwork": boolean
}
字段
allowYoutubeStream

boolean

广告组是否选择启用 YouTube 插播广告资源。
allowYoutubeShorts

boolean

广告组是否已选择启用 YouTube Shorts 广告资源。
allowYoutubeFeed

boolean

广告组是否已选择启用 YouTube 信息流广告资源。
allowDiscover

boolean

相应广告组是否已选择启用 Discover 广告资源。
allowGmail

boolean

相应广告组是否已选择启用 Gmail 广告资源。
allowGoogleDisplayNetwork

boolean

广告组是否已选择启用 Google 展示广告网络广告资源。

方法

bulkEditAssignedTargetingOptions

 批量修改多个广告组的定位选项。

bulkListAssignedTargetingOptions

 列出了为多种定位类型中的多个广告组分配的定位选项。

create

 创建新广告组。

delete

 删除广告组。

get

 获取广告组。

list

 列出广告组。

patch

 更新现有广告组。