Class: Google::Apis::DisplayvideoV1::AssignedTargetingOption

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

Overview

A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AssignedTargetingOption

Returns a new instance of AssignedTargetingOption.



951
952
953
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 951

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

Instance Attribute Details

#age_range_details ⇒ Google::Apis::DisplayvideoV1::AgeRangeAssignedTargetingOptionDetails

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

Returns:



671
672
673
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 671

def age_range_details
  @age_range_details
end

#app_category_details ⇒ Google::Apis::DisplayvideoV1::AppCategoryAssignedTargetingOptionDetails

Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_APP_CATEGORY. Corresponds to the JSON property appCategoryDetails

Returns:



678
679
680
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 678

def app_category_details
  @app_category_details
end

#app_details ⇒ Google::Apis::DisplayvideoV1::AppAssignedTargetingOptionDetails

Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_APP. Corresponds to the JSON property appDetails

Returns:



685
686
687
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 685

def app_details
  @app_details
end

#assigned_targeting_option_id ⇒ String

Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts. Corresponds to the JSON property assignedTargetingOptionId

Returns:

  • (String) 


692
693
694
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 692

def assigned_targeting_option_id
  @assigned_targeting_option_id
end

#audience_group_details ⇒ Google::Apis::DisplayvideoV1::AudienceGroupAssignedTargetingOptionDetails

Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_AUDIENCE_GROUP. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other groups. Corresponds to the JSON property audienceGroupDetails

Returns:



702
703
704
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 702

def audience_group_details
  @audience_group_details
end

#authorized_seller_status_details ⇒ Google::Apis::DisplayvideoV1::AuthorizedSellerStatusAssignedTargetingOptionDetails

Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_AUTHORIZED_SELLER_STATUS. Corresponds to the JSON property authorizedSellerStatusDetails

Returns:



709
710
711
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 709

def authorized_seller_status_details
  @authorized_seller_status_details
end

#browser_details ⇒ Google::Apis::DisplayvideoV1::BrowserAssignedTargetingOptionDetails

Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_BROWSER. Corresponds to the JSON property browserDetails

Returns:



716
717
718
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 716

def browser_details
  @browser_details
end

#carrier_and_isp_details ⇒ Google::Apis::DisplayvideoV1::CarrierAndIspAssignedTargetingOptionDetails

Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_CARRIER_AND_ISP. Corresponds to the JSON property carrierAndIspDetails

Returns:



723
724
725
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 723

def carrier_and_isp_details
  @carrier_and_isp_details
end

#category_details ⇒ Google::Apis::DisplayvideoV1::CategoryAssignedTargetingOptionDetails

Assigned category targeting option details. This will be populated in the category_details field when targeting_type is TARGETING_TYPE_CATEGORY. Corresponds to the JSON property categoryDetails

Returns:



729
730
731
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 729

def category_details
  @category_details
end

#channel_details ⇒ Google::Apis::DisplayvideoV1::ChannelAssignedTargetingOptionDetails

Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_CHANNEL. Corresponds to the JSON property channelDetails

Returns:



736
737
738
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 736

def channel_details
  @channel_details
end

#content_instream_position_details ⇒ Google::Apis::DisplayvideoV1::ContentInstreamPositionAssignedTargetingOptionDetails

Assigned content instream position targeting option details. 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:



743
744
745
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 743

def content_instream_position_details
  @content_instream_position_details
end

#content_outstream_position_details ⇒ Google::Apis::DisplayvideoV1::ContentOutstreamPositionAssignedTargetingOptionDetails

Assigned content outstream position targeting option details. 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:



750
751
752
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 750

def content_outstream_position_details
  @content_outstream_position_details
end

#day_and_time_details ⇒ Google::Apis::DisplayvideoV1::DayAndTimeAssignedTargetingOptionDetails

Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by start_hour must be before the time represented by end_hour. Corresponds to the JSON property dayAndTimeDetails

Returns:



757
758
759
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 757

def day_and_time_details
  @day_and_time_details
end

#device_make_model_details ⇒ Google::Apis::DisplayvideoV1::DeviceMakeModelAssignedTargetingOptionDetails

Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is TARGETING_TYPE_DEVICE_MAKE_MODEL. Corresponds to the JSON property deviceMakeModelDetails

Returns:



764
765
766
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 764

def device_make_model_details
  @device_make_model_details
end

#device_type_details ⇒ Google::Apis::DisplayvideoV1::DeviceTypeAssignedTargetingOptionDetails

Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_DEVICE_TYPE. Corresponds to the JSON property deviceTypeDetails

Returns:



771
772
773
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 771

def device_type_details
  @device_type_details
end

#digital_content_label_exclusion_details ⇒ Google::Apis::DisplayvideoV1::DigitalContentLabelAssignedTargetingOptionDetails

Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION. Corresponds to the JSON property digitalContentLabelExclusionDetails

Returns:



778
779
780
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 778

def digital_content_label_exclusion_details
  @digital_content_label_exclusion_details
end

#environment_details ⇒ Google::Apis::DisplayvideoV1::EnvironmentAssignedTargetingOptionDetails

Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_ENVIRONMENT. Corresponds to the JSON property environmentDetails

Returns:



785
786
787
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 785

def environment_details
  @environment_details
end

#exchange_details ⇒ Google::Apis::DisplayvideoV1::ExchangeAssignedTargetingOptionDetails

Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_EXCHANGE. Corresponds to the JSON property exchangeDetails

Returns:



792
793
794
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 792

def exchange_details
  @exchange_details
end

#gender_details ⇒ Google::Apis::DisplayvideoV1::GenderAssignedTargetingOptionDetails

Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARTGETING_TYPE_GENDER. Corresponds to the JSON property genderDetails

Returns:



799
800
801
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 799

def gender_details
  @gender_details
end

#geo_region_details ⇒ Google::Apis::DisplayvideoV1::GeoRegionAssignedTargetingOptionDetails

Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_GEO_REGION. Corresponds to the JSON property geoRegionDetails

Returns:



806
807
808
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 806

def geo_region_details
  @geo_region_details
end

#household_income_details ⇒ Google::Apis::DisplayvideoV1::HouseholdIncomeAssignedTargetingOptionDetails

Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_HOUSEHOLD_INCOME. Corresponds to the JSON property householdIncomeDetails

Returns:



813
814
815
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 813

def household_income_details
  @household_income_details
end

#inheritance ⇒ String

Output only. The inheritance status of the assigned targeting option. Corresponds to the JSON property inheritance

Returns:

  • (String) 


818
819
820
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 818

def inheritance
  @inheritance
end

#inventory_source_details ⇒ Google::Apis::DisplayvideoV1::InventorySourceAssignedTargetingOptionDetails

Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_INVENTORY_SOURCE. Corresponds to the JSON property inventorySourceDetails

Returns:



825
826
827
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 825

def inventory_source_details
  @inventory_source_details
end

#inventory_source_group_details ⇒ Google::Apis::DisplayvideoV1::InventorySourceGroupAssignedTargetingOptionDetails

Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_INVENTORY_SOURCE_GROUP. Corresponds to the JSON property inventorySourceGroupDetails

Returns:



832
833
834
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 832

def inventory_source_group_details
  @inventory_source_group_details
end

#keyword_details ⇒ Google::Apis::DisplayvideoV1::KeywordAssignedTargetingOptionDetails

Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_KEYWORD. Corresponds to the JSON property keywordDetails

Returns:



839
840
841
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 839

def keyword_details
  @keyword_details
end

#language_details ⇒ Google::Apis::DisplayvideoV1::LanguageAssignedTargetingOptionDetails

Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_LANGUAGE. Corresponds to the JSON property languageDetails

Returns:



846
847
848
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 846

def language_details
  @language_details
end

#name ⇒ String

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

Returns:

  • (String) 


851
852
853
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 851

def name
  @name
end

#negative_keyword_list_details ⇒ Google::Apis::DisplayvideoV1::NegativeKeywordListAssignedTargetingOptionDetails

Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_NEGATIVE_KEYWORD_LIST. Corresponds to the JSON property negativeKeywordListDetails

Returns:



858
859
860
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 858

def negative_keyword_list_details
  @negative_keyword_list_details
end

#on_screen_position_details ⇒ Google::Apis::DisplayvideoV1::OnScreenPositionAssignedTargetingOptionDetails

On screen position targeting option details. 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:



865
866
867
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 865

def on_screen_position_details
  @on_screen_position_details
end

#operating_system_details ⇒ Google::Apis::DisplayvideoV1::OperatingSystemAssignedTargetingOptionDetails

Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is TARGETING_TYPE_OPERATING_SYSTEM. Corresponds to the JSON property operatingSystemDetails

Returns:



872
873
874
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 872

def operating_system_details
  @operating_system_details
end

#parental_status_details ⇒ Google::Apis::DisplayvideoV1::ParentalStatusAssignedTargetingOptionDetails

Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARTGETING_TYPE_PARENTAL_STATUS. Corresponds to the JSON property parentalStatusDetails

Returns:



879
880
881
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 879

def parental_status_details
  @parental_status_details
end

#proximity_location_list_details ⇒ Google::Apis::DisplayvideoV1::ProximityLocationListAssignedTargetingOptionDetails

Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_PROXIMITY_LOCATION_LIST. Corresponds to the JSON property proximityLocationListDetails

Returns:



886
887
888
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 886

def proximity_location_list_details
  @proximity_location_list_details
end

#regional_location_list_details ⇒ Google::Apis::DisplayvideoV1::RegionalLocationListAssignedTargetingOptionDetails

Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_REGIONAL_LOCATION_LIST. Corresponds to the JSON property regionalLocationListDetails

Returns:



893
894
895
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 893

def regional_location_list_details
  @regional_location_list_details
end

#sensitive_category_exclusion_details ⇒ Google::Apis::DisplayvideoV1::SensitiveCategoryAssignedTargetingOptionDetails

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. Corresponds to the JSON property sensitiveCategoryExclusionDetails

Returns:



900
901
902
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 900

def sensitive_category_exclusion_details
  @sensitive_category_exclusion_details
end

#sub_exchange_details ⇒ Google::Apis::DisplayvideoV1::SubExchangeAssignedTargetingOptionDetails

Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_SUB_EXCHANGE. Corresponds to the JSON property subExchangeDetails

Returns:



907
908
909
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 907

def sub_exchange_details
  @sub_exchange_details
end

#targeting_type ⇒ String

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

Returns:

  • (String) 


912
913
914
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 912

def targeting_type
  @targeting_type
end

#third_party_verifier_details ⇒ Google::Apis::DisplayvideoV1::ThirdPartyVerifierAssignedTargetingOptionDetails

Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_THIRD_PARTY_VERIFIER. Corresponds to the JSON property thirdPartyVerifierDetails

Returns:



919
920
921
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 919

def third_party_verifier_details
  @third_party_verifier_details
end

#url_details ⇒ Google::Apis::DisplayvideoV1::UrlAssignedTargetingOptionDetails

Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_URL. Corresponds to the JSON property urlDetails

Returns:



926
927
928
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 926

def url_details
  @url_details
end

#user_rewarded_content_details ⇒ Google::Apis::DisplayvideoV1::UserRewardedContentAssignedTargetingOptionDetails

User rewarded content targeting option details. 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:



933
934
935
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 933

def user_rewarded_content_details
  @user_rewarded_content_details
end

#video_player_size_details ⇒ Google::Apis::DisplayvideoV1::VideoPlayerSizeAssignedTargetingOptionDetails

Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is TARGETING_TYPE_VIDEO_PLAYER_SIZE. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. Corresponds to the JSON property videoPlayerSizeDetails

Returns:



942
943
944
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 942

def video_player_size_details
  @video_player_size_details
end

#viewability_details ⇒ Google::Apis::DisplayvideoV1::ViewabilityAssignedTargetingOptionDetails

Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_VIEWABILITY. Corresponds to the JSON property viewabilityDetails

Returns:



949
950
951
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 949

def viewability_details
  @viewability_details
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
 
# File 'generated/google/apis/displayvideo_v1/classes.rb', line 956

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)
  @app_details = args[:app_details] if args.key?(:app_details)
  @assigned_targeting_option_id = args[:assigned_targeting_option_id] if args.key?(:assigned_targeting_option_id)
  @audience_group_details = args[:audience_group_details] if args.key?(:audience_group_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)
  @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)
  @channel_details = args[:channel_details] if args.key?(:channel_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)
  @day_and_time_details = args[:day_and_time_details] if args.key?(:day_and_time_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_exclusion_details = args[:digital_content_label_exclusion_details] if args.key?(:digital_content_label_exclusion_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)
  @inheritance = args[:inheritance] if args.key?(:inheritance)
  @inventory_source_details = args[:inventory_source_details] if args.key?(:inventory_source_details)
  @inventory_source_group_details = args[:inventory_source_group_details] if args.key?(:inventory_source_group_details)
  @keyword_details = args[:keyword_details] if args.key?(:keyword_details)
  @language_details = args[:language_details] if args.key?(:language_details)
  @name = args[:name] if args.key?(:name)
  @negative_keyword_list_details = args[:negative_keyword_list_details] if args.key?(:negative_keyword_list_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)
  @proximity_location_list_details = args[:proximity_location_list_details] if args.key?(:proximity_location_list_details)
  @regional_location_list_details = args[:regional_location_list_details] if args.key?(:regional_location_list_details)
  @sensitive_category_exclusion_details = args[:sensitive_category_exclusion_details] if args.key?(:sensitive_category_exclusion_details)
  @sub_exchange_details = args[:sub_exchange_details] if args.key?(:sub_exchange_details)
  @targeting_type = args[:targeting_type] if args.key?(:targeting_type)
  @third_party_verifier_details = args[:third_party_verifier_details] if args.key?(:third_party_verifier_details)
  @url_details = args[:url_details] if args.key?(:url_details)
  @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