Skip to content

Commit 0e758cc

Browse files
feat(displayvideo): update the api
#### displayvideo:v2 The following keys were added: - schemas.ImageAsset.properties.fileSize.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.fullSize.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.mimeType.readOnly (Total Keys: 1) - schemas.YoutubeVideoDetails.properties.id.readOnly (Total Keys: 1) - schemas.YoutubeVideoDetails.properties.videoAssetId (Total Keys: 2) #### displayvideo:v3 The following keys were added: - schemas.AdGroup.properties.adGroupId.readOnly (Total Keys: 1) - schemas.AdGroup.properties.advertiserId.readOnly (Total Keys: 1) - schemas.AdGroup.properties.name.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.advertiserId.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.fileSize.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.fullSize.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.mimeType.readOnly (Total Keys: 1) - schemas.YoutubeVideoDetails.properties.id.readOnly (Total Keys: 1) - schemas.YoutubeVideoDetails.properties.videoAssetId (Total Keys: 2) #### displayvideo:v4 The following keys were added: - schemas.AdGroup.properties.adGroupId.readOnly (Total Keys: 1) - schemas.AdGroup.properties.advertiserId.readOnly (Total Keys: 1) - schemas.AdGroup.properties.name.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.audioAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.bumperAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.displayVideoSourceAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.inStreamAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.mastheadAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.nonSkippableAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.videoDiscoverAd.readOnly (Total Keys: 1) - schemas.AdGroupAd.properties.videoPerformanceAd.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.fileSize.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.fullSize.readOnly (Total Keys: 1) - schemas.ImageAsset.properties.mimeType.readOnly (Total Keys: 1) - schemas.YoutubeVideoDetails.properties.id.readOnly (Total Keys: 1) - schemas.YoutubeVideoDetails.properties.videoAssetId (Total Keys: 2)
1 parent a75b5b6 commit 0e758cc

8 files changed

Lines changed: 329 additions & 237 deletions

docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html

Lines changed: 56 additions & 40 deletions
Large diffs are not rendered by default.

docs/dyn/displayvideo_v3.advertisers.adGroupAds.html

Lines changed: 60 additions & 44 deletions
Large diffs are not rendered by default.

docs/dyn/displayvideo_v3.advertisers.adGroups.html

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -487,10 +487,10 @@ <h3>Method Details</h3>
487487
An object of the form:
488488

489489
{ # A single ad group associated with a line item.
490-
&quot;adGroupFormat&quot;: &quot;A String&quot;, # The format of the ads in the ad group.
491-
&quot;adGroupId&quot;: &quot;A String&quot;, # The unique ID of the ad group. Assigned by the system.
492-
&quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the advertiser the ad group belongs to.
493-
&quot;bidStrategy&quot;: { # 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+
&quot;adGroupFormat&quot;: &quot;A String&quot;, # Required. The format of the ads in the ad group.
491+
&quot;adGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the ad group. Assigned by the system.
492+
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the ad group belongs to.
493+
&quot;bidStrategy&quot;: { # 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.
494494
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
495495
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
496496
},
@@ -513,11 +513,11 @@ <h3>Method Details</h3>
513513
&quot;value&quot;: &quot;A String&quot;, # 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.
514514
},
515515
},
516-
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
517-
&quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group&#x27;s parent line item is not active, the ad group can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
518-
&quot;lineItemId&quot;: &quot;A String&quot;, # The unique ID of the line item that the ad group belongs to.
519-
&quot;name&quot;: &quot;A String&quot;, # The resource name of the ad group.
520-
&quot;productFeedData&quot;: { # The details of product feed. # The settings of the product feed in this ad group.
516+
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
517+
&quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group&#x27;s parent line item is not active, the ad group can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
518+
&quot;lineItemId&quot;: &quot;A String&quot;, # Required. The unique ID of the line item that the ad group belongs to.
519+
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the ad group.
520+
&quot;productFeedData&quot;: { # The details of product feed. # Optional. The settings of the product feed in this ad group.
521521
&quot;isFeedDisabled&quot;: True or False, # Whether the product feed has opted-out of showing products.
522522
&quot;productMatchDimensions&quot;: [ # A list of dimensions used to match products.
523523
{ # A dimension used to match products.
@@ -530,7 +530,7 @@ <h3>Method Details</h3>
530530
],
531531
&quot;productMatchType&quot;: &quot;A String&quot;, # How products are selected by the product feed.
532532
},
533-
&quot;targetingExpansion&quot;: { # 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+
&quot;targetingExpansion&quot;: { # 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.
534534
&quot;audienceExpansionLevel&quot;: &quot;A String&quot;, # 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.
535535
&quot;audienceExpansionSeedListExcluded&quot;: 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.
536536
&quot;enableOptimizedTargeting&quot;: 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>
559559
{
560560
&quot;adGroups&quot;: [ # The list of ad groups. This list will be absent if empty.
561561
{ # A single ad group associated with a line item.
562-
&quot;adGroupFormat&quot;: &quot;A String&quot;, # The format of the ads in the ad group.
563-
&quot;adGroupId&quot;: &quot;A String&quot;, # The unique ID of the ad group. Assigned by the system.
564-
&quot;advertiserId&quot;: &quot;A String&quot;, # The unique ID of the advertiser the ad group belongs to.
565-
&quot;bidStrategy&quot;: { # 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+
&quot;adGroupFormat&quot;: &quot;A String&quot;, # Required. The format of the ads in the ad group.
563+
&quot;adGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the ad group. Assigned by the system.
564+
&quot;advertiserId&quot;: &quot;A String&quot;, # Output only. The unique ID of the advertiser the ad group belongs to.
565+
&quot;bidStrategy&quot;: { # 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.
566566
&quot;fixedBid&quot;: { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
567567
&quot;bidAmountMicros&quot;: &quot;A String&quot;, # The fixed bid amount, in micros of the advertiser&#x27;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.
568568
},
@@ -585,11 +585,11 @@ <h3>Method Details</h3>
585585
&quot;value&quot;: &quot;A String&quot;, # 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.
586586
},
587587
},
588-
&quot;displayName&quot;: &quot;A String&quot;, # The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
589-
&quot;entityStatus&quot;: &quot;A String&quot;, # Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group&#x27;s parent line item is not active, the ad group can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
590-
&quot;lineItemId&quot;: &quot;A String&quot;, # The unique ID of the line item that the ad group belongs to.
591-
&quot;name&quot;: &quot;A String&quot;, # The resource name of the ad group.
592-
&quot;productFeedData&quot;: { # The details of product feed. # The settings of the product feed in this ad group.
588+
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.
589+
&quot;entityStatus&quot;: &quot;A String&quot;, # Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group&#x27;s parent line item is not active, the ad group can&#x27;t spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
590+
&quot;lineItemId&quot;: &quot;A String&quot;, # Required. The unique ID of the line item that the ad group belongs to.
591+
&quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the ad group.
592+
&quot;productFeedData&quot;: { # The details of product feed. # Optional. The settings of the product feed in this ad group.
593593
&quot;isFeedDisabled&quot;: True or False, # Whether the product feed has opted-out of showing products.
594594
&quot;productMatchDimensions&quot;: [ # A list of dimensions used to match products.
595595
{ # A dimension used to match products.
@@ -602,7 +602,7 @@ <h3>Method Details</h3>
602602
],
603603
&quot;productMatchType&quot;: &quot;A String&quot;, # How products are selected by the product feed.
604604
},
605-
&quot;targetingExpansion&quot;: { # 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+
&quot;targetingExpansion&quot;: { # 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.
606606
&quot;audienceExpansionLevel&quot;: &quot;A String&quot;, # 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.
607607
&quot;audienceExpansionSeedListExcluded&quot;: 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.
608608
&quot;enableOptimizedTargeting&quot;: 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

Comments
 (0)