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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
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::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PretargetingConfig

Returns a new instance of PretargetingConfig.


1257
1258
1259
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1257

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

Instance Attribute Details

#billing_idFixnum

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:

  • (Fixnum)

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

def billing_id
  @billing_id
end

#config_idFixnum

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

Returns:

  • (Fixnum)

1129
1130
1131
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1129

def config_id
  @config_id
end

#config_nameString

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

Returns:

  • (String)

1134
1135
1136
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1134

def config_name
  @config_name
end

#creative_typeArray<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>)

1140
1141
1142
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1140

def creative_type
  @creative_type
end

#dimensionsArray<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


1146
1147
1148
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1146

def dimensions
  @dimensions
end

#excluded_content_labelsArray<Fixnum>

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<Fixnum>)

1152
1153
1154
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1152

def 
  @excluded_content_labels
end

#excluded_geo_criteria_idsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

1157
1158
1159
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1157

def excluded_geo_criteria_ids
  @excluded_geo_criteria_ids
end

#excluded_placementsArray<Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::ExcludedPlacement>

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


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

def excluded_placements
  @excluded_placements
end

#excluded_user_listsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

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

def excluded_user_lists
  @excluded_user_lists
end

#excluded_verticalsArray<Fixnum>

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<Fixnum>)

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

def excluded_verticals
  @excluded_verticals
end

#geo_criteria_idsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

1178
1179
1180
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1178

def geo_criteria_ids
  @geo_criteria_ids
end

#is_activeBoolean Also known as: is_active?

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

Returns:

  • (Boolean)

1183
1184
1185
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1183

def is_active
  @is_active
end

#kindString

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

Returns:

  • (String)

1189
1190
1191
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1189

def kind
  @kind
end

#languagesArray<String>

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

Returns:

  • (Array<String>)

1194
1195
1196
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1194

def languages
  @languages
end

#maximum_qpsFixnum

The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account- level limit may still be imposed). Corresponds to the JSON property maximumQps

Returns:

  • (Fixnum)

1202
1203
1204
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1202

def maximum_qps
  @maximum_qps
end

#mobile_carriersArray<Fixnum>

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<Fixnum>)

1208
1209
1210
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1208

def mobile_carriers
  @mobile_carriers
end

#mobile_devicesArray<Fixnum>

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<Fixnum>)

1214
1215
1216
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1214

def mobile_devices
  @mobile_devices
end

#mobile_operating_system_versionsArray<Fixnum>

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<Fixnum>)

1220
1221
1222
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1220

def mobile_operating_system_versions
  @mobile_operating_system_versions
end

#placementsArray<Google::Apis::AdexchangebuyerV1_3::PretargetingConfig::Placement>

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


1225
1226
1227
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1225

def placements
  @placements
end

#platformsArray<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>)

1232
1233
1234
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1232

def platforms
  @platforms
end

#supported_creative_attributesArray<Fixnum>

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<Fixnum>)

1239
1240
1241
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1239

def supported_creative_attributes
  @supported_creative_attributes
end

#user_listsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

1244
1245
1246
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1244

def user_lists
  @user_lists
end

#vendor_typesArray<Fixnum>

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<Fixnum>)

1250
1251
1252
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1250

def vendor_types
  @vendor_types
end

#verticalsArray<Fixnum>

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

Returns:

  • (Array<Fixnum>)

1255
1256
1257
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1255

def verticals
  @verticals
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
# File 'generated/google/apis/adexchangebuyer_v1_3/classes.rb', line 1262

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)
  @maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps)
  @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