Class: Google::Apis::DfareportingV3_0::Account

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

Overview

Contains properties of a DCM account.

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) ⇒ Account

Returns a new instance of Account



201
202
203
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 201

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

Instance Attribute Details

#account_permission_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


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

def 
  @account_permission_ids
end

#account_profile ⇒ String

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_v3_0/classes.rb', line 37

def 
  @account_profile
end

#active ⇒ Boolean 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_v3_0/classes.rb', line 42

def active
  @active
end

#active_ads_limit_tier ⇒ String

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_v3_0/classes.rb', line 48

def active_ads_limit_tier
  @active_ads_limit_tier
end

#active_view_opt_out ⇒ Boolean 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_v3_0/classes.rb', line 54

def active_view_opt_out
  @active_view_opt_out
end

#available_permission_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


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

def available_permission_ids
  @available_permission_ids
end

#country_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


65
66
67
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 65

def country_id
  @country_id
end

#currency_id ⇒ Fixnum

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
  • "41" for IDR
  • "42" for CZK
  • "43" for RON
  • "44" for HUF
  • "45" for RUB
  • "46" for AED
  • "47" for BGN
  • "48" for HRK
  • "49" for MXN
  • "50" for NGN Corresponds to the JSON property currencyId

Returns:

  • (Fixnum) 


120
121
122
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 120

def currency_id
  @currency_id
end

#default_creative_size_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


125
126
127
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 125

def default_creative_size_id
  @default_creative_size_id
end

#description ⇒ String

Description of this account. Corresponds to the JSON property description

Returns:

  • (String) 


130
131
132
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 130

def description
  @description
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


135
136
137
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 135

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


141
142
143
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 141

def kind
  @kind
end

#locale ⇒ String

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) 


163
164
165
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 163

def locale
  @locale
end

#maximum_image_size ⇒ Fixnum

Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1. Corresponds to the JSON property maximumImageSize

Returns:

  • (Fixnum) 


169
170
171
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 169

def maximum_image_size
  @maximum_image_size
end

#name ⇒ String

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) 


175
176
177
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 175

def name
  @name
end

#nielsen_ocr_enabled ⇒ Boolean 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) 


181
182
183
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 181

def nielsen_ocr_enabled
  @nielsen_ocr_enabled
end

#reports_configuration ⇒ Google::Apis::DfareportingV3_0::ReportsConfiguration

Reporting Configuration Corresponds to the JSON property reportsConfiguration

Returns:



187
188
189
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 187

def reports_configuration
  @reports_configuration
end

#share_reports_with_twitter ⇒ Boolean Also known as: share_reports_with_twitter?

Share Path to Conversion reports with Twitter. Corresponds to the JSON property shareReportsWithTwitter

Returns:

  • (Boolean) 


192
193
194
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 192

def share_reports_with_twitter
  @share_reports_with_twitter
end

#teaser_size_limit ⇒ Fixnum

File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive. Corresponds to the JSON property teaserSizeLimit

Returns:

  • (Fixnum) 


199
200
201
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 199

def teaser_size_limit
  @teaser_size_limit
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 206

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