Class: Google::Apis::SurveysV2::MobileAppPanel

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

Overview

Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.

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

Returns a new instance of MobileAppPanel



94
95
96
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 94

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

Instance Attribute Details

#country ⇒ String

Country code for the country of the users that the panel contains. Uses standard ISO 3166-1 2-character language codes. For instance, 'US' for the United States, and 'GB' for the United Kingdom. Any survey created targeting this panel must also target the corresponding country. Corresponds to the JSON property country

Returns:

  • (String) 


61
62
63
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 61

def country
  @country
end

#is_public_panel ⇒ Boolean Also known as: is_public_panel?

Whether or not the panel is accessible to all API users. Corresponds to the JSON property isPublicPanel

Returns:

  • (Boolean) 


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

def is_public_panel
  @is_public_panel
end

#language ⇒ String

Language code that the panel can target. For instance, 'en-US'. Uses standard BCP47 language codes. See specification. Any survey created targeting this panel must also target the corresponding language. Corresponds to the JSON property language

Returns:

  • (String) 


74
75
76
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 74

def language
  @language
end

#mobile_app_panel_id ⇒ String

Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests. Corresponds to the JSON property mobileAppPanelId

Returns:

  • (String) 


80
81
82
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 80

def mobile_app_panel_id
  @mobile_app_panel_id
end

#name ⇒ String

Human readable name of the audience panel. Corresponds to the JSON property name

Returns:

  • (String) 


85
86
87
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 85

def name
  @name
end

#owners ⇒ Array<String>

List of email addresses for users who can target members of this panel. Must contain at least the address of the user making the API call for panels that are not public. This field will be empty for public panels. Corresponds to the JSON property owners

Returns:

  • (Array<String>) 


92
93
94
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 92

def owners
  @owners
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



99
100
101
102
103
104
105
106
 
# File 'generated/google/apis/surveys_v2/classes.rb', line 99

def update!(**args)
  @country = args[:country] if args.key?(:country)
  @is_public_panel = args[:is_public_panel] if args.key?(:is_public_panel)
  @language = args[:language] if args.key?(:language)
  @mobile_app_panel_id = args[:mobile_app_panel_id] if args.key?(:mobile_app_panel_id)
  @name = args[:name] if args.key?(:name)
  @owners = args[:owners] if args.key?(:owners)
end