1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="surveys_v2.html">Surveys API</a> . <a href="surveys_v2.mobileapppanels.html">mobileapppanels</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(panelId)</a></code></p>
<p class="firstline">Retrieves a MobileAppPanel that is available to the authenticated user.</p>
<p class="toc_element">
<code><a href="#list">list(startIndex=None, maxResults=None, token=None)</a></code></p>
<p class="firstline">Lists the MobileAppPanels available to the authenticated user.</p>
<p class="toc_element">
<code><a href="#update">update(panelId, body)</a></code></p>
<p class="firstline">Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(panelId)</code>
<pre>Retrieves a MobileAppPanel that is available to the authenticated user.
Args:
panelId: string, External URL ID for the panel. (required)
Returns:
An object of the form:
{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
"owners": [ # 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.
"A String",
],
"mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
"name": "A String", # Human readable name of the audience panel.
"language": "A 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.
"country": "A 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.
"isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(startIndex=None, maxResults=None, token=None)</code>
<pre>Lists the MobileAppPanels available to the authenticated user.
Args:
startIndex: integer, A parameter
maxResults: integer, A parameter
token: string, A parameter
Returns:
An object of the form:
{
"tokenPagination": {
"nextPageToken": "A String",
"previousPageToken": "A String",
},
"pageInfo": {
"totalResults": 42,
"startIndex": 42,
"resultPerPage": 42,
},
"resources": [ # An individual predefined panel of Opinion Rewards mobile users.
{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
"owners": [ # 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.
"A String",
],
"mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
"name": "A String", # Human readable name of the audience panel.
"language": "A 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.
"country": "A 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.
"isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
},
],
"requestId": "A String", # Unique request ID used for logging and debugging. Please include in any error reporting or troubleshooting requests.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(panelId, body)</code>
<pre>Updates a MobileAppPanel. Currently the only property that can be updated is the owners property.
Args:
panelId: string, External URL ID for the panel. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
"owners": [ # 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.
"A String",
],
"mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
"name": "A String", # Human readable name of the audience panel.
"language": "A 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.
"country": "A 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.
"isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
}
Returns:
An object of the form:
{ # Representation of an individual pre-defined panel object defining a targeted audience of opinion rewards mobile app users.
"owners": [ # 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.
"A String",
],
"mobileAppPanelId": "A String", # Unique panel ID string. This corresponds to the mobile_app_panel_id used in Survey Insert requests.
"name": "A String", # Human readable name of the audience panel.
"language": "A 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.
"country": "A 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.
"isPublicPanel": True or False, # Whether or not the panel is accessible to all API users.
}</pre>
</div>
</body></html>
|
