You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/displayvideo_v3.advertisers.adGroups.html
+20-20Lines changed: 20 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -487,10 +487,10 @@ <h3>Method Details</h3>
487
487
An object of the form:
488
488
489
489
{ # A single ad group associated with a line item.
490
-
"adGroupFormat": "A String", # The format of the ads in the ad group.
491
-
"adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
492
-
"advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
493
-
"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
490
+
"adGroupFormat": "A String", # Required. The format of the ads in the ad group.
491
+
"adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
492
+
"advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
493
+
"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
494
494
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
495
495
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
496
496
},
@@ -513,11 +513,11 @@ <h3>Method Details</h3>
513
513
"value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
514
514
},
515
515
},
516
-
"displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
517
-
"entityStatus": "A String", # 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 `ENTITY_STATUS_ACTIVE`.
518
-
"lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
519
-
"name": "A String", # The resource name of the ad group.
520
-
"productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
516
+
"displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
517
+
"entityStatus": "A String", # Required. 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 `ENTITY_STATUS_ACTIVE`.
518
+
"lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
519
+
"name": "A String", # Output only. Identifier. The resource name of the ad group.
520
+
"productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
521
521
"isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
522
522
"productMatchDimensions": [ # A list of dimensions used to match products.
523
523
{ # A dimension used to match products.
@@ -530,7 +530,7 @@ <h3>Method Details</h3>
530
530
],
531
531
"productMatchType": "A String", # How products are selected by the product feed.
532
532
},
533
-
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
533
+
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
534
534
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
535
535
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
536
536
"enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
@@ -559,10 +559,10 @@ <h3>Method Details</h3>
559
559
{
560
560
"adGroups": [ # The list of ad groups. This list will be absent if empty.
561
561
{ # A single ad group associated with a line item.
562
-
"adGroupFormat": "A String", # The format of the ads in the ad group.
563
-
"adGroupId": "A String", # The unique ID of the ad group. Assigned by the system.
564
-
"advertiserId": "A String", # The unique ID of the advertiser the ad group belongs to.
565
-
"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy.
562
+
"adGroupFormat": "A String", # Required. The format of the ads in the ad group.
563
+
"adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system.
564
+
"advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to.
565
+
"bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy.
566
566
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
567
567
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
568
568
},
@@ -585,11 +585,11 @@ <h3>Method Details</h3>
585
585
"value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
586
586
},
587
587
},
588
-
"displayName": "A String", # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
589
-
"entityStatus": "A String", # 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 `ENTITY_STATUS_ACTIVE`.
590
-
"lineItemId": "A String", # The unique ID of the line item that the ad group belongs to.
591
-
"name": "A String", # The resource name of the ad group.
592
-
"productFeedData": { # The details of product feed. # The settings of the product feed in this ad group.
588
+
"displayName": "A String", # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
589
+
"entityStatus": "A String", # Required. 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 `ENTITY_STATUS_ACTIVE`.
590
+
"lineItemId": "A String", # Required. The unique ID of the line item that the ad group belongs to.
591
+
"name": "A String", # Output only. Identifier. The resource name of the ad group.
592
+
"productFeedData": { # The details of product feed. # Optional. The settings of the product feed in this ad group.
593
593
"isFeedDisabled": True or False, # Whether the product feed has opted-out of showing products.
594
594
"productMatchDimensions": [ # A list of dimensions used to match products.
595
595
{ # A dimension used to match products.
@@ -602,7 +602,7 @@ <h3>Method Details</h3>
602
602
],
603
603
"productMatchType": "A String", # How products are selected by the product feed.
604
604
},
605
-
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
605
+
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
606
606
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
607
607
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
608
608
"enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
0 commit comments