Class: Google::Apis::DfareportingV2_1::Account

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

Overview

Contains properties of a DCM account.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Account

Returns a new instance of Account.


191
192
193
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 191

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

Instance Attribute Details

#account_permission_idsArray<String>

Account permissions assigned to this account. Corresponds to the JSON property accountPermissionIds

Returns:

  • (Array<String>)

32
33
34
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 32

def 
  @account_permission_ids
end

#account_profileString

Profile for this account. This is a read-only field that can be left blank. Corresponds to the JSON property accountProfile

Returns:

  • (String)

37
38
39
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 37

def 
  @account_profile
end

#activeBoolean Also known as: active?

Whether this account is active. Corresponds to the JSON property active

Returns:

  • (Boolean)

42
43
44
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 42

def active
  @active
end

#active_ads_limit_tierString

Maximum number of active ads allowed for this account. Corresponds to the JSON property activeAdsLimitTier

Returns:

  • (String)

48
49
50
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 48

def active_ads_limit_tier
  @active_ads_limit_tier
end

#active_view_opt_outBoolean Also known as: active_view_opt_out?

Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions. Corresponds to the JSON property activeViewOptOut

Returns:

  • (Boolean)

54
55
56
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 54

def active_view_opt_out
  @active_view_opt_out
end

#available_permission_idsArray<String>

User role permissions available to the user roles of this account. Corresponds to the JSON property availablePermissionIds

Returns:

  • (Array<String>)

60
61
62
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 60

def available_permission_ids
  @available_permission_ids
end

#comscore_vce_enabledBoolean Also known as: comscore_vce_enabled?

Whether campaigns created in this account will be enabled for comScore vCE by default. Corresponds to the JSON property comscoreVceEnabled

Returns:

  • (Boolean)

66
67
68
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 66

def comscore_vce_enabled
  @comscore_vce_enabled
end

#country_idString

ID of the country associated with this account. Corresponds to the JSON property countryId

Returns:

  • (String)

72
73
74
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 72

def country_id
  @country_id
end

#currency_idString

ID of currency associated with this account. This is a required field. Acceptable values are:

  • "1" for USD
  • "2" for GBP
  • "3" for ESP
  • "4" for SEK
  • "5" for CAD
  • "6" for JPY
  • "7" for DEM
  • "8" for AUD
  • "9" for FRF
  • "10" for ITL
  • "11" for DKK
  • "12" for NOK
  • "13" for FIM
  • "14" for ZAR
  • "15" for IEP
  • "16" for NLG
  • "17" for EUR
  • "18" for KRW
  • "19" for TWD
  • "20" for SGD
  • "21" for CNY
  • "22" for HKD
  • "23" for NZD
  • "24" for MYR
  • "25" for BRL
  • "26" for PTE
  • "27" for MXP
  • "28" for CLP
  • "29" for TRY
  • "30" for ARS
  • "31" for PEN
  • "32" for ILS
  • "33" for CHF
  • "34" for VEF
  • "35" for COP
  • "36" for GTQ
  • "37" for PLN
  • "39" for INR
  • "40" for THB Corresponds to the JSON property currencyId

Returns:

  • (String)

117
118
119
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 117

def currency_id
  @currency_id
end

#default_creative_size_idString

Default placement dimensions for this account. Corresponds to the JSON property defaultCreativeSizeId

Returns:

  • (String)

122
123
124
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 122

def default_creative_size_id
  @default_creative_size_id
end

#descriptionString

Description of this account. Corresponds to the JSON property description

Returns:

  • (String)

127
128
129
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 127

def description
  @description
end

#idString

ID of this account. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String)

132
133
134
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 132

def id
  @id
end

#kindString

Identifies what kind of resource this is. Value: the fixed string " dfareporting#account". Corresponds to the JSON property kind

Returns:

  • (String)

138
139
140
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 138

def kind
  @kind
end

#localeString

Locale of this account. Acceptable values are:

  • "cs" (Czech)
  • "de" (German)
  • "en" (English)
  • "en-GB" (English United Kingdom)
  • "es" (Spanish)
  • "fr" (French)
  • "it" (Italian)
  • "ja" (Japanese)
  • "ko" (Korean)
  • "pl" (Polish)
  • "pt-BR" (Portuguese Brazil)
  • "ru" (Russian)
  • "sv" (Swedish)
  • "tr" (Turkish)
  • "zh-CN" (Chinese Simplified)
  • "zh-TW" (Chinese Traditional) Corresponds to the JSON property locale

Returns:

  • (String)

160
161
162
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 160

def locale
  @locale
end

#maximum_image_sizeString

Maximum image size allowed for this account. Corresponds to the JSON property maximumImageSize

Returns:

  • (String)

165
166
167
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 165

def maximum_image_size
  @maximum_image_size
end

#nameString

Name of this account. This is a required field, and must be less than 128 characters long and be globally unique. Corresponds to the JSON property name

Returns:

  • (String)

171
172
173
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 171

def name
  @name
end

#nielsen_ocr_enabledBoolean Also known as: nielsen_ocr_enabled?

Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default. Corresponds to the JSON property nielsenOcrEnabled

Returns:

  • (Boolean)

177
178
179
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 177

def nielsen_ocr_enabled
  @nielsen_ocr_enabled
end

#reports_configurationGoogle::Apis::DfareportingV2_1::ReportsConfiguration

Reporting Configuration Corresponds to the JSON property reportsConfiguration


183
184
185
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 183

def reports_configuration
  @reports_configuration
end

#teaser_size_limitString

File size limit in kilobytes of Rich Media teaser creatives. Must be between 1 and 10240. Corresponds to the JSON property teaserSizeLimit

Returns:

  • (String)

189
190
191
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 189

def teaser_size_limit
  @teaser_size_limit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 196

def update!(**args)
  @account_permission_ids = args[:account_permission_ids] unless args[:account_permission_ids].nil?
  @account_profile = args[:account_profile] unless args[:account_profile].nil?
  @active = args[:active] unless args[:active].nil?
  @active_ads_limit_tier = args[:active_ads_limit_tier] unless args[:active_ads_limit_tier].nil?
  @active_view_opt_out = args[:active_view_opt_out] unless args[:active_view_opt_out].nil?
  @available_permission_ids = args[:available_permission_ids] unless args[:available_permission_ids].nil?
  @comscore_vce_enabled = args[:comscore_vce_enabled] unless args[:comscore_vce_enabled].nil?
  @country_id = args[:country_id] unless args[:country_id].nil?
  @currency_id = args[:currency_id] unless args[:currency_id].nil?
  @default_creative_size_id = args[:default_creative_size_id] unless args[:default_creative_size_id].nil?
  @description = args[:description] unless args[:description].nil?
  @id = args[:id] unless args[:id].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @locale = args[:locale] unless args[:locale].nil?
  @maximum_image_size = args[:maximum_image_size] unless args[:maximum_image_size].nil?
  @name = args[:name] unless args[:name].nil?
  @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] unless args[:nielsen_ocr_enabled].nil?
  @reports_configuration = args[:reports_configuration] unless args[:reports_configuration].nil?
  @teaser_size_limit = args[:teaser_size_limit] unless args[:teaser_size_limit].nil?
end