diff --git a/api_names_out.yaml b/api_names_out.yaml index 5faef43aa..61013b259 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -90227,6 +90227,7 @@ "/discovery:v1/key": key "/discovery:v1/quotaUser": quota_user "/discovery:v1/userIp": user_ip +"/displayvideo:v1/ActivateManualTriggerRequest": activate_manual_trigger_request "/displayvideo:v1/ActiveViewVideoViewabilityMetricConfig": active_view_video_viewability_metric_config "/displayvideo:v1/ActiveViewVideoViewabilityMetricConfig/displayName": display_name "/displayvideo:v1/ActiveViewVideoViewabilityMetricConfig/minimumDuration": minimum_duration @@ -90640,6 +90641,7 @@ "/displayvideo:v1/DayAndTimeAssignedTargetingOptionDetails/endHour": end_hour "/displayvideo:v1/DayAndTimeAssignedTargetingOptionDetails/startHour": start_hour "/displayvideo:v1/DayAndTimeAssignedTargetingOptionDetails/timeZoneResolution": time_zone_resolution +"/displayvideo:v1/DeactivateManualTriggerRequest": deactivate_manual_trigger_request "/displayvideo:v1/DeleteAssignedTargetingOptionsRequest": delete_assigned_targeting_options_request "/displayvideo:v1/DeleteAssignedTargetingOptionsRequest/assignedTargetingOptionIds": assigned_targeting_option_ids "/displayvideo:v1/DeleteAssignedTargetingOptionsRequest/assignedTargetingOptionIds/assigned_targeting_option_id": assigned_targeting_option_id @@ -90668,6 +90670,7 @@ "/displayvideo:v1/DoubleVerify/avoidedAgeRatings": avoided_age_ratings "/displayvideo:v1/DoubleVerify/avoidedAgeRatings/avoided_age_rating": avoided_age_rating "/displayvideo:v1/DoubleVerify/brandSafetyCategories": brand_safety_categories +"/displayvideo:v1/DoubleVerify/customSegmentId": custom_segment_id "/displayvideo:v1/DoubleVerify/displayViewability": display_viewability "/displayvideo:v1/DoubleVerify/fraudInvalidTraffic": fraud_invalid_traffic "/displayvideo:v1/DoubleVerify/videoViewability": video_viewability @@ -90824,6 +90827,8 @@ "/displayvideo:v1/InsertionOrderBudgetSegment/dateRange": date_range "/displayvideo:v1/InsertionOrderBudgetSegment/description": description "/displayvideo:v1/IntegralAdScience": integral_ad_science +"/displayvideo:v1/IntegralAdScience/customSegmentId": custom_segment_id +"/displayvideo:v1/IntegralAdScience/customSegmentId/custom_segment_id": custom_segment_id "/displayvideo:v1/IntegralAdScience/displayViewability": display_viewability "/displayvideo:v1/IntegralAdScience/excludeUnrateable": exclude_unrateable "/displayvideo:v1/IntegralAdScience/excludedAdFraudRisk": excluded_ad_fraud_risk @@ -90909,6 +90914,7 @@ "/displayvideo:v1/LineItem/partnerCosts": partner_costs "/displayvideo:v1/LineItem/partnerCosts/partner_cost": partner_cost "/displayvideo:v1/LineItem/partnerRevenueModel": partner_revenue_model +"/displayvideo:v1/LineItem/targetingExpansion": targeting_expansion "/displayvideo:v1/LineItem/updateTime": update_time "/displayvideo:v1/LineItem/warningMessages": warning_messages "/displayvideo:v1/LineItem/warningMessages/warning_message": warning_message @@ -90919,6 +90925,7 @@ "/displayvideo:v1/LineItemFlight": line_item_flight "/displayvideo:v1/LineItemFlight/dateRange": date_range "/displayvideo:v1/LineItemFlight/flightDateType": flight_date_type +"/displayvideo:v1/LineItemFlight/triggerId": trigger_id "/displayvideo:v1/ListAdvertiserAssignedTargetingOptionsResponse": list_advertiser_assigned_targeting_options_response "/displayvideo:v1/ListAdvertiserAssignedTargetingOptionsResponse/assignedTargetingOptions": assigned_targeting_options "/displayvideo:v1/ListAdvertiserAssignedTargetingOptionsResponse/assignedTargetingOptions/assigned_targeting_option": assigned_targeting_option @@ -90991,6 +90998,10 @@ "/displayvideo:v1/ListLocationListsResponse/locationLists": location_lists "/displayvideo:v1/ListLocationListsResponse/locationLists/location_list": location_list "/displayvideo:v1/ListLocationListsResponse/nextPageToken": next_page_token +"/displayvideo:v1/ListManualTriggersResponse": list_manual_triggers_response +"/displayvideo:v1/ListManualTriggersResponse/manualTriggers": manual_triggers +"/displayvideo:v1/ListManualTriggersResponse/manualTriggers/manual_trigger": manual_trigger +"/displayvideo:v1/ListManualTriggersResponse/nextPageToken": next_page_token "/displayvideo:v1/ListNegativeKeywordListsResponse": list_negative_keyword_lists_response "/displayvideo:v1/ListNegativeKeywordListsResponse/negativeKeywordLists": negative_keyword_lists "/displayvideo:v1/ListNegativeKeywordListsResponse/negativeKeywordLists/negative_keyword_list": negative_keyword_list @@ -91028,6 +91039,14 @@ "/displayvideo:v1/LookbackWindow": lookback_window "/displayvideo:v1/LookbackWindow/clickDays": click_days "/displayvideo:v1/LookbackWindow/impressionDays": impression_days +"/displayvideo:v1/ManualTrigger": manual_trigger +"/displayvideo:v1/ManualTrigger/activationDurationMinutes": activation_duration_minutes +"/displayvideo:v1/ManualTrigger/advertiserId": advertiser_id +"/displayvideo:v1/ManualTrigger/displayName": display_name +"/displayvideo:v1/ManualTrigger/latestActivationTime": latest_activation_time +"/displayvideo:v1/ManualTrigger/name": name +"/displayvideo:v1/ManualTrigger/state": state +"/displayvideo:v1/ManualTrigger/triggerId": trigger_id "/displayvideo:v1/MaximizeSpendBidStrategy": maximize_spend_bid_strategy "/displayvideo:v1/MaximizeSpendBidStrategy/customBiddingAlgorithmId": custom_bidding_algorithm_id "/displayvideo:v1/MaximizeSpendBidStrategy/maxAverageCpmBidAmountMicros": max_average_cpm_bid_amount_micros @@ -91178,6 +91197,9 @@ "/displayvideo:v1/SubExchangeAssignedTargetingOptionDetails/targetingOptionId": targeting_option_id "/displayvideo:v1/SubExchangeTargetingOptionDetails": sub_exchange_targeting_option_details "/displayvideo:v1/SubExchangeTargetingOptionDetails/displayName": display_name +"/displayvideo:v1/TargetingExpansionConfig": targeting_expansion_config +"/displayvideo:v1/TargetingExpansionConfig/excludeFirstPartyAudience": exclude_first_party_audience +"/displayvideo:v1/TargetingExpansionConfig/targetingExpansionLevel": targeting_expansion_level "/displayvideo:v1/TargetingOption": targeting_option "/displayvideo:v1/TargetingOption/ageRangeDetails": age_range_details "/displayvideo:v1/TargetingOption/appCategoryDetails": app_category_details @@ -91463,6 +91485,27 @@ "/displayvideo:v1/displayvideo.advertisers.locationLists.patch/advertiserId": advertiser_id "/displayvideo:v1/displayvideo.advertisers.locationLists.patch/locationListId": location_list_id "/displayvideo:v1/displayvideo.advertisers.locationLists.patch/updateMask": update_mask +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.activate": activate_manual_trigger +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.activate/advertiserId": advertiser_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.activate/triggerId": trigger_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.create": create_advertiser_manual_trigger +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.create/advertiserId": advertiser_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.deactivate": deactivate_manual_trigger +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.deactivate/advertiserId": advertiser_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.deactivate/triggerId": trigger_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.get": get_advertiser_manual_trigger +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.get/advertiserId": advertiser_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.get/triggerId": trigger_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.list": list_advertiser_manual_triggers +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.list/advertiserId": advertiser_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.list/filter": filter +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.list/orderBy": order_by +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.list/pageSize": page_size +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.list/pageToken": page_token +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.patch": patch_advertiser_manual_trigger +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.patch/advertiserId": advertiser_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.patch/triggerId": trigger_id +"/displayvideo:v1/displayvideo.advertisers.manualTriggers.patch/updateMask": update_mask "/displayvideo:v1/displayvideo.advertisers.negativeKeywordLists.create": create_advertiser_negative_keyword_list "/displayvideo:v1/displayvideo.advertisers.negativeKeywordLists.create/advertiserId": advertiser_id "/displayvideo:v1/displayvideo.advertisers.negativeKeywordLists.delete": delete_advertiser_negative_keyword_list diff --git a/generated/google/apis/displayvideo_v1.rb b/generated/google/apis/displayvideo_v1.rb index fad9355e2..4b4ed3dd8 100644 --- a/generated/google/apis/displayvideo_v1.rb +++ b/generated/google/apis/displayvideo_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/display-video/ module DisplayvideoV1 VERSION = 'V1' - REVISION = '20201015' + REVISION = '20201030' # Create, see, edit, and permanently delete your Display & Video 360 entities and reports AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video' diff --git a/generated/google/apis/displayvideo_v1/classes.rb b/generated/google/apis/displayvideo_v1/classes.rb index 8cbc719fb..81966a6bb 100644 --- a/generated/google/apis/displayvideo_v1/classes.rb +++ b/generated/google/apis/displayvideo_v1/classes.rb @@ -22,6 +22,19 @@ module Google module Apis module DisplayvideoV1 + # Request message for ManualTriggerService.ActivateManualTrigger. + class ActivateManualTriggerRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Configuration for custom Active View video viewability metrics. class ActiveViewVideoViewabilityMetricConfig include Google::Apis::Core::Hashable @@ -3235,6 +3248,19 @@ module Google end end + # Request message for ManualTriggerService.DeactivateManualTrigger. + class DeactivateManualTriggerRequest + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # A request listing which assigned targeting options of a given targeting type # should be deleted. class DeleteAssignedTargetingOptionsRequest @@ -3457,6 +3483,14 @@ module Google # @return [Google::Apis::DisplayvideoV1::DoubleVerifyBrandSafetyCategories] attr_accessor :brand_safety_categories + # The custom segment ID provided by DoubleVerify. The ID must start with "51" + # and consist of eight digits. Custom segment id cannot be specified along with + # any of the following fields: * brand_safety_categories * avoided_age_ratings * + # app_star_rating * fraud_invalid_traffic + # Corresponds to the JSON property `customSegmentId` + # @return [Fixnum] + attr_accessor :custom_segment_id + # Details of DoubleVerify display viewability settings. # Corresponds to the JSON property `displayViewability` # @return [Google::Apis::DisplayvideoV1::DoubleVerifyDisplayViewability] @@ -3481,6 +3515,7 @@ module Google @app_star_rating = args[:app_star_rating] if args.key?(:app_star_rating) @avoided_age_ratings = args[:avoided_age_ratings] if args.key?(:avoided_age_ratings) @brand_safety_categories = args[:brand_safety_categories] if args.key?(:brand_safety_categories) + @custom_segment_id = args[:custom_segment_id] if args.key?(:custom_segment_id) @display_viewability = args[:display_viewability] if args.key?(:display_viewability) @fraud_invalid_traffic = args[:fraud_invalid_traffic] if args.key?(:fraud_invalid_traffic) @video_viewability = args[:video_viewability] if args.key?(:video_viewability) @@ -4690,6 +4725,12 @@ module Google class IntegralAdScience include Google::Apis::Core::Hashable + # The custom segment ID provided by Integral Ad Science. The ID must be between ` + # 1000001` and `1999999`, inclusive. + # Corresponds to the JSON property `customSegmentId` + # @return [Array] + attr_accessor :custom_segment_id + # Display Viewability section (applicable to display line items only). # Corresponds to the JSON property `displayViewability` # @return [String] @@ -4762,6 +4803,7 @@ module Google # Update properties of this object def update!(**args) + @custom_segment_id = args[:custom_segment_id] if args.key?(:custom_segment_id) @display_viewability = args[:display_viewability] if args.key?(:display_viewability) @exclude_unrateable = args[:exclude_unrateable] if args.key?(:exclude_unrateable) @excluded_ad_fraud_risk = args[:excluded_ad_fraud_risk] if args.key?(:excluded_ad_fraud_risk) @@ -5304,6 +5346,13 @@ module Google # @return [Google::Apis::DisplayvideoV1::PartnerRevenueModel] attr_accessor :partner_revenue_model + # Settings that control the targeting expansion of the line item. Targeting + # expansion allows the line item to reach a larger audience based on the + # original audience list and the targeting expansion level. + # Corresponds to the JSON property `targetingExpansion` + # @return [Google::Apis::DisplayvideoV1::TargetingExpansionConfig] + attr_accessor :targeting_expansion + # Output only. The timestamp when the line item was last updated. Assigned by # the system. # Corresponds to the JSON property `updateTime` @@ -5342,6 +5391,7 @@ module Google @pacing = args[:pacing] if args.key?(:pacing) @partner_costs = args[:partner_costs] if args.key?(:partner_costs) @partner_revenue_model = args[:partner_revenue_model] if args.key?(:partner_revenue_model) + @targeting_expansion = args[:targeting_expansion] if args.key?(:targeting_expansion) @update_time = args[:update_time] if args.key?(:update_time) @warning_messages = args[:warning_messages] if args.key?(:warning_messages) end @@ -5404,6 +5454,15 @@ module Google # @return [String] attr_accessor :flight_date_type + # The ID of the manual trigger associated with the line item. * Required when + # flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER`. Must not be set + # otherwise. * A line item's flight dates are inherited from its parent + # insertion order. * Active line items will spend when the selected trigger is + # activated within the parent insertion order's flight dates. + # Corresponds to the JSON property `triggerId` + # @return [Fixnum] + attr_accessor :trigger_id + def initialize(**args) update!(**args) end @@ -5412,6 +5471,7 @@ module Google def update!(**args) @date_range = args[:date_range] if args.key?(:date_range) @flight_date_type = args[:flight_date_type] if args.key?(:flight_date_type) + @trigger_id = args[:trigger_id] if args.key?(:trigger_id) end end @@ -5907,6 +5967,33 @@ module Google end end + # + class ListManualTriggersResponse + include Google::Apis::Core::Hashable + + # The list of manual triggers. This list will be absent if empty. + # Corresponds to the JSON property `manualTriggers` + # @return [Array] + attr_accessor :manual_triggers + + # A token to retrieve the next page of results. Pass this value in the + # page_token field in the subsequent call to `ListManualTriggers` method to + # retrieve the next page of results. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @manual_triggers = args[:manual_triggers] if args.key?(:manual_triggers) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + # Response message for NegativeKeywordListService.ListNegativeKeywordLists. class ListNegativeKeywordListsResponse include Google::Apis::Core::Hashable @@ -6172,6 +6259,66 @@ module Google end end + # A single manual trigger in Display & Video 360 (DV360). + class ManualTrigger + include Google::Apis::Core::Hashable + + # Required. The maximum duration of each activation in minutes. Must be between + # 1 and 360 inclusive. After this duration, the trigger will be automatically + # deactivated. + # Corresponds to the JSON property `activationDurationMinutes` + # @return [Fixnum] + attr_accessor :activation_duration_minutes + + # Required. Immutable. The unique ID of the advertiser that the manual trigger + # belongs to. + # Corresponds to the JSON property `advertiserId` + # @return [Fixnum] + attr_accessor :advertiser_id + + # Required. The display name of the manual trigger. Must be UTF-8 encoded with a + # maximum size of 240 bytes. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. The timestamp of the trigger's latest activation. + # Corresponds to the JSON property `latestActivationTime` + # @return [String] + attr_accessor :latest_activation_time + + # Output only. The resource name of the manual trigger. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The state of the manual trigger. Will be set to the `INACTIVE` + # state upon creation. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + # Output only. The unique ID of the manual trigger. + # Corresponds to the JSON property `triggerId` + # @return [Fixnum] + attr_accessor :trigger_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @activation_duration_minutes = args[:activation_duration_minutes] if args.key?(:activation_duration_minutes) + @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) + @display_name = args[:display_name] if args.key?(:display_name) + @latest_activation_time = args[:latest_activation_time] if args.key?(:latest_activation_time) + @name = args[:name] if args.key?(:name) + @state = args[:state] if args.key?(:state) + @trigger_id = args[:trigger_id] if args.key?(:trigger_id) + end + end + # A strategy that automatically adjusts the bid to optimize a specified # performance goal while spending the full budget. class MaximizeSpendBidStrategy @@ -7474,6 +7621,37 @@ module Google end end + # Settings that control the targeting expansion of the line item. Targeting + # expansion allows the line item to reach a larger audience based on the + # original audience list and the targeting expansion level. + class TargetingExpansionConfig + include Google::Apis::Core::Hashable + + # Required. Whether to exclude first party audiences from targeting. Similar + # audiences of the excluded first party lists will not be excluded. Only + # applicable when a first-party audience is positively targeted (directly or + # included in a combined audience), otherwise this selection will be ignored. + # Corresponds to the JSON property `excludeFirstPartyAudience` + # @return [Boolean] + attr_accessor :exclude_first_party_audience + alias_method :exclude_first_party_audience?, :exclude_first_party_audience + + # Required. Magnitude of expansion for applicable targeting under this line item. + # Corresponds to the JSON property `targetingExpansionLevel` + # @return [String] + attr_accessor :targeting_expansion_level + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @exclude_first_party_audience = args[:exclude_first_party_audience] if args.key?(:exclude_first_party_audience) + @targeting_expansion_level = args[:targeting_expansion_level] if args.key?(:targeting_expansion_level) + end + end + # Represents a single targeting option, which is a targetable concept in DV360. class TargetingOption include Google::Apis::Core::Hashable diff --git a/generated/google/apis/displayvideo_v1/representations.rb b/generated/google/apis/displayvideo_v1/representations.rb index a4b7283c5..83e09a004 100644 --- a/generated/google/apis/displayvideo_v1/representations.rb +++ b/generated/google/apis/displayvideo_v1/representations.rb @@ -22,6 +22,12 @@ module Google module Apis module DisplayvideoV1 + class ActivateManualTriggerRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ActiveViewVideoViewabilityMetricConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -496,6 +502,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DeactivateManualTriggerRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DeleteAssignedTargetingOptionsRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -958,6 +970,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListManualTriggersResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListNegativeKeywordListsResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1012,6 +1030,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ManualTrigger + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MaximizeSpendBidStrategy class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1240,6 +1264,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TargetingExpansionConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TargetingOption class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1342,6 +1372,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ActivateManualTriggerRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class ActiveViewVideoViewabilityMetricConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2211,6 +2247,12 @@ module Google end end + class DeactivateManualTriggerRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class DeleteAssignedTargetingOptionsRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2281,6 +2323,7 @@ module Google collection :avoided_age_ratings, as: 'avoidedAgeRatings' property :brand_safety_categories, as: 'brandSafetyCategories', class: Google::Apis::DisplayvideoV1::DoubleVerifyBrandSafetyCategories, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyBrandSafetyCategories::Representation + property :custom_segment_id, :numeric_string => true, as: 'customSegmentId' property :display_viewability, as: 'displayViewability', class: Google::Apis::DisplayvideoV1::DoubleVerifyDisplayViewability, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyDisplayViewability::Representation property :fraud_invalid_traffic, as: 'fraudInvalidTraffic', class: Google::Apis::DisplayvideoV1::DoubleVerifyFraudInvalidTraffic, decorator: Google::Apis::DisplayvideoV1::DoubleVerifyFraudInvalidTraffic::Representation @@ -2615,6 +2658,7 @@ module Google class IntegralAdScience # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :custom_segment_id, as: 'customSegmentId' property :display_viewability, as: 'displayViewability' property :exclude_unrateable, as: 'excludeUnrateable' property :excluded_ad_fraud_risk, as: 'excludedAdFraudRisk' @@ -2774,6 +2818,8 @@ module Google property :partner_revenue_model, as: 'partnerRevenueModel', class: Google::Apis::DisplayvideoV1::PartnerRevenueModel, decorator: Google::Apis::DisplayvideoV1::PartnerRevenueModel::Representation + property :targeting_expansion, as: 'targetingExpansion', class: Google::Apis::DisplayvideoV1::TargetingExpansionConfig, decorator: Google::Apis::DisplayvideoV1::TargetingExpansionConfig::Representation + property :update_time, as: 'updateTime' collection :warning_messages, as: 'warningMessages' end @@ -2794,6 +2840,7 @@ module Google property :date_range, as: 'dateRange', class: Google::Apis::DisplayvideoV1::DateRange, decorator: Google::Apis::DisplayvideoV1::DateRange::Representation property :flight_date_type, as: 'flightDateType' + property :trigger_id, :numeric_string => true, as: 'triggerId' end end @@ -2959,6 +3006,15 @@ module Google end end + class ListManualTriggersResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :manual_triggers, as: 'manualTriggers', class: Google::Apis::DisplayvideoV1::ManualTrigger, decorator: Google::Apis::DisplayvideoV1::ManualTrigger::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + class ListNegativeKeywordListsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3041,6 +3097,19 @@ module Google end end + class ManualTrigger + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :activation_duration_minutes, :numeric_string => true, as: 'activationDurationMinutes' + property :advertiser_id, :numeric_string => true, as: 'advertiserId' + property :display_name, as: 'displayName' + property :latest_activation_time, as: 'latestActivationTime' + property :name, as: 'name' + property :state, as: 'state' + property :trigger_id, :numeric_string => true, as: 'triggerId' + end + end + class MaximizeSpendBidStrategy # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3385,6 +3454,14 @@ module Google end end + class TargetingExpansionConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :exclude_first_party_audience, as: 'excludeFirstPartyAudience' + property :targeting_expansion_level, as: 'targetingExpansionLevel' + end + end + class TargetingOption # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/displayvideo_v1/service.rb b/generated/google/apis/displayvideo_v1/service.rb index ea0f1ae86..491f6b67b 100644 --- a/generated/google/apis/displayvideo_v1/service.rb +++ b/generated/google/apis/displayvideo_v1/service.rb @@ -1608,15 +1608,16 @@ module Google # used on all other fields must be `EQUALS (=)`. * Supported fields: - ` # campaignId` - `displayName` - `insertionOrderId` - `entityStatus` - ` # lineItemId` - `lineItemType` - `flight.dateRange.endDate` (input formatted as - # YYYY-MM-DD) - `warningMessages` Examples: * All line items under an insertion - # order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or ` - # ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an - # advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus=" - # ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * - # All line items whose flight dates end before March 28, 2019: `flight.dateRange. - # endDate<"2019-03-28"` * All line items that have `NO_VALID_CREATIVE` in ` - # warningMessages`: `warningMessages:"NO_VALID_CREATIVE"` The length of this - # field should be no more than 500 characters. + # YYYY-MM-DD) - `warningMessages` - `flight.triggerId` Examples: * All line + # items under an insertion order: `insertionOrderId="1234"` * All ` + # ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and ` + # LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus= + # "ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND + # lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items whose flight + # dates end before March 28, 2019: `flight.dateRange.endDate<"2019-03-28"` * All + # line items that have `NO_VALID_CREATIVE` in `warningMessages`: ` + # warningMessages:"NO_VALID_CREATIVE"` The length of this field should be no + # more than 500 characters. # @param [String] order_by # Field by which to sort the list. Acceptable values are: * "displayName" ( # default) * "entityStatus" * “flight.dateRange.endDate” The default sorting @@ -2219,6 +2220,245 @@ module Google execute_or_queue_command(command, &block) end + # Activates a manual trigger. Each activation of the manual trigger must be at + # least 5 minutes apart, otherwise an error will be returned. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser that the manual trigger belongs. + # @param [Fixnum] trigger_id + # Required. The ID of the manual trigger to activate. + # @param [Google::Apis::DisplayvideoV1::ActivateManualTriggerRequest] activate_manual_trigger_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ManualTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def activate_manual_trigger(advertiser_id, trigger_id, activate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:activate', options) + command.request_representation = Google::Apis::DisplayvideoV1::ActivateManualTriggerRequest::Representation + command.request_object = activate_manual_trigger_request_object + command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Creates a new manual trigger. Returns the newly created manual trigger if + # successful. + # @param [Fixnum] advertiser_id + # Required. Immutable. The unique ID of the advertiser that the manual trigger + # belongs to. + # @param [Google::Apis::DisplayvideoV1::ManualTrigger] manual_trigger_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ManualTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_advertiser_manual_trigger(advertiser_id, manual_trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/manualTriggers', options) + command.request_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.request_object = manual_trigger_object + command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deactivates a manual trigger. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser that the manual trigger belongs. + # @param [Fixnum] trigger_id + # Required. The ID of the manual trigger to deactivate. + # @param [Google::Apis::DisplayvideoV1::DeactivateManualTriggerRequest] deactivate_manual_trigger_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ManualTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def deactivate_manual_trigger(advertiser_id, trigger_id, deactivate_manual_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}:deactivate', options) + command.request_representation = Google::Apis::DisplayvideoV1::DeactivateManualTriggerRequest::Representation + command.request_object = deactivate_manual_trigger_request_object + command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets a manual trigger. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser this manual trigger belongs to. + # @param [Fixnum] trigger_id + # Required. The ID of the manual trigger to fetch. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ManualTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_advertiser_manual_trigger(advertiser_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options) + command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists manual triggers that are accessible to the current user for a given + # advertiser id. The order is defined by the order_by parameter. A single + # advertiser_id is required. + # @param [Fixnum] advertiser_id + # Required. The ID of the advertiser that the fetched manual triggers belong to. + # @param [String] filter + # Allows filtering by manual trigger properties. Supported syntax: * Filter + # expressions are made up of one or more restrictions. * Restrictions can be + # combined by `AND` or `OR` logical operators. A sequence of restrictions + # implicitly uses `AND`. * A restriction has the form of ``field` `operator` ` + # value``. * The operator must be `EQUALS (=)`. * Supported fields: - ` + # displayName` - `state` Examples: * All active manual triggers under an + # advertiser: `state="ACTIVE"` The length of this field should be no more than + # 500 characters. + # @param [String] order_by + # Field by which to sort the list. Acceptable values are: * `displayName` ( + # default) * `state` The default sorting order is ascending. To specify + # descending order for a field, a suffix "desc" should be added to the field + # name. For example, `displayName desc`. + # @param [Fixnum] page_size + # Requested page size. Must be between `1` and `100`. If unspecified will + # default to `100`. + # @param [String] page_token + # A token identifying a page of results the server should return. Typically, + # this is the value of next_page_token returned from the previous call to ` + # ListManualTriggers` method. If not specified, the first page of results will + # be returned. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ListManualTriggersResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ListManualTriggersResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_advertiser_manual_triggers(advertiser_id, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/advertisers/{+advertiserId}/manualTriggers', options) + command.response_representation = Google::Apis::DisplayvideoV1::ListManualTriggersResponse::Representation + command.response_class = Google::Apis::DisplayvideoV1::ListManualTriggersResponse + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates a manual trigger. Returns the updated manual trigger if successful. + # @param [Fixnum] advertiser_id + # Required. Immutable. The unique ID of the advertiser that the manual trigger + # belongs to. + # @param [Fixnum] trigger_id + # Output only. The unique ID of the manual trigger. + # @param [Google::Apis::DisplayvideoV1::ManualTrigger] manual_trigger_object + # @param [String] update_mask + # Required. The mask to control which fields to update. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DisplayvideoV1::ManualTrigger] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DisplayvideoV1::ManualTrigger] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def patch_advertiser_manual_trigger(advertiser_id, trigger_id, manual_trigger_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/advertisers/{+advertiserId}/manualTriggers/{+triggerId}', options) + command.request_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.request_object = manual_trigger_object + command.response_representation = Google::Apis::DisplayvideoV1::ManualTrigger::Representation + command.response_class = Google::Apis::DisplayvideoV1::ManualTrigger + command.params['advertiserId'] = advertiser_id unless advertiser_id.nil? + command.params['triggerId'] = trigger_id unless trigger_id.nil? + command.query['updateMask'] = update_mask unless update_mask.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Creates a new negative keyword list. Returns the newly created negative # keyword list if successful. # @param [Fixnum] advertiser_id diff --git a/generated/google/apis/displayvideo_v1/synth.metadata b/generated/google/apis/displayvideo_v1/synth.metadata index 429012f74..07f451b53 100644 --- a/generated/google/apis/displayvideo_v1/synth.metadata +++ b/generated/google/apis/displayvideo_v1/synth.metadata @@ -4,7 +4,7 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/google-api-ruby-client.git", - "sha": "c98c719bbab68d0890524d53f8b629d7858af9c2" + "sha": "188f23cae014a2d636dd99e68a92cd24a25fcd7f" } } ]