Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 956c12065419c74cd788bc3e51e40ce4a53223b0 / . / docs / dyn / analytics_v3.management.webproperties.html
blob: 1ed414e0ae3c7c007f5562e70124a945ce835a84 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analytics_v3.html">Google Analytics API</a> . <a href="analytics_v3.management.html">management</a> . <a href="analytics_v3.management.webproperties.html">webproperties</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(accountId, max_results=None, start_index=None)</a></code></p>
79<p class="firstline">Lists web properties to which the user has access.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="list">list(accountId, max_results=None, start_index=None)</code>
83 <pre>Lists web properties to which the user has access.
84
85Args:
86 accountId: string, Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. (required)
87 max_results: integer, The maximum number of web properties to include in this response.
88 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
89
90Returns:
91 An object of the form:
92
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]93 { # A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]94 "username": "A String", # Email ID of the authenticated user
95 "kind": "analytics#webproperties", # Collection type.
96 "items": [ # A list of web properties.
Joe Gregorioad8013f2012-08-03 08:44:02 -0400[diff] [blame]97 { # JSON template for an Analytics web property.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]98 "websiteUrl": "A String", # Website url for this web property.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]99 "kind": "analytics#webproperty", # Resource type for Analytics WebProperty.
100 "name": "A String", # Name of this web property.
101 "created": "A String", # Time this web property was created.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]102 "level": "A String", # Level for this web property. Possible values are STANDARD or PREMIUM.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]103 "updated": "A String", # Time this web property was last modified.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]104 "profileCount": 42, # View (Profile) count for this web property.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]105 "internalWebPropertyId": "A String", # Internal ID for this web property.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]106 "childLink": { # Child link for this web property. Points to the list of views (profiles) for this web property.
107 "href": "A String", # Link to the list of views (profiles) for this web property.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]108 "type": "analytics#profiles", # Type of the parent link. Its value is "analytics#profiles".
109 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]110 "industryVertical": "A String", # The industry vertical/category selected for this web property.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]111 "parentLink": { # Parent link for this web property. Points to the account to which this web property belongs.
112 "href": "A String", # Link to the account for this web property.
113 "type": "analytics#account", # Type of the parent link. Its value is "analytics#account".
114 },
115 "id": "A String", # Web property ID of the form UA-XXXXX-YY.
116 "selfLink": "A String", # Link for this web property.
117 "accountId": "A String", # Account ID to which this web property belongs.
118 },
119 ],
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]120 "itemsPerPage": 42, # The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]121 "previousLink": "A String", # Link to previous page for this web property collection.
122 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
123 "nextLink": "A String", # Link to next page for this web property collection.
124 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
125 }</pre>
126</div>
127
128</body></html>