openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
f46ea5502e604e4b8e7149dc65d57be67f00e4c6
deb-python-oauth2client/docs/dyn/analytics.v3.management.profiles.html
Joe Gregorio 6621203514 imported patch docs
2012-06-14 09:10:14 -04:00

78 lines
8.3 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Resource</title>
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists&nbsp;profiles&nbsp;to&nbsp;which&nbsp;the&nbsp;user&nbsp;has&nbsp;access.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;profiles&nbsp;to&nbsp;include&nbsp;in&nbsp;this&nbsp;response.<br>
&nbsp;&nbsp;webPropertyId:&nbsp;string,&nbsp;Web&nbsp;property&nbsp;ID&nbsp;for&nbsp;the&nbsp;profiles&nbsp;to&nbsp;retrieve.&nbsp;Can&nbsp;either&nbsp;be&nbsp;a&nbsp;specific&nbsp;web&nbsp;property&nbsp;ID&nbsp;or&nbsp;'~all',&nbsp;which&nbsp;refers&nbsp;to&nbsp;all&nbsp;the&nbsp;web&nbsp;properties&nbsp;to&nbsp;which&nbsp;the&nbsp;user&nbsp;has&nbsp;access.&nbsp;(required)<br>
&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;An&nbsp;index&nbsp;of&nbsp;the&nbsp;first&nbsp;entity&nbsp;to&nbsp;retrieve.&nbsp;Use&nbsp;this&nbsp;parameter&nbsp;as&nbsp;a&nbsp;pagination&nbsp;mechanism&nbsp;along&nbsp;with&nbsp;the&nbsp;max-results&nbsp;parameter.<br>
&nbsp;&nbsp;accountId:&nbsp;string,&nbsp;Account&nbsp;ID&nbsp;for&nbsp;the&nbsp;profiles&nbsp;to&nbsp;retrieve.&nbsp;Can&nbsp;either&nbsp;be&nbsp;a&nbsp;specific&nbsp;account&nbsp;ID&nbsp;or&nbsp;'~all',&nbsp;which&nbsp;refers&nbsp;to&nbsp;all&nbsp;the&nbsp;accounts&nbsp;to&nbsp;which&nbsp;the&nbsp;user&nbsp;has&nbsp;access.&nbsp;(required)<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"username":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Email&nbsp;ID&nbsp;of&nbsp;the&nbsp;authenticated&nbsp;user<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#profiles",&nbsp;#&nbsp;Collection&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;profiles.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"defaultPage":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Default&nbsp;page&nbsp;for&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#profile",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;Analytics&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"excludeQueryParameters":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;query&nbsp;parameters&nbsp;that&nbsp;are&nbsp;excluded&nbsp;from&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;this&nbsp;profile&nbsp;was&nbsp;created.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"webPropertyId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Web&nbsp;property&nbsp;ID&nbsp;of&nbsp;the&nbsp;form&nbsp;UA-XXXXX-YY&nbsp;to&nbsp;which&nbsp;this&nbsp;profile&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;this&nbsp;profile&nbsp;was&nbsp;last&nbsp;modified.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"siteSearchQueryParameters":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;site&nbsp;search&nbsp;query&nbsp;parameters&nbsp;for&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"currency":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;currency&nbsp;type&nbsp;associated&nbsp;with&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"internalWebPropertyId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Internal&nbsp;ID&nbsp;for&nbsp;the&nbsp;web&nbsp;property&nbsp;to&nbsp;which&nbsp;this&nbsp;profile&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"childLink":&nbsp;{&nbsp;#&nbsp;Child&nbsp;link&nbsp;for&nbsp;this&nbsp;profile.&nbsp;Points&nbsp;to&nbsp;the&nbsp;list&nbsp;of&nbsp;goals&nbsp;for&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;list&nbsp;of&nbsp;goals&nbsp;for&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"analytics#goals",&nbsp;#&nbsp;Value&nbsp;is&nbsp;"analytics#goals".<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timezone":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;zone&nbsp;for&nbsp;which&nbsp;this&nbsp;profile&nbsp;has&nbsp;been&nbsp;configured.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"siteSearchCategoryParameters":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Site&nbsp;search&nbsp;category&nbsp;parameters&nbsp;for&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parentLink":&nbsp;{&nbsp;#&nbsp;Parent&nbsp;link&nbsp;for&nbsp;this&nbsp;profile.&nbsp;Points&nbsp;to&nbsp;the&nbsp;web&nbsp;property&nbsp;to&nbsp;which&nbsp;this&nbsp;profile&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;web&nbsp;property&nbsp;to&nbsp;which&nbsp;this&nbsp;profile&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"analytics#webproperty",&nbsp;#&nbsp;Value&nbsp;is&nbsp;"analytics#webproperty".<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Profile&nbsp;ID.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;for&nbsp;this&nbsp;profile.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"accountId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Account&nbsp;ID&nbsp;to&nbsp;which&nbsp;this&nbsp;profile&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;"itemsPerPage":&nbsp;42,&nbsp;#&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;resources&nbsp;the&nbsp;response&nbsp;can&nbsp;contain,&nbsp;regardless&nbsp;of&nbsp;the&nbsp;actual&nbsp;number&nbsp;of&nbsp;resources&nbsp;returned.&nbsp;Its&nbsp;value&nbsp;ranges&nbsp;from&nbsp;1&nbsp;to&nbsp;10,000&nbsp;with&nbsp;a&nbsp;value&nbsp;of&nbsp;1000&nbsp;by&nbsp;default,&nbsp;or&nbsp;otherwise&nbsp;specified&nbsp;by&nbsp;the&nbsp;max-results&nbsp;query&nbsp;parameter.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"previousLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;previous&nbsp;page&nbsp;for&nbsp;this&nbsp;profile&nbsp;collection.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"startIndex":&nbsp;42,&nbsp;#&nbsp;The&nbsp;starting&nbsp;index&nbsp;of&nbsp;the&nbsp;resources,&nbsp;which&nbsp;is&nbsp;1&nbsp;by&nbsp;default&nbsp;or&nbsp;otherwise&nbsp;specified&nbsp;by&nbsp;the&nbsp;start-index&nbsp;query&nbsp;parameter.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"nextLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;next&nbsp;page&nbsp;for&nbsp;this&nbsp;profile&nbsp;collection.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"totalResults":&nbsp;42,&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;results&nbsp;for&nbsp;the&nbsp;query,&nbsp;regardless&nbsp;of&nbsp;the&nbsp;number&nbsp;of&nbsp;results&nbsp;in&nbsp;the&nbsp;response.<br>
&nbsp;&nbsp;}</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>
View Git Blame Copy Permalink