google-api-client 0.47.0 → 0.52.0

data/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 = '20201204'
 
       # Create, see, edit, and permanently delete your Display & Video 360 entities and reports
       AUTH_DISPLAY_VIDEO = 'https://www.googleapis.com/auth/display-video'

data/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
@@ -188,8 +201,8 @@ module Google
       class AdvertiserAdServerConfig
         include Google::Apis::Core::Hashable
       
-        # Settings for advertisers that use both Campaign Manager (CM) and third-party
-        # ad servers.
+        # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-
+        # party ad servers.
         # Corresponds to the JSON property `cmHybridConfig`
         # @return [Google::Apis::DisplayvideoV1::CmHybridConfig]
         attr_accessor :cm_hybrid_config
@@ -239,8 +252,8 @@ module Google
         # By setting this field to `true`, you, on behalf of your company, authorize
         # Google to use video creatives associated with this Display & Video 360
         # advertiser to provide reporting and features related to the advertiser's
-        # television campaigns. Applicable only when the advertiser has a CM hybrid ad
-        # server configuration.
+        # television campaigns. Applicable only when the advertiser has a CM360 hybrid
+        # ad server configuration.
         # Corresponds to the JSON property `videoCreativeDataSharingAuthorized`
         # @return [Boolean]
         attr_accessor :video_creative_data_sharing_authorized
@@ -309,9 +322,9 @@ module Google
       
         # Output only. The standard TZ database name of the advertiser's time zone. For
         # example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/
-        # List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the
-        # same as that of the associated CM account; for third-party only advertisers,
-        # the time zone is the same as that of the parent partner.
+        # List_of_tz_database_time_zones For CM360 hybrid advertisers, the time zone is
+        # the same as that of the associated CM360 account; for third-party only
+        # advertisers, the time zone is the same as that of the parent partner.
         # Corresponds to the JSON property `timeZone`
         # @return [String]
         attr_accessor :time_zone
@@ -1338,13 +1351,17 @@ module Google
         include Google::Apis::Core::Hashable
       
         # The assigned targeting options to create in batch, specified as a list of `
-        # CreateAssignedTargetingOptionsRequest`.
+        # CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `
+        # TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `
+        # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
         # Corresponds to the JSON property `createRequests`
         # @return [Array<Google::Apis::DisplayvideoV1::CreateAssignedTargetingOptionsRequest>]
         attr_accessor :create_requests
       
         # The assigned targeting options to delete in batch, specified as a list of `
-        # DeleteAssignedTargetingOptionsRequest`.
+        # DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `
+        # TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `
+        # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`
         # Corresponds to the JSON property `deleteRequests`
         # @return [Array<Google::Apis::DisplayvideoV1::DeleteAssignedTargetingOptionsRequest>]
         attr_accessor :delete_requests
@@ -2115,18 +2132,18 @@ module Google
         end
       end
       
-      # Settings for advertisers that use both Campaign Manager (CM) and third-party
-      # ad servers.
+      # Settings for advertisers that use both Campaign Manager 360 (CM360) and third-
+      # party ad servers.
       class CmHybridConfig
         include Google::Apis::Core::Hashable
       
-        # Required. Immutable. Account ID of the CM Floodlight configuration linked with
-        # the DV360 advertiser.
+        # Required. Immutable. Account ID of the CM360 Floodlight configuration linked
+        # with the DV360 advertiser.
         # Corresponds to the JSON property `cmAccountId`
         # @return [Fixnum]
         attr_accessor :cm_account_id
       
-        # Required. Immutable. ID of the CM Floodlight configuration linked with the
+        # Required. Immutable. ID of the CM360 Floodlight configuration linked with the
         # DV360 advertiser.
         # Corresponds to the JSON property `cmFloodlightConfigId`
         # @return [Fixnum]
@@ -2140,21 +2157,21 @@ module Google
         attr_accessor :cm_floodlight_linking_authorized
         alias_method :cm_floodlight_linking_authorized?, :cm_floodlight_linking_authorized
       
-        # A list of CM sites whose placements will be synced to DV360 as creatives. If
-        # absent or empty in CreateAdvertiser method, the system will automatically
-        # create a CM site. Removing sites from this list may cause DV360 creatives
-        # synced from CM to be deleted. At least one site must be specified.
+        # A list of CM360 sites whose placements will be synced to DV360 as creatives.
+        # If absent or empty in CreateAdvertiser method, the system will automatically
+        # create a CM360 site. Removing sites from this list may cause DV360 creatives
+        # synced from CM360 to be deleted. At least one site must be specified.
         # Corresponds to the JSON property `cmSyncableSiteIds`
         # @return [Array<Fixnum>]
         attr_accessor :cm_syncable_site_ids
       
-        # Whether or not to report DV360 cost to CM.
+        # Whether or not to report DV360 cost to CM360.
         # Corresponds to the JSON property `dv360ToCmCostReportingEnabled`
         # @return [Boolean]
         attr_accessor :dv360_to_cm_cost_reporting_enabled
         alias_method :dv360_to_cm_cost_reporting_enabled?, :dv360_to_cm_cost_reporting_enabled
       
-        # Whether or not to include DV360 data in CM data transfer reports.
+        # Whether or not to include DV360 data in CM360 data transfer reports.
         # Corresponds to the JSON property `dv360ToCmDataSharingEnabled`
         # @return [Boolean]
         attr_accessor :dv360_to_cm_data_sharing_enabled
@@ -2175,21 +2192,21 @@ module Google
         end
       end
       
-      # A Campaign Manager tracking ad.
+      # A Campaign Manager 360 tracking ad.
       class CmTrackingAd
         include Google::Apis::Core::Hashable
       
-        # The ad ID of the campaign manager tracking Ad.
+        # The ad ID of the campaign manager 360 tracking Ad.
         # Corresponds to the JSON property `cmAdId`
         # @return [Fixnum]
         attr_accessor :cm_ad_id
       
-        # The creative ID of the campaign manager tracking Ad.
+        # The creative ID of the campaign manager 360 tracking Ad.
         # Corresponds to the JSON property `cmCreativeId`
         # @return [Fixnum]
         attr_accessor :cm_creative_id
       
-        # The placement ID of the campaign manager tracking Ad.
+        # The placement ID of the campaign manager 360 tracking Ad.
         # Corresponds to the JSON property `cmPlacementId`
         # @return [Fixnum]
         attr_accessor :cm_placement_id
@@ -2585,14 +2602,14 @@ module Google
         # @return [Array<Google::Apis::DisplayvideoV1::AssetAssociation>]
         attr_accessor :assets
       
-        # Output only. The unique ID of the Campaign Manager placement associated with
-        # the creative. This field is only applicable for creatives that are synced from
-        # Campaign Manager.
+        # Output only. The unique ID of the Campaign Manager 360 placement associated
+        # with the creative. This field is only applicable for creatives that are synced
+        # from Campaign Manager.
         # Corresponds to the JSON property `cmPlacementId`
         # @return [Fixnum]
         attr_accessor :cm_placement_id
       
-        # A Campaign Manager tracking ad.
+        # A Campaign Manager 360 tracking ad.
         # Corresponds to the JSON property `cmTrackingAd`
         # @return [Google::Apis::DisplayvideoV1::CmTrackingAd]
         attr_accessor :cm_tracking_ad
@@ -2785,10 +2802,10 @@ module Google
         alias_method :require_mraid?, :require_mraid
       
         # Optional. Indicates that the creative will wait for a return ping for
-        # attribution. Only valid when using a Campaign Manager tracking ad with a third-
-        # party ad server parameter and the $`DC_DBM_TOKEN` macro. Optional and only
-        # valid for third-party tag creatives or third-party VAST tag creatives. Third-
-        # party tag creatives are creatives with following hosting_source: * `
+        # attribution. Only valid when using a Campaign Manager 360 tracking ad with a
+        # third-party ad server parameter and the $`DC_DBM_TOKEN` macro. Optional and
+        # only valid for third-party tag creatives or third-party VAST tag creatives.
+        # Third-party tag creatives are creatives with following hosting_source: * `
         # HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `
         # CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag
         # creatives are creatives with following hosting_source: * `
@@ -3235,6 +3252,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 +3487,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 +3519,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)
@@ -4273,6 +4312,26 @@ module Google
         end
       end
       
+      # Search terms for geo region targeting options.
+      class GeoRegionSearchTerms
+        include Google::Apis::Core::Hashable
+      
+        # The search query for the desired geo region. The query can be a prefix, e.g. "
+        # New Yor", "Seattle", "USA", etc.
+        # Corresponds to the JSON property `geoRegionQuery`
+        # @return [String]
+        attr_accessor :geo_region_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @geo_region_query = args[:geo_region_query] if args.key?(:geo_region_query)
+        end
+      end
+      
       # Represents a targetable geographic region. This will be populated in the
       # geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`.
       class GeoRegionTargetingOptionDetails
@@ -4690,6 +4749,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<Fixnum>]
+        attr_accessor :custom_segment_id
+      
         # Display Viewability section (applicable to display line items only).
         # Corresponds to the JSON property `displayViewability`
         # @return [String]
@@ -4762,6 +4827,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 +5370,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 +5415,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 +5478,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. * When set, the 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 +5495,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 +5991,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<Google::Apis::DisplayvideoV1::ManualTrigger>]
+        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 +6283,66 @@ module Google
         end
       end
       
+      # A single manual trigger in Display & Video 360.
+      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
@@ -6215,13 +6386,13 @@ module Google
       class MeasurementConfig
         include Google::Apis::Core::Hashable
       
-        # Whether or not to report DV360 cost to CM.
+        # Whether or not to report DV360 cost to CM360.
         # Corresponds to the JSON property `dv360ToCmCostReportingEnabled`
         # @return [Boolean]
         attr_accessor :dv360_to_cm_cost_reporting_enabled
         alias_method :dv360_to_cm_cost_reporting_enabled?, :dv360_to_cm_cost_reporting_enabled
       
-        # Whether or not to include DV360 data in CM data transfer reports.
+        # Whether or not to include DV360 data in CM360 data transfer reports.
         # Corresponds to the JSON property `dv360ToCmDataSharingEnabled`
         # @return [Boolean]
         attr_accessor :dv360_to_cm_data_sharing_enabled
@@ -7318,6 +7489,76 @@ module Google
         end
       end
       
+      # Request message for SearchTargetingOptions.
+      class SearchTargetingOptionsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The Advertiser this request is being made in the context of.
+        # Corresponds to the JSON property `advertiserId`
+        # @return [Fixnum]
+        attr_accessor :advertiser_id
+      
+        # Search terms for geo region targeting options.
+        # Corresponds to the JSON property `geoRegionSearchTerms`
+        # @return [Google::Apis::DisplayvideoV1::GeoRegionSearchTerms]
+        attr_accessor :geo_region_search_terms
+      
+        # Requested page size. Must be between `1` and `100`. If unspecified will
+        # default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is
+        # specified.
+        # Corresponds to the JSON property `pageSize`
+        # @return [Fixnum]
+        attr_accessor :page_size
+      
+        # 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 `
+        # SearchTargetingOptions` method. If not specified, the first page of results
+        # will be returned.
+        # Corresponds to the JSON property `pageToken`
+        # @return [String]
+        attr_accessor :page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
+          @geo_region_search_terms = args[:geo_region_search_terms] if args.key?(:geo_region_search_terms)
+          @page_size = args[:page_size] if args.key?(:page_size)
+          @page_token = args[:page_token] if args.key?(:page_token)
+        end
+      end
+      
+      # Response message for SearchTargetingOptionsResponse.
+      class SearchTargetingOptionsResponse
+        include Google::Apis::Core::Hashable
+      
+        # A token to retrieve the next page of results. Pass this value in the
+        # page_token field in the subsequent call to `SearchTargetingOptions` method to
+        # retrieve the next page of results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # The list of targeting options that match the search criteria. This list will
+        # be absent if empty.
+        # Corresponds to the JSON property `targetingOptions`
+        # @return [Array<Google::Apis::DisplayvideoV1::TargetingOption>]
+        attr_accessor :targeting_options
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @targeting_options = args[:targeting_options] if args.key?(:targeting_options)
+        end
+      end
+      
       # Targeting details for sensitive category. This will be populated in the
       # details field of an AssignedTargetingOption when targeting_type is `
       # TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.
@@ -7474,6 +7715,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