- Resource: AdGroup
- AdGroupFormat
- ProductFeedData
- ProductMatchType
- ProductMatchDimension
- CustomLabel
- CustomLabelKey
- Methods
Resource: AdGroup
A single ad group associated with a line item.
JSON representation |
---|
{ "name": string, "advertiserId": string, "adGroupId": string, "lineItemId": string, "displayName": string, "adGroupFormat": enum ( |
Fields | |
---|---|
name |
The resource name of the ad group. |
advertiserId |
The unique ID of the advertiser the ad group belongs to. |
adGroupId |
The unique ID of the ad group. Assigned by the system. |
lineItemId |
The unique ID of the line item that the ad group belongs to. |
displayName |
The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes. |
adGroupFormat |
The format of the ads in the ad group. |
bidStrategy |
The bidding strategy used by the ad group. Only the |
entityStatus |
Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is |
targetingExpansion |
The optimized targeting settings of the ad group. |
productFeedData |
The settings of the product feed in this ad group. |
AdGroupFormat
The format of the ad group.
Enums | |
---|---|
AD_GROUP_FORMAT_UNSPECIFIED |
Format value is not specified or is unknown in this version. |
AD_GROUP_FORMAT_IN_STREAM |
In-stream ads. |
AD_GROUP_FORMAT_VIDEO_DISCOVERY |
In-feed ads. |
AD_GROUP_FORMAT_BUMPER |
Bumper ads. |
AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM |
Non-skippable in-stream ads. |
AD_GROUP_FORMAT_AUDIO |
Non-skippable in-stream audio ads. |
AD_GROUP_FORMAT_RESPONSIVE |
Responsive ads. |
AD_GROUP_FORMAT_REACH |
Effective reach ad groups, including in-stream and bumper ads. |
AD_GROUP_FORMAT_MASTHEAD |
Masthead Ad that is surfaced on the top slot on the YouTube homepage. |
ProductFeedData
The details of product feed.
JSON representation |
---|
{ "productMatchType": enum ( |
Fields | |
---|---|
productMatchType |
How products are selected by the product feed. |
productMatchDimensions[] |
A list of dimensions used to match products. |
isFeedDisabled |
Whether the product feed has opted-out of showing products. |
ProductMatchType
The types of the ways to match products.
Enums | |
---|---|
PRODUCT_MATCH_TYPE_UNSPECIFIED |
Not specified or unknown. |
PRODUCT_MATCH_TYPE_ALL_PRODUCTS |
All the products are matched. |
PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS |
Specific products are selected. |
PRODUCT_MATCH_TYPE_CUSTOM_LABEL |
Match products by their custom labels. |
ProductMatchDimension
A dimension used to match products.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field dimension . The dimension and value on which to match the product. dimension can be only one of the following: |
|
productOfferId |
The ID of the product offer to match with a product with the same offer ID. |
customLabel |
The custom label to match all the products with the label. |
CustomLabel
The key and value of a custom label.
JSON representation |
---|
{
"key": enum ( |
Fields | |
---|---|
key |
The key of the label. |
value |
The value of the label. |
CustomLabelKey
The key of the custom label
Enums | |
---|---|
CUSTOM_LABEL_KEY_UNSPECIFIED |
Not specified or unknown. |
CUSTOM_LABEL_KEY_0 |
Key index 0. |
CUSTOM_LABEL_KEY_1 |
Key index 1. |
CUSTOM_LABEL_KEY_2 |
Key index 2. |
CUSTOM_LABEL_KEY_3 |
Key index 3. |
CUSTOM_LABEL_KEY_4 |
Key index 4. |
Methods |
|
---|---|
|
Lists assigned targeting options for multiple ad groups across targeting types. |
|
Gets an ad group. |
|
Lists ad groups. |