Class: Google::Apis::DisplayvideoV2::TargetingOption

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/displayvideo_v2/classes.rb,
lib/google/apis/displayvideo_v2/representations.rb,
lib/google/apis/displayvideo_v2/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.



11069
11070
11071
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11069

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

Instance Attribute Details

#age_range_details ⇒ Google::Apis::DisplayvideoV2::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:



10828
10829
10830
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10828

def age_range_details
  @age_range_details
end

#app_category_details ⇒ Google::Apis::DisplayvideoV2::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:



10837
10838
10839
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10837

def app_category_details
  @app_category_details
end

#audio_content_type_details ⇒ Google::Apis::DisplayvideoV2::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:



10844
10845
10846
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10844

def audio_content_type_details
  @audio_content_type_details
end

#authorized_seller_status_details ⇒ Google::Apis::DisplayvideoV2::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:



10851
10852
10853
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10851

def authorized_seller_status_details
  @authorized_seller_status_details
end

#browser_details ⇒ Google::Apis::DisplayvideoV2::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:



10857
10858
10859
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10857

def browser_details
  @browser_details
end

#business_chain_details ⇒ Google::Apis::DisplayvideoV2::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:



10864
10865
10866
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10864

def business_chain_details
  @business_chain_details
end

#carrier_and_isp_details ⇒ Google::Apis::DisplayvideoV2::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:



10871
10872
10873
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10871

def carrier_and_isp_details
  @carrier_and_isp_details
end

#category_details ⇒ Google::Apis::DisplayvideoV2::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:



10878
10879
10880
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10878

def category_details
  @category_details
end

#content_duration_details ⇒ Google::Apis::DisplayvideoV2::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:



10885
10886
10887
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10885

def content_duration_details
  @content_duration_details
end

#content_genre_details ⇒ Google::Apis::DisplayvideoV2::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:



10892
10893
10894
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10892

def content_genre_details
  @content_genre_details
end

#content_instream_position_details ⇒ Google::Apis::DisplayvideoV2::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:



10900
10901
10902
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10900

def content_instream_position_details
  @content_instream_position_details
end

#content_outstream_position_details ⇒ Google::Apis::DisplayvideoV2::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:



10908
10909
10910
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10908

def content_outstream_position_details
  @content_outstream_position_details
end

#content_stream_type_details ⇒ Google::Apis::DisplayvideoV2::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:



10915
10916
10917
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10915

def content_stream_type_details
  @content_stream_type_details
end

#device_make_model_details ⇒ Google::Apis::DisplayvideoV2::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:



10922
10923
10924
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10922

def device_make_model_details
  @device_make_model_details
end

#device_type_details ⇒ Google::Apis::DisplayvideoV2::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:



10929
10930
10931
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10929

def device_type_details
  @device_type_details
end

#digital_content_label_details ⇒ Google::Apis::DisplayvideoV2::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:



10936
10937
10938
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10936

def digital_content_label_details
  @digital_content_label_details
end

#environment_details ⇒ Google::Apis::DisplayvideoV2::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:



10943
10944
10945
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10943

def environment_details
  @environment_details
end

#exchange_details ⇒ Google::Apis::DisplayvideoV2::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:



10950
10951
10952
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10950

def exchange_details
  @exchange_details
end

#gender_details ⇒ Google::Apis::DisplayvideoV2::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:



10956
10957
10958
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10956

def gender_details
  @gender_details
end

#geo_region_details ⇒ Google::Apis::DisplayvideoV2::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:



10962
10963
10964
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10962

def geo_region_details
  @geo_region_details
end

#household_income_details ⇒ Google::Apis::DisplayvideoV2::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:



10969
10970
10971
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10969

def household_income_details
  @household_income_details
end

#language_details ⇒ Google::Apis::DisplayvideoV2::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:



10975
10976
10977
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10975

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) 


10980
10981
10982
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10980

def name
  @name
end

#native_content_position_details ⇒ Google::Apis::DisplayvideoV2::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:



10987
10988
10989
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10987

def native_content_position_details
  @native_content_position_details
end

#omid_details ⇒ Google::Apis::DisplayvideoV2::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:



10994
10995
10996
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 10994

def omid_details
  @omid_details
end

#on_screen_position_details ⇒ Google::Apis::DisplayvideoV2::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:



11001
11002
11003
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11001

def on_screen_position_details
  @on_screen_position_details
end

#operating_system_details ⇒ Google::Apis::DisplayvideoV2::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:



11008
11009
11010
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11008

def operating_system_details
  @operating_system_details
end

#parental_status_details ⇒ Google::Apis::DisplayvideoV2::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:



11015
11016
11017
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11015

def parental_status_details
  @parental_status_details
end

#poi_details ⇒ Google::Apis::DisplayvideoV2::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:



11021
11022
11023
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11021

def poi_details
  @poi_details
end

#sensitive_category_details ⇒ Google::Apis::DisplayvideoV2::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:



11028
11029
11030
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11028

def sensitive_category_details
  @sensitive_category_details
end

#sub_exchange_details ⇒ Google::Apis::DisplayvideoV2::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:



11035
11036
11037
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11035

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) 


11041
11042
11043
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11041

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) 


11046
11047
11048
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11046

def targeting_type
  @targeting_type
end

#user_rewarded_content_details ⇒ Google::Apis::DisplayvideoV2::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:



11053
11054
11055
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11053

def user_rewarded_content_details
  @user_rewarded_content_details
end

#video_player_size_details ⇒ Google::Apis::DisplayvideoV2::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:



11060
11061
11062
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11060

def video_player_size_details
  @video_player_size_details
end

#viewability_details ⇒ Google::Apis::DisplayvideoV2::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:



11067
11068
11069
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11067

def viewability_details
  @viewability_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 11074

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