Class: Google::Apis::DisplayvideoV3::TargetingOption

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v3/classes.rb,
lib/google/apis/displayvideo_v3/representations.rb,
lib/google/apis/displayvideo_v3/representations.rb

Overview

Represents a single targeting option, which is a targetable concept in DV360.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TargetingOption

Returns a new instance of TargetingOption.



11830
11831
11832
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11830

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#age_range_details ⇒ Google::Apis::DisplayvideoV3::AgeRangeTargetingOptionDetails

Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is TARGETING_TYPE_AGE_RANGE. Corresponds to the JSON property ageRangeDetails

Returns:



11589
11590
11591
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11589

def age_range_details
  @age_range_details
end

#app_category_details ⇒ Google::Apis::DisplayvideoV3::AppCategoryTargetingOptionDetails

Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example All Apps/Google Play/Games. This will be populated in the app_category_details field when targeting_type is TARGETING_TYPE_APP_CATEGORY . Corresponds to the JSON property appCategoryDetails

Returns:



11598
11599
11600
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11598

def app_category_details
  @app_category_details
end

#audio_content_type_details ⇒ Google::Apis::DisplayvideoV3::AudioContentTypeTargetingOptionDetails

Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is TARGETING_TYPE_AUDIO_CONTENT_TYPE. Corresponds to the JSON property audioContentTypeDetails

Returns:



11605
11606
11607
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11605

def audio_content_type_details
  @audio_content_type_details
end

#authorized_seller_status_details ⇒ Google::Apis::DisplayvideoV3::AuthorizedSellerStatusTargetingOptionDetails

Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is TARGETING_TYPE_AUTHORIZED_SELLER_STATUS. Corresponds to the JSON property authorizedSellerStatusDetails

Returns:



11612
11613
11614
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11612

def authorized_seller_status_details
  @authorized_seller_status_details
end

#browser_details ⇒ Google::Apis::DisplayvideoV3::BrowserTargetingOptionDetails

Represents a targetable browser. This will be populated in the browser_details field when targeting_type is TARGETING_TYPE_BROWSER. Corresponds to the JSON property browserDetails

Returns:



11618
11619
11620
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11618

def browser_details
  @browser_details
end

#business_chain_details ⇒ Google::Apis::DisplayvideoV3::BusinessChainTargetingOptionDetails

Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is TARGETING_TYPE_BUSINESS_CHAIN. Corresponds to the JSON property businessChainDetails

Returns:



11625
11626
11627
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11625

def business_chain_details
  @business_chain_details
end

#carrier_and_isp_details ⇒ Google::Apis::DisplayvideoV3::CarrierAndIspTargetingOptionDetails

Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is TARGETING_TYPE_CARRIER_AND_ISP. Corresponds to the JSON property carrierAndIspDetails

Returns:



11632
11633
11634
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11632

def carrier_and_isp_details
  @carrier_and_isp_details
end

#category_details ⇒ Google::Apis::DisplayvideoV3::CategoryTargetingOptionDetails

Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is TARGETING_TYPE_CATEGORY. Corresponds to the JSON property categoryDetails

Returns:



11639
11640
11641
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11639

def category_details
  @category_details
end

#content_duration_details ⇒ Google::Apis::DisplayvideoV3::ContentDurationTargetingOptionDetails

Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is TARGETING_TYPE_CONTENT_DURATION. Corresponds to the JSON property contentDurationDetails

Returns:



11646
11647
11648
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11646

def content_duration_details
  @content_duration_details
end

#content_genre_details ⇒ Google::Apis::DisplayvideoV3::ContentGenreTargetingOptionDetails

Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is TARGETING_TYPE_CONTENT_GENRE. Corresponds to the JSON property contentGenreDetails

Returns:



11653
11654
11655
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11653

def content_genre_details
  @content_genre_details
end

#content_instream_position_details ⇒ Google::Apis::DisplayvideoV3::ContentInstreamPositionTargetingOptionDetails

Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is TARGETING_TYPE_CONTENT_INSTREAM_POSITION. Corresponds to the JSON property contentInstreamPositionDetails

Returns:



11661
11662
11663
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11661

def content_instream_position_details
  @content_instream_position_details
end

#content_outstream_position_details ⇒ Google::Apis::DisplayvideoV3::ContentOutstreamPositionTargetingOptionDetails

Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION. Corresponds to the JSON property contentOutstreamPositionDetails

Returns:



11669
11670
11671
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11669

def content_outstream_position_details
  @content_outstream_position_details
end

#content_stream_type_details ⇒ Google::Apis::DisplayvideoV3::ContentStreamTypeTargetingOptionDetails

Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is TARGETING_TYPE_CONTENT_STREAM_TYPE. Corresponds to the JSON property contentStreamTypeDetails

Returns:



11676
11677
11678
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11676

def content_stream_type_details
  @content_stream_type_details
end

#device_make_model_details ⇒ Google::Apis::DisplayvideoV3::DeviceMakeModelTargetingOptionDetails

Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is TARGETING_TYPE_DEVICE_MAKE_MODEL. Corresponds to the JSON property deviceMakeModelDetails

Returns:



11683
11684
11685
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11683

def device_make_model_details
  @device_make_model_details
end

#device_type_details ⇒ Google::Apis::DisplayvideoV3::DeviceTypeTargetingOptionDetails

Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is TARGETING_TYPE_DEVICE_TYPE. Corresponds to the JSON property deviceTypeDetails

Returns:



11690
11691
11692
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11690

def device_type_details
  @device_type_details
end

#digital_content_label_details ⇒ Google::Apis::DisplayvideoV3::DigitalContentLabelTargetingOptionDetails

Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION. Corresponds to the JSON property digitalContentLabelDetails

Returns:



11697
11698
11699
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11697

def digital_content_label_details
  @digital_content_label_details
end

#environment_details ⇒ Google::Apis::DisplayvideoV3::EnvironmentTargetingOptionDetails

Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is TARGETING_TYPE_ENVIRONMENT. Corresponds to the JSON property environmentDetails

Returns:



11704
11705
11706
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11704

def environment_details
  @environment_details
end

#exchange_details ⇒ Google::Apis::DisplayvideoV3::ExchangeTargetingOptionDetails

Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is TARGETING_TYPE_EXCHANGE. Corresponds to the JSON property exchangeDetails

Returns:



11711
11712
11713
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11711

def exchange_details
  @exchange_details
end

#gender_details ⇒ Google::Apis::DisplayvideoV3::GenderTargetingOptionDetails

Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is TARGETING_TYPE_GENDER. Corresponds to the JSON property genderDetails

Returns:



11717
11718
11719
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11717

def gender_details
  @gender_details
end

#geo_region_details ⇒ Google::Apis::DisplayvideoV3::GeoRegionTargetingOptionDetails

Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is TARGETING_TYPE_GEO_REGION. Corresponds to the JSON property geoRegionDetails

Returns:



11723
11724
11725
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11723

def geo_region_details
  @geo_region_details
end

#household_income_details ⇒ Google::Apis::DisplayvideoV3::HouseholdIncomeTargetingOptionDetails

Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is TARGETING_TYPE_HOUSEHOLD_INCOME. Corresponds to the JSON property householdIncomeDetails

Returns:



11730
11731
11732
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11730

def household_income_details
  @household_income_details
end

#language_details ⇒ Google::Apis::DisplayvideoV3::LanguageTargetingOptionDetails

Represents a targetable language. This will be populated in the language_details field when targeting_type is TARGETING_TYPE_LANGUAGE. Corresponds to the JSON property languageDetails

Returns:



11736
11737
11738
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11736

def language_details
  @language_details
end

#name ⇒ String

Output only. The resource name for this targeting option. Corresponds to the JSON property name

Returns:

  • (String) 


11741
11742
11743
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11741

def name
  @name
end

#native_content_position_details ⇒ Google::Apis::DisplayvideoV3::NativeContentPositionTargetingOptionDetails

Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is TARGETING_TYPE_NATIVE_CONTENT_POSITION. Corresponds to the JSON property nativeContentPositionDetails

Returns:



11748
11749
11750
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11748

def native_content_position_details
  @native_content_position_details
end

#omid_details ⇒ Google::Apis::DisplayvideoV3::OmidTargetingOptionDetails

Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is TARGETING_TYPE_OMID. Corresponds to the JSON property omidDetails

Returns:



11755
11756
11757
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11755

def omid_details
  @omid_details
end

#on_screen_position_details ⇒ Google::Apis::DisplayvideoV3::OnScreenPositionTargetingOptionDetails

Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is TARGETING_TYPE_ON_SCREEN_POSITION. Corresponds to the JSON property onScreenPositionDetails

Returns:



11762
11763
11764
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11762

def on_screen_position_details
  @on_screen_position_details
end

#operating_system_details ⇒ Google::Apis::DisplayvideoV3::OperatingSystemTargetingOptionDetails

Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is TARGETING_TYPE_OPERATING_SYSTEM. Corresponds to the JSON property operatingSystemDetails

Returns:



11769
11770
11771
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11769

def operating_system_details
  @operating_system_details
end

#parental_status_details ⇒ Google::Apis::DisplayvideoV3::ParentalStatusTargetingOptionDetails

Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is TARGETING_TYPE_PARENTAL_STATUS. Corresponds to the JSON property parentalStatusDetails

Returns:



11776
11777
11778
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11776

def parental_status_details
  @parental_status_details
end

#poi_details ⇒ Google::Apis::DisplayvideoV3::PoiTargetingOptionDetails

Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is TARGETING_TYPE_POI. Corresponds to the JSON property poiDetails

Returns:



11782
11783
11784
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11782

def poi_details
  @poi_details
end

#sensitive_category_details ⇒ Google::Apis::DisplayvideoV3::SensitiveCategoryTargetingOptionDetails

Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION. Corresponds to the JSON property sensitiveCategoryDetails

Returns:



11789
11790
11791
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11789

def sensitive_category_details
  @sensitive_category_details
end

#sub_exchange_details ⇒ Google::Apis::DisplayvideoV3::SubExchangeTargetingOptionDetails

Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is TARGETING_TYPE_SUB_EXCHANGE. Corresponds to the JSON property subExchangeDetails

Returns:



11796
11797
11798
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11796

def sub_exchange_details
  @sub_exchange_details
end

#targeting_option_id ⇒ String

Output only. A unique identifier for this targeting option. The tuple targeting_type`, `targeting_option_id will be unique. Corresponds to the JSON property targetingOptionId

Returns:

  • (String) 


11802
11803
11804
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11802

def targeting_option_id
  @targeting_option_id
end

#targeting_type ⇒ String

Output only. The type of this targeting option. Corresponds to the JSON property targetingType

Returns:

  • (String) 


11807
11808
11809
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11807

def targeting_type
  @targeting_type
end

#user_rewarded_content_details ⇒ Google::Apis::DisplayvideoV3::UserRewardedContentTargetingOptionDetails

Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is TARGETING_TYPE_USER_REWARDED_CONTENT. Corresponds to the JSON property userRewardedContentDetails

Returns:



11814
11815
11816
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11814

def user_rewarded_content_details
  @user_rewarded_content_details
end

#video_player_size_details ⇒ Google::Apis::DisplayvideoV3::VideoPlayerSizeTargetingOptionDetails

Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is TARGETING_TYPE_VIDEO_PLAYER_SIZE. Corresponds to the JSON property videoPlayerSizeDetails

Returns:



11821
11822
11823
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11821

def video_player_size_details
  @video_player_size_details
end

#viewability_details ⇒ Google::Apis::DisplayvideoV3::ViewabilityTargetingOptionDetails

Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is TARGETING_TYPE_VIEWABILITY. Corresponds to the JSON property viewabilityDetails

Returns:



11828
11829
11830
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11828

def viewability_details
  @viewability_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11835

def update!(**args)
  @age_range_details = args[:age_range_details] if args.key?(:age_range_details)
  @app_category_details = args[:app_category_details] if args.key?(:app_category_details)
  @audio_content_type_details = args[:audio_content_type_details] if args.key?(:audio_content_type_details)
  @authorized_seller_status_details = args[:authorized_seller_status_details] if args.key?(:authorized_seller_status_details)
  @browser_details = args[:browser_details] if args.key?(:browser_details)
  @business_chain_details = args[:business_chain_details] if args.key?(:business_chain_details)
  @carrier_and_isp_details = args[:carrier_and_isp_details] if args.key?(:carrier_and_isp_details)
  @category_details = args[:category_details] if args.key?(:category_details)
  @content_duration_details = args[:content_duration_details] if args.key?(:content_duration_details)
  @content_genre_details = args[:content_genre_details] if args.key?(:content_genre_details)
  @content_instream_position_details = args[:content_instream_position_details] if args.key?(:content_instream_position_details)
  @content_outstream_position_details = args[:content_outstream_position_details] if args.key?(:content_outstream_position_details)
  @content_stream_type_details = args[:content_stream_type_details] if args.key?(:content_stream_type_details)
  @device_make_model_details = args[:device_make_model_details] if args.key?(:device_make_model_details)
  @device_type_details = args[:device_type_details] if args.key?(:device_type_details)
  @digital_content_label_details = args[:digital_content_label_details] if args.key?(:digital_content_label_details)
  @environment_details = args[:environment_details] if args.key?(:environment_details)
  @exchange_details = args[:exchange_details] if args.key?(:exchange_details)
  @gender_details = args[:gender_details] if args.key?(:gender_details)
  @geo_region_details = args[:geo_region_details] if args.key?(:geo_region_details)
  @household_income_details = args[:household_income_details] if args.key?(:household_income_details)
  @language_details = args[:language_details] if args.key?(:language_details)
  @name = args[:name] if args.key?(:name)
  @native_content_position_details = args[:native_content_position_details] if args.key?(:native_content_position_details)
  @omid_details = args[:omid_details] if args.key?(:omid_details)
  @on_screen_position_details = args[:on_screen_position_details] if args.key?(:on_screen_position_details)
  @operating_system_details = args[:operating_system_details] if args.key?(:operating_system_details)
  @parental_status_details = args[:parental_status_details] if args.key?(:parental_status_details)
  @poi_details = args[:poi_details] if args.key?(:poi_details)
  @sensitive_category_details = args[:sensitive_category_details] if args.key?(:sensitive_category_details)
  @sub_exchange_details = args[:sub_exchange_details] if args.key?(:sub_exchange_details)
  @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id)
  @targeting_type = args[:targeting_type] if args.key?(:targeting_type)
  @user_rewarded_content_details = args[:user_rewarded_content_details] if args.key?(:user_rewarded_content_details)
  @video_player_size_details = args[:video_player_size_details] if args.key?(:video_player_size_details)
  @viewability_details = args[:viewability_details] if args.key?(:viewability_details)
end