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