blob: 861b9e4d840c25af04c37aac909a6531bafc3006 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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.customDataSources.html">customDataSources</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070078 <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<p class="firstline">List custom data sources to which the user has access.</p>
80<h3>Method Details</h3>
81<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070082 <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040083 <pre>List custom data sources to which the user has access.
84
85Args:
86 accountId: string, Account Id for the custom data sources to retrieve. (required)
87 webPropertyId: string, Web property Id for the custom data sources to retrieve. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -070088 max_results: integer, The maximum number of custom data sources to include in this response.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070089 start_index: integer, A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
John Asmuth614db982014-04-24 15:46:26 -040090
91Returns:
92 An object of the form:
93
94 { # Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.
Bu Sun Kim65020912020-05-20 12:08:20 -070095 &quot;items&quot;: [ # Collection of custom data sources.
John Asmuth614db982014-04-24 15:46:26 -040096 { # JSON template for an Analytics custom data source.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070097 &quot;schema&quot;: [ # Collection of schema headers of the custom data source.
98 &quot;A String&quot;,
99 ],
100 &quot;id&quot;: &quot;A String&quot;, # Custom data source ID.
101 &quot;profilesLinked&quot;: [ # IDs of views (profiles) linked to the custom data source.
102 &quot;A String&quot;,
103 ],
104 &quot;webPropertyId&quot;: &quot;A String&quot;, # Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.
105 &quot;childLink&quot;: {
106 &quot;href&quot;: &quot;A String&quot;, # Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.
107 &quot;type&quot;: &quot;A String&quot;, # Value is &quot;analytics#dailyUploads&quot;. Value is &quot;analytics#uploads&quot;.
108 },
109 &quot;importBehavior&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700110 &quot;uploadType&quot;: &quot;A String&quot;, # Upload type of the custom data source.
111 &quot;type&quot;: &quot;A String&quot;, # Type of the custom data source.
112 &quot;selfLink&quot;: &quot;A String&quot;, # Link for this Analytics custom data source.
113 &quot;updated&quot;: &quot;A String&quot;, # Time this custom data source was last modified.
114 &quot;kind&quot;: &quot;analytics#customDataSource&quot;, # Resource type for Analytics custom data source.
115 &quot;created&quot;: &quot;A String&quot;, # Time this custom data source was created.
116 &quot;description&quot;: &quot;A String&quot;, # Description of custom data source.
117 &quot;parentLink&quot;: { # Parent link for this custom data source. Points to the web property to which this custom data source belongs.
118 &quot;href&quot;: &quot;A String&quot;, # Link to the web property to which this custom data source belongs.
119 &quot;type&quot;: &quot;analytics#webproperty&quot;, # Value is &quot;analytics#webproperty&quot;.
John Asmuth614db982014-04-24 15:46:26 -0400120 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 &quot;name&quot;: &quot;A String&quot;, # Name of this custom data source.
122 &quot;accountId&quot;: &quot;A String&quot;, # Account ID to which this custom data source belongs.
John Asmuth614db982014-04-24 15:46:26 -0400123 },
124 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700125 &quot;username&quot;: &quot;A String&quot;, # Email ID of the authenticated user
126 &quot;itemsPerPage&quot;: 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.
127 &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700128 &quot;kind&quot;: &quot;analytics#customDataSources&quot;, # Collection type.
129 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this custom data source collection.
130 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this custom data source collection.
131 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of results in the response.
John Asmuth614db982014-04-24 15:46:26 -0400132 }</pre>
133</div>
134
135</body></html>