Class: Google::Apis::AdexchangebuyerV1_3::PretargetingConfig

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

Defined Under Namespace

Classes: Dimension, ExcludedPlacement, Placement

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PretargetingConfig

Returns a new instance of PretargetingConfig.



1198
1199
1200
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1198

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

Instance Attribute Details

#billing_id ⇒ String

The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. Corresponds to the JSON property billingId

Returns:

  • (String) 


1072
1073
1074
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1072

def billing_id
  @billing_id
end

#config_id ⇒ String

The config id; generated automatically. Leave this field blank for insert requests. Corresponds to the JSON property configId

Returns:

  • (String) 


1078
1079
1080
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1078

def config_id
  @config_id
end

#config_name ⇒ String

The name of the config. Must be unique. Required for all requests. Corresponds to the JSON property configName

Returns:

  • (String) 


1083
1084
1085
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1083

def config_name
  @config_name
end

#creative_type ⇒ Array<String>

List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. Corresponds to the JSON property creativeType

Returns:

  • (Array<String>) 


1089
1090
1091
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1089

def creative_type
  @creative_type
end

#dimensions ⇒ Array<Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Dimension>

Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. Corresponds to the JSON property dimensions

Returns:



1095
1096
1097
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1095

def dimensions
  @dimensions
end

#excluded_content_labels ⇒ Array<String>

Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. Corresponds to the JSON property excludedContentLabels

Returns:

  • (Array<String>) 


1101
1102
1103
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1101

def excluded_content_labels
  @excluded_content_labels
end

#excluded_geo_criteria_ids ⇒ Array<String>

Requests containing any of these geo criteria ids will not match. Corresponds to the JSON property excludedGeoCriteriaIds

Returns:

  • (Array<String>) 


1106
1107
1108
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1106

def excluded_geo_criteria_ids
  @excluded_geo_criteria_ids
end

#excluded_placements ⇒ Array<Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::ExcludedPlacement>

Requests containing any of these placements will not match. Corresponds to the JSON property excludedPlacements

Returns:



1111
1112
1113
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1111

def excluded_placements
  @excluded_placements
end

#excluded_user_lists ⇒ Array<String>

Requests containing any of these users list ids will not match. Corresponds to the JSON property excludedUserLists

Returns:

  • (Array<String>) 


1116
1117
1118
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1116

def excluded_user_lists
  @excluded_user_lists
end

#excluded_verticals ⇒ Array<String>

Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. Corresponds to the JSON property excludedVerticals

Returns:

  • (Array<String>) 


1122
1123
1124
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1122

def excluded_verticals
  @excluded_verticals
end

#geo_criteria_ids ⇒ Array<String>

Requests containing any of these geo criteria ids will match. Corresponds to the JSON property geoCriteriaIds

Returns:

  • (Array<String>) 


1127
1128
1129
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1127

def geo_criteria_ids
  @geo_criteria_ids
end

#is_active ⇒ Boolean Also known as: is_active?

Whether this config is active. Required for all requests. Corresponds to the JSON property isActive

Returns:

  • (Boolean) 


1132
1133
1134
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1132

def is_active
  @is_active
end

#kind ⇒ String

The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". Corresponds to the JSON property kind

Returns:

  • (String) 


1138
1139
1140
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1138

def kind
  @kind
end

#languages ⇒ Array<String>

Request containing any of these language codes will match. Corresponds to the JSON property languages

Returns:

  • (Array<String>) 


1143
1144
1145
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1143

def languages
  @languages
end

#mobile_carriers ⇒ Array<String>

Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. Corresponds to the JSON property mobileCarriers

Returns:

  • (Array<String>) 


1149
1150
1151
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1149

def mobile_carriers
  @mobile_carriers
end

#mobile_devices ⇒ Array<String>

Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. Corresponds to the JSON property mobileDevices

Returns:

  • (Array<String>) 


1155
1156
1157
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1155

def mobile_devices
  @mobile_devices
end

#mobile_operating_system_versions ⇒ Array<String>

Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. Corresponds to the JSON property mobileOperatingSystemVersions

Returns:

  • (Array<String>) 


1161
1162
1163
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1161

def mobile_operating_system_versions
  @mobile_operating_system_versions
end

#placements ⇒ Array<Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Placement>

Requests containing any of these placements will match. Corresponds to the JSON property placements

Returns:



1166
1167
1168
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1166

def placements
  @placements
end

#platforms ⇒ Array<String>

Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. Corresponds to the JSON property platforms

Returns:

  • (Array<String>) 


1173
1174
1175
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1173

def platforms
  @platforms
end

#supported_creative_attributes ⇒ Array<String>

Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. Corresponds to the JSON property supportedCreativeAttributes

Returns:

  • (Array<String>) 


1180
1181
1182
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1180

def supported_creative_attributes
  @supported_creative_attributes
end

#user_lists ⇒ Array<String>

Requests containing any of these user list ids will match. Corresponds to the JSON property userLists

Returns:

  • (Array<String>) 


1185
1186
1187
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1185

def user_lists
  @user_lists
end

#vendor_types ⇒ Array<String>

Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. Corresponds to the JSON property vendorTypes

Returns:

  • (Array<String>) 


1191
1192
1193
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1191

def vendor_types
  @vendor_types
end

#verticals ⇒ Array<String>

Requests containing any of these vertical ids will match. Corresponds to the JSON property verticals

Returns:

  • (Array<String>) 


1196
1197
1198
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1196

def verticals
  @verticals
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
 
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1203

def update!(**args)
  @billing_id = args[:billing_id] if args.key?(:billing_id)
  @config_id = args[:config_id] if args.key?(:config_id)
  @config_name = args[:config_name] if args.key?(:config_name)
  @creative_type = args[:creative_type] if args.key?(:creative_type)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @excluded_content_labels = args[:excluded_content_labels] if args.key?(:excluded_content_labels)
  @excluded_geo_criteria_ids = args[:excluded_geo_criteria_ids] if args.key?(:excluded_geo_criteria_ids)
  @excluded_placements = args[:excluded_placements] if args.key?(:excluded_placements)
  @excluded_user_lists = args[:excluded_user_lists] if args.key?(:excluded_user_lists)
  @excluded_verticals = args[:excluded_verticals] if args.key?(:excluded_verticals)
  @geo_criteria_ids = args[:geo_criteria_ids] if args.key?(:geo_criteria_ids)
  @is_active = args[:is_active] if args.key?(:is_active)
  @kind = args[:kind] if args.key?(:kind)
  @languages = args[:languages] if args.key?(:languages)
  @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers)
  @mobile_devices = args[:mobile_devices] if args.key?(:mobile_devices)
  @mobile_operating_system_versions = args[:mobile_operating_system_versions] if args.key?(:mobile_operating_system_versions)
  @placements = args[:placements] if args.key?(:placements)
  @platforms = args[:platforms] if args.key?(:platforms)
  @supported_creative_attributes = args[:supported_creative_attributes] if args.key?(:supported_creative_attributes)
  @user_lists = args[:user_lists] if args.key?(:user_lists)
  @vendor_types = args[:vendor_types] if args.key?(:vendor_types)
  @verticals = args[:verticals] if args.key?(:verticals)
end