openstack/deb-python-oauth2client
Code Issues Proposed changes
Files
08cdcb829e8a5e175035b8c106f4ba58a832c9d0
deb-python-oauth2client/docs/dyn/analytics.v3.management.goals.html
Joe Gregorio 3d55ac5b60 Update generated docs.
2012-02-21 10:11:19 -05:00

102 lines
12 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;goals&nbsp;to&nbsp;which&nbsp;the&nbsp;user&nbsp;has&nbsp;access.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;goals&nbsp;to&nbsp;include&nbsp;in&nbsp;this&nbsp;response.<br>
&nbsp;&nbsp;webPropertyId:&nbsp;string,&nbsp;Web&nbsp;property&nbsp;ID&nbsp;to&nbsp;retrieve&nbsp;goals&nbsp;for.&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;that&nbsp;user&nbsp;has&nbsp;access&nbsp;to.&nbsp;(required)<br>
&nbsp;&nbsp;profileId:&nbsp;string,&nbsp;Profile&nbsp;ID&nbsp;to&nbsp;retrieve&nbsp;goals&nbsp;for.&nbsp;Can&nbsp;either&nbsp;be&nbsp;a&nbsp;specific&nbsp;profile&nbsp;ID&nbsp;or&nbsp;'~all',&nbsp;which&nbsp;refers&nbsp;to&nbsp;all&nbsp;the&nbsp;profiles&nbsp;that&nbsp;user&nbsp;has&nbsp;access&nbsp;to.&nbsp;(required)<br>
&nbsp;&nbsp;start_index:&nbsp;integer,&nbsp;An&nbsp;index&nbsp;of&nbsp;the&nbsp;first&nbsp;goal&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;to&nbsp;retrieve&nbsp;goals&nbsp;for.&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;that&nbsp;user&nbsp;has&nbsp;access&nbsp;to.&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#goals",&nbsp;#&nbsp;Collection&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;goals.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#goal",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;an&nbsp;Analytics&nbsp;goal.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"visitTimeOnSiteDetails":&nbsp;{&nbsp;#&nbsp;Details&nbsp;for&nbsp;the&nbsp;goal&nbsp;of&nbsp;the&nbsp;type&nbsp;VISIT_TIME_ON_SITE.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comparisonType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;comparison.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;LESS_THAN&nbsp;or&nbsp;GREATER_THAN.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comparisonValue":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;used&nbsp;for&nbsp;this&nbsp;comparison.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Goal&nbsp;name.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;this&nbsp;goal&nbsp;was&nbsp;created.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"urlDestinationDetails":&nbsp;{&nbsp;#&nbsp;Details&nbsp;for&nbsp;the&nbsp;goal&nbsp;of&nbsp;the&nbsp;type&nbsp;URL_DESTINATION.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;for&nbsp;this&nbsp;goal.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"caseSensitive":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Determines&nbsp;if&nbsp;the&nbsp;goal&nbsp;URL&nbsp;must&nbsp;exactly&nbsp;match&nbsp;the&nbsp;capitalization&nbsp;of&nbsp;visited&nbsp;URLs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"matchType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Match&nbsp;type&nbsp;for&nbsp;the&nbsp;goal&nbsp;URL.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;HEAD,&nbsp;EXACT,&nbsp;or&nbsp;REGEX.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"steps":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;steps&nbsp;configured&nbsp;for&nbsp;this&nbsp;goal&nbsp;funnel.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;for&nbsp;this&nbsp;step.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Step&nbsp;name.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"number":&nbsp;42,&nbsp;#&nbsp;Step&nbsp;number.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"firstStepRequired":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Determines&nbsp;if&nbsp;the&nbsp;first&nbsp;step&nbsp;in&nbsp;this&nbsp;goal&nbsp;is&nbsp;required.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;this&nbsp;goal&nbsp;was&nbsp;last&nbsp;modified.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value":&nbsp;3.14,&nbsp;#&nbsp;Goal&nbsp;value.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"visitNumPagesDetails":&nbsp;{&nbsp;#&nbsp;Details&nbsp;for&nbsp;the&nbsp;goal&nbsp;of&nbsp;the&nbsp;type&nbsp;VISIT_NUM_PAGES.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comparisonType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;comparison.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;LESS_THAN,&nbsp;GREATER_THAN,&nbsp;or&nbsp;EQUAL.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comparisonValue":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;used&nbsp;for&nbsp;this&nbsp;comparison.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<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;goal&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"eventDetails":&nbsp;{&nbsp;#&nbsp;Details&nbsp;for&nbsp;the&nbsp;goal&nbsp;of&nbsp;the&nbsp;type&nbsp;EVENT.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"eventConditions":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;event&nbsp;conditions.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;this&nbsp;event&nbsp;condition.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;CATEGORY,&nbsp;ACTION,&nbsp;LABEL,&nbsp;or&nbsp;VALUE.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"matchType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;match&nbsp;to&nbsp;be&nbsp;performed.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;REGEXP,&nbsp;BEGINS_WITH,&nbsp;or&nbsp;EXACT.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"expression":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Expression&nbsp;used&nbsp;for&nbsp;this&nbsp;match.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comparisonType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Type&nbsp;of&nbsp;comparison.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;LESS_THAN,&nbsp;GREATER_THAN&nbsp;or&nbsp;EQUAL.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comparisonValue":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Value&nbsp;used&nbsp;for&nbsp;this&nbsp;comparison.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"useEventValue":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Determines&nbsp;if&nbsp;the&nbsp;event&nbsp;value&nbsp;should&nbsp;be&nbsp;used&nbsp;as&nbsp;the&nbsp;value&nbsp;for&nbsp;this&nbsp;goal.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"webPropertyId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Web&nbsp;property&nbsp;ID&nbsp;to&nbsp;which&nbsp;this&nbsp;goal&nbsp;belongs.&nbsp;The&nbsp;web&nbsp;property&nbsp;ID&nbsp;is&nbsp;of&nbsp;the&nbsp;form&nbsp;UA-XXXXX-YY.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Determines&nbsp;whether&nbsp;this&nbsp;goal&nbsp;is&nbsp;active.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"profileId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Profile&nbsp;ID&nbsp;to&nbsp;which&nbsp;this&nbsp;goal&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parentLink":&nbsp;{&nbsp;#&nbsp;Parent&nbsp;link&nbsp;for&nbsp;a&nbsp;goal.&nbsp;Points&nbsp;to&nbsp;the&nbsp;profile&nbsp;to&nbsp;which&nbsp;this&nbsp;goal&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;profile&nbsp;to&nbsp;which&nbsp;this&nbsp;goal&nbsp;belongs.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"analytics#profile",&nbsp;#&nbsp;Value&nbsp;is&nbsp;"analytics#profile".<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Goal&nbsp;type.&nbsp;Possible&nbsp;values&nbsp;are&nbsp;URL_DESTINATION,&nbsp;VISIT_TIME_ON_SITE,&nbsp;VISIT_NUM_PAGES,&nbsp;AND&nbsp;EVENT.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Goal&nbsp;ID.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;for&nbsp;this&nbsp;goal.<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;goal&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;goal&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;goal&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;resources&nbsp;in&nbsp;the&nbsp;result.<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