Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / dyn / analytics_v3.management.profiles.html
blob: 9891fed817d5dbb770ce26e1b72a1eac4945c0b1 [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.profiles.html">profiles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]79<p class="firstline">Lists views (profiles) to which the user has access.</p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]83 <pre>Lists views (profiles) to which the user has access.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]84
85Args:
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]86 accountId: string, Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. (required)
87 webPropertyId: string, Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. (required)
88 max_results: integer, The maximum number of views (profiles) to include in this response.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]89 start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
90
91Returns:
92 An object of the form:
93
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]94 { # A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]95 "username": "A String", # Email ID of the authenticated user
96 "kind": "analytics#profiles", # Collection type.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]97 "items": [ # A list of views (profiles).
98 { # JSON template for an Analytics view (profile).
99 "defaultPage": "A String", # Default page for this view (profile).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]100 "kind": "analytics#profile", # Resource type for Analytics profile.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]101 "excludeQueryParameters": "A String", # The query parameters that are excluded from this view (profile).
102 "name": "A String", # Name of this view (profile).
103 "created": "A String", # Time this view (profile) was created.
104 "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.
105 "updated": "A String", # Time this view (profile) was last modified.
106 "siteSearchQueryParameters": "A String", # The site search query parameters for this view (profile).
107 "websiteUrl": "A String", # Website URL for this view (profile).
108 "currency": "A String", # The currency type associated with this view (profile).
109 "internalWebPropertyId": "A String", # Internal ID for the web property to which this view (profile) belongs.
110 "childLink": { # Child link for this view (profile). Points to the list of goals for this view (profile).
111 "href": "A String", # Link to the list of goals for this view (profile).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]112 "type": "analytics#goals", # Value is "analytics#goals".
113 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]114 "eCommerceTracking": True or False, # Indicates whether ecommerce tracking is enabled for this view (profile).
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]115 "timezone": "A String", # Time zone for which this profile has been configured.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]116 "siteSearchCategoryParameters": "A String", # Site search category parameters for this view (profile).
117 "parentLink": { # Parent link for this view (profile). Points to the web property to which this view (profile) belongs.
118 "href": "A String", # Link to the web property to which this view (profile) belongs.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]119 "type": "analytics#webproperty", # Value is "analytics#webproperty".
120 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]121 "type": "A String", # View (Profile) type. Supported types: WEB or APP.
122 "id": "A String", # View (Profile) ID.
123 "selfLink": "A String", # Link for this view (profile).
124 "accountId": "A String", # Account ID to which this view (profile) belongs.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]125 },
126 ],
Joe Gregorio7578da52012-11-01 14:20:00 -0400[diff] [blame]127 "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 Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]128 "previousLink": "A String", # Link to previous page for this view (profile) collection.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]129 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]130 "nextLink": "A String", # Link to next page for this view (profile) collection.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]131 "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response.
132 }</pre>
133</div>
134
135</body></html>