| <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="consumersurveys_v2.html">Consumer Surveys API</a> . <a href="consumersurveys_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: |
| |
| { |
| "owners": [ |
| "A String", |
| ], |
| "mobileAppPanelId": "A String", |
| "name": "A String", |
| "language": "A String", |
| "country": "A String", |
| "isPublicPanel": True or False, |
| }</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. |
| { |
| "owners": [ |
| "A String", |
| ], |
| "mobileAppPanelId": "A String", |
| "name": "A String", |
| "language": "A String", |
| "country": "A String", |
| "isPublicPanel": True or False, |
| }, |
| ], |
| "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: |
| |
| { |
| "owners": [ |
| "A String", |
| ], |
| "mobileAppPanelId": "A String", |
| "name": "A String", |
| "language": "A String", |
| "country": "A String", |
| "isPublicPanel": True or False, |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "owners": [ |
| "A String", |
| ], |
| "mobileAppPanelId": "A String", |
| "name": "A String", |
| "language": "A String", |
| "country": "A String", |
| "isPublicPanel": True or False, |
| }</pre> |
| </div> |
| |
| </body></html> |
