|
167 | 167 |
|
168 | 168 | <dl><dt><strong>api_version</strong> = '2'</dl> |
169 | 169 |
|
170 | | -<dl><dt><strong>auth_scopes</strong> = ['https://www.google.com/analytics/feeds']</dl> |
| 170 | +<dl><dt><strong>auth_scopes</strong> = ('https://www.google.com/analytics/feeds/',)</dl> |
171 | 171 |
|
172 | 172 | <dl><dt><strong>auth_service</strong> = 'analytics'</dl> |
173 | 173 |
|
174 | 174 | <hr> |
175 | 175 | Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br> |
176 | | -<dl><dt><a name="AnalyticsClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xc45ed0></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
| 176 | +<dl><dt><a name="AnalyticsClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xb92550></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
177 | 177 | <br> |
178 | 178 | In order to modify user specific data and read user private data, your<br> |
179 | 179 | application must be authorized by the user. One way to demonstrage<br> |
|
357 | 357 | body will be converted to the class using<br> |
358 | 358 | atom.core.parse.</tt></dd></dl> |
359 | 359 |
|
360 | | -<dl><dt><a name="AnalyticsClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xc45e90></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| 360 | +<dl><dt><a name="AnalyticsClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xb92510></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| 361 | + |
| 362 | +<dl><dt><a name="AnalyticsClient-RevokeToken"><strong>RevokeToken</strong></a> = revoke_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object at 0xb925d0></font>)</dt><dd><tt>Requests that the token be invalidated.<br> |
| 363 | + <br> |
| 364 | +This method can be used for both AuthSub and OAuth tokens (to invalidate<br> |
| 365 | +a ClientLogin token, the user must change their password).<br> |
| 366 | + <br> |
| 367 | +Returns:<br> |
| 368 | + True if the server responded with a 200.<br> |
| 369 | + <br> |
| 370 | +Raises:<br> |
| 371 | + A RequestError if the server responds with a non-200 status.</tt></dd></dl> |
361 | 372 |
|
362 | 373 | <dl><dt><a name="AnalyticsClient-Update"><strong>Update</strong></a> = update(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br> |
363 | 374 | <br> |
|
377 | 388 | Returns:<br> |
378 | 389 | A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl> |
379 | 390 |
|
380 | | -<dl><dt><a name="AnalyticsClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object at 0xc45f10></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
| 391 | +<dl><dt><a name="AnalyticsClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object at 0xb92590></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
381 | 392 | <br> |
382 | 393 | For details on AuthSub, see:<br> |
383 | 394 | <a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br> |
|
394 | 405 | Returns:<br> |
395 | 406 | The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl> |
396 | 407 |
|
397 | | -<dl><dt><a name="AnalyticsClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xc45ed0></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
| 408 | +<dl><dt><a name="AnalyticsClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xb92550></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
398 | 409 | <br> |
399 | 410 | In order to modify user specific data and read user private data, your<br> |
400 | 411 | application must be authorized by the user. One way to demonstrage<br> |
|
578 | 589 | body will be converted to the class using<br> |
579 | 590 | atom.core.parse.</tt></dd></dl> |
580 | 591 |
|
581 | | -<dl><dt><a name="AnalyticsClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xc45e90></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| 592 | +<dl><dt><a name="AnalyticsClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object at 0xb92510></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| 593 | + |
| 594 | +<dl><dt><a name="AnalyticsClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object at 0xb925d0></font>)</dt><dd><tt>Requests that the token be invalidated.<br> |
| 595 | + <br> |
| 596 | +This method can be used for both AuthSub and OAuth tokens (to invalidate<br> |
| 597 | +a ClientLogin token, the user must change their password).<br> |
| 598 | + <br> |
| 599 | +Returns:<br> |
| 600 | + True if the server responded with a 200.<br> |
| 601 | + <br> |
| 602 | +Raises:<br> |
| 603 | + A RequestError if the server responds with a non-200 status.</tt></dd></dl> |
582 | 604 |
|
583 | 605 | <dl><dt><a name="AnalyticsClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br> |
584 | 606 | <br> |
|
598 | 620 | Returns:<br> |
599 | 621 | A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl> |
600 | 622 |
|
601 | | -<dl><dt><a name="AnalyticsClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object at 0xc45f10></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
| 623 | +<dl><dt><a name="AnalyticsClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object at 0xb92590></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
602 | 624 | <br> |
603 | 625 | For details on AuthSub, see:<br> |
604 | 626 | <a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br> |
|
0 commit comments