Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 84e4180c0b4b453ee9fc59f026e00631bc7af2d2 / . / docs / dyn / analytics.v3.management.webproperties.html
blob: 42f3f64a2de6a3fdbcb8e1eb41290f49141470e9 [file] [log] [blame]
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Lists&nbsp;web&nbsp;properties&nbsp;to&nbsp;which&nbsp;the&nbsp;user&nbsp;has&nbsp;access.<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]20&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
22&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]23&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;web&nbsp;properties&nbsp;to&nbsp;include&nbsp;in&nbsp;this&nbsp;response.<br>
Joe Gregorio66212032012-06-14 09:10:14 -0400[diff] [blame]24&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]25&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>
Joe Gregorio3d55ac52012-02-21 10:11:19 -0500[diff] [blame]26&nbsp;&nbsp;accountId:&nbsp;string,&nbsp;Account&nbsp;ID&nbsp;to&nbsp;retrieve&nbsp;web&nbsp;properties&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>
Joe Gregoriob417caf2011-12-08 12:04:24 -0500[diff] [blame]27&nbsp;<br>
28Returns:<br>
29&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
30&nbsp;<br>
31&nbsp;&nbsp;&nbsp;&nbsp;{<br>
32&nbsp;&nbsp;&nbsp;&nbsp;"username":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Email&nbsp;ID&nbsp;of&nbsp;the&nbsp;authenticated&nbsp;user<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#webproperties",&nbsp;#&nbsp;Collection&nbsp;type.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;web&nbsp;properties.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"analytics#webproperty",&nbsp;#&nbsp;Resource&nbsp;type&nbsp;for&nbsp;Analytics&nbsp;WebProperty.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Name&nbsp;of&nbsp;this&nbsp;web&nbsp;property.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"created":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;this&nbsp;web&nbsp;property&nbsp;was&nbsp;created.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Time&nbsp;this&nbsp;web&nbsp;property&nbsp;was&nbsp;last&nbsp;modified.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"websiteUrl":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Website&nbsp;url&nbsp;for&nbsp;this&nbsp;web&nbsp;property.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"internalWebPropertyId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Internal&nbsp;ID&nbsp;for&nbsp;this&nbsp;web&nbsp;property.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"childLink":&nbsp;{&nbsp;#&nbsp;Child&nbsp;link&nbsp;for&nbsp;this&nbsp;web&nbsp;property.&nbsp;Points&nbsp;to&nbsp;the&nbsp;list&nbsp;of&nbsp;profiles&nbsp;for&nbsp;this&nbsp;web&nbsp;property.<br>
43&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;profiles&nbsp;for&nbsp;this&nbsp;web&nbsp;property.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"analytics#profiles",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;parent&nbsp;link.&nbsp;Its&nbsp;value&nbsp;is&nbsp;"analytics#profiles".<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
46&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parentLink":&nbsp;{&nbsp;#&nbsp;Parent&nbsp;link&nbsp;for&nbsp;this&nbsp;web&nbsp;property.&nbsp;Points&nbsp;to&nbsp;the&nbsp;account&nbsp;to&nbsp;which&nbsp;this&nbsp;web&nbsp;property&nbsp;belongs.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;the&nbsp;account&nbsp;for&nbsp;this&nbsp;web&nbsp;property.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"analytics#account",&nbsp;#&nbsp;Type&nbsp;of&nbsp;the&nbsp;parent&nbsp;link.&nbsp;Its&nbsp;value&nbsp;is&nbsp;"analytics#account".<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Web&nbsp;property&nbsp;ID&nbsp;of&nbsp;the&nbsp;form&nbsp;UA-XXXXX-YY.<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;for&nbsp;this&nbsp;web&nbsp;property.<br>
52&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;web&nbsp;property&nbsp;belongs.<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
54&nbsp;&nbsp;&nbsp;&nbsp;],<br>
55&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>
56&nbsp;&nbsp;&nbsp;&nbsp;"previousLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;previous&nbsp;page&nbsp;for&nbsp;this&nbsp;web&nbsp;property&nbsp;collection.<br>
57&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>
58&nbsp;&nbsp;&nbsp;&nbsp;"nextLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Link&nbsp;to&nbsp;next&nbsp;page&nbsp;for&nbsp;this&nbsp;web&nbsp;property&nbsp;collection.<br>
59&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>
60&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]61
62<hr>
63Data descriptors defined here:<br>
64<dl><dt><strong>__dict__</strong></dt>
65<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
66</dl>
67<dl><dt><strong>__weakref__</strong></dt>
68<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
69</dl>
70</td></tr></table>
71</body></html>