Class: Google::Apis::RealtimebiddingV1::PretargetingConfig

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

Overview

Pretargeting configuration: a set of targeting dimensions applied at the pretargeting stage of the RTB funnel. These control which inventory a bidder will receive bid requests for.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PretargetingConfig

Returns a new instance of PretargetingConfig.



1874
1875
1876
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1874

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

Instance Attribute Details

#allowed_user_targeting_modes ⇒ Array<String>

Targeting modes included by this configuration. A bid request must allow all the specified targeting modes. An unset value allows all bid requests to be sent, regardless of which targeting modes they allow. Corresponds to the JSON property allowedUserTargetingModes

Returns:

  • (Array<String>) 


1720
1721
1722
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1720

def allowed_user_targeting_modes
  @allowed_user_targeting_modes
end

#app_targeting ⇒ Google::Apis::RealtimebiddingV1::AppTargeting

A subset of app inventory to target. Bid requests that match criteria in at least one of the specified dimensions will be sent. Corresponds to the JSON property appTargeting

Returns:



1726
1727
1728
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1726

def app_targeting
  @app_targeting
end

#billing_id ⇒ Fixnum

Output only. The identifier that corresponds to this pretargeting configuration that helps buyers track and attribute their spend across their own arbitrary divisions. If a bid request matches more than one configuration, the buyer chooses which billing_id to attribute each of their bids. Corresponds to the JSON property billingId

Returns:

  • (Fixnum) 


1734
1735
1736
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1734

def billing_id
  @billing_id
end

#display_name ⇒ String

The diplay name associated with this configuration. This name must be unique among all the pretargeting configurations a bidder has. Corresponds to the JSON property displayName

Returns:

  • (String) 


1740
1741
1742
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1740

def display_name
  @display_name
end

#excluded_content_label_ids ⇒ Array<Fixnum>

The sensitive content category label IDs excluded in this configuration. Bid requests for inventory with any of the specified content label IDs will not be sent. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/ content-labels.txt for category IDs. Corresponds to the JSON property excludedContentLabelIds

Returns:

  • (Array<Fixnum>) 


1748
1749
1750
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1748

def excluded_content_label_ids
  @excluded_content_label_ids
end

#geo_targeting ⇒ Google::Apis::RealtimebiddingV1::NumericTargetingDimension

Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. Corresponds to the JSON property geoTargeting

Returns:



1755
1756
1757
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1755

def geo_targeting
  @geo_targeting
end

#included_creative_dimensions ⇒ Array<Google::Apis::RealtimebiddingV1::CreativeDimensions>

Creative dimensions included by this configuration. Only bid requests eligible for at least one of the specified creative dimensions will be sent. An unset value allows all bid requests to be sent, regardless of creative dimension. Corresponds to the JSON property includedCreativeDimensions

Returns:



1762
1763
1764
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1762

def included_creative_dimensions
  @included_creative_dimensions
end

#included_environments ⇒ Array<String>

Environments that are being included. Bid requests will not be sent for a given environment if it is not included. Further restrictions can be applied to included environments to target only a subset of its inventory. An unset value includes all environments. Corresponds to the JSON property includedEnvironments

Returns:

  • (Array<String>) 


1770
1771
1772
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1770

def included_environments
  @included_environments
end

#included_formats ⇒ Array<String>

Creative formats included by this configuration. Only bid requests eligible for at least one of the specified creative formats will be sent. An unset value will allow all bid requests to be sent, regardless of format. Corresponds to the JSON property includedFormats

Returns:

  • (Array<String>) 


1777
1778
1779
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1777

def included_formats
  @included_formats
end

#included_languages ⇒ Array<String>

The languages included in this configuration, represented by their language code. See https://developers.google.com/adwords/api/docs/appendix/ languagecodes. Corresponds to the JSON property includedLanguages

Returns:

  • (Array<String>) 


1784
1785
1786
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1784

def included_languages
  @included_languages
end

#included_mobile_operating_system_ids ⇒ Array<Fixnum>

The mobile operating systems included in this configuration as defined in https://storage.googleapis.com/adx-rtb-dictionaries/mobile-os.csv Corresponds to the JSON property includedMobileOperatingSystemIds

Returns:

  • (Array<Fixnum>) 


1790
1791
1792
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1790

def included_mobile_operating_system_ids
  @included_mobile_operating_system_ids
end

#included_platforms ⇒ Array<String>

The platforms included by this configration. Bid requests for devices with the specified platform types will be sent. An unset value allows all bid requests to be sent, regardless of platform. Corresponds to the JSON property includedPlatforms

Returns:

  • (Array<String>) 


1797
1798
1799
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1797

def included_platforms
  @included_platforms
end

#included_user_id_types ⇒ Array<String>

User identifier types included in this configuration. At least one of the user identifier types specified in this list must be available for the bid request to be sent. Corresponds to the JSON property includedUserIdTypes

Returns:

  • (Array<String>) 


1804
1805
1806
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1804

def included_user_id_types
  @included_user_id_types
end

#interstitial_targeting ⇒ String

The interstitial targeting specified for this configuration. The unset value will allow bid requests to be sent regardless of whether they are for interstitials or not. Corresponds to the JSON property interstitialTargeting

Returns:

  • (String) 


1811
1812
1813
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1811

def interstitial_targeting
  @interstitial_targeting
end

#invalid_geo_ids ⇒ Array<Fixnum>

Output only. Existing included or excluded geos that are invalid. Previously targeted geos may become invalid due to privacy restrictions. Corresponds to the JSON property invalidGeoIds

Returns:

  • (Array<Fixnum>) 


1817
1818
1819
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1817

def invalid_geo_ids
  @invalid_geo_ids
end

#maximum_qps ⇒ Fixnum

The maximum QPS threshold for this configuration. The bidder should receive no more than this number of bid requests matching this configuration per second across all their bidding endpoints among all trading locations. Further information available at https://developers.google.com/authorized-buyers/rtb/ peer-guide Corresponds to the JSON property maximumQps

Returns:

  • (Fixnum) 


1826
1827
1828
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1826

def maximum_qps
  @maximum_qps
end

#minimum_viewability_decile ⇒ Fixnum

The targeted minimum viewability decile, ranging in values [0, 10]. A value of 5 means that the configuration will only match adslots for which we predict at least 50% viewability. Values > 10 will be rounded down to 10. An unset value or a value of 0 indicates that bid requests will be sent regardless of viewability. Corresponds to the JSON property minimumViewabilityDecile

Returns:

  • (Fixnum) 


1835
1836
1837
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1835

def minimum_viewability_decile
  @minimum_viewability_decile
end

#name ⇒ String

Output only. Name of the pretargeting configuration that must follow the pattern bidders/bidder_account_id/pretargetingConfigs/config_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


1841
1842
1843
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1841

def name
  @name
end

#publisher_targeting ⇒ Google::Apis::RealtimebiddingV1::StringTargetingDimension

Generic targeting with string values used in app, website and publisher targeting. Corresponds to the JSON property publisherTargeting

Returns:



1847
1848
1849
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1847

def publisher_targeting
  @publisher_targeting
end

#state ⇒ String

Output only. The state of this pretargeting configuration. Corresponds to the JSON property state

Returns:

  • (String) 


1852
1853
1854
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1852

def state
  @state
end

#user_list_targeting ⇒ Google::Apis::RealtimebiddingV1::NumericTargetingDimension

Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. Corresponds to the JSON property userListTargeting

Returns:



1859
1860
1861
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1859

def user_list_targeting
  @user_list_targeting
end

#vertical_targeting ⇒ Google::Apis::RealtimebiddingV1::NumericTargetingDimension

Generic targeting used for targeting dimensions that contain a list of included and excluded numeric IDs used in app, user list, geo, and vertical id targeting. Corresponds to the JSON property verticalTargeting

Returns:



1866
1867
1868
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1866

def vertical_targeting
  @vertical_targeting
end

#web_targeting ⇒ Google::Apis::RealtimebiddingV1::StringTargetingDimension

Generic targeting with string values used in app, website and publisher targeting. Corresponds to the JSON property webTargeting

Returns:



1872
1873
1874
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1872

def web_targeting
  @web_targeting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
 
# File 'lib/google/apis/realtimebidding_v1/classes.rb', line 1879

def update!(**args)
  @allowed_user_targeting_modes = args[:allowed_user_targeting_modes] if args.key?(:allowed_user_targeting_modes)
  @app_targeting = args[:app_targeting] if args.key?(:app_targeting)
  @billing_id = args[:billing_id] if args.key?(:billing_id)
  @display_name = args[:display_name] if args.key?(:display_name)
  @excluded_content_label_ids = args[:excluded_content_label_ids] if args.key?(:excluded_content_label_ids)
  @geo_targeting = args[:geo_targeting] if args.key?(:geo_targeting)
  @included_creative_dimensions = args[:included_creative_dimensions] if args.key?(:included_creative_dimensions)
  @included_environments = args[:included_environments] if args.key?(:included_environments)
  @included_formats = args[:included_formats] if args.key?(:included_formats)
  @included_languages = args[:included_languages] if args.key?(:included_languages)
  @included_mobile_operating_system_ids = args[:included_mobile_operating_system_ids] if args.key?(:included_mobile_operating_system_ids)
  @included_platforms = args[:included_platforms] if args.key?(:included_platforms)
  @included_user_id_types = args[:included_user_id_types] if args.key?(:included_user_id_types)
  @interstitial_targeting = args[:interstitial_targeting] if args.key?(:interstitial_targeting)
  @invalid_geo_ids = args[:invalid_geo_ids] if args.key?(:invalid_geo_ids)
  @maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps)
  @minimum_viewability_decile = args[:minimum_viewability_decile] if args.key?(:minimum_viewability_decile)
  @name = args[:name] if args.key?(:name)
  @publisher_targeting = args[:publisher_targeting] if args.key?(:publisher_targeting)
  @state = args[:state] if args.key?(:state)
  @user_list_targeting = args[:user_list_targeting] if args.key?(:user_list_targeting)
  @vertical_targeting = args[:vertical_targeting] if args.key?(:vertical_targeting)
  @web_targeting = args[:web_targeting] if args.key?(:web_targeting)
end