• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.uploads.html">uploads</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body=None)</a></code></p>
82<p class="firstline">Delete data associated with a previous upload.</p>
83<p class="toc_element">
84  <code><a href="#get">get(accountId, webPropertyId, customDataSourceId, uploadId)</a></code></p>
85<p class="firstline">List uploads to which the user has access.</p>
86<p class="toc_element">
87  <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</a></code></p>
88<p class="firstline">List uploads to which the user has access.</p>
89<p class="toc_element">
90  <code><a href="#uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</a></code></p>
91<p class="firstline">Upload data for a custom data source.</p>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="close">close()</code>
95  <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
99    <code class="details" id="deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body=None)</code>
100  <pre>Delete data associated with a previous upload.
101
102Args:
103  accountId: string, Account Id for the uploads to be deleted. (required)
104  webPropertyId: string, Web property Id for the uploads to be deleted. (required)
105  customDataSourceId: string, Custom data source Id for the uploads to be deleted. (required)
106  body: object, The request body.
107    The object takes the form of:
108
109{ # Request template for the delete upload data request.
110  &quot;customDataImportUids&quot;: [ # A list of upload UIDs.
111    &quot;A String&quot;,
112  ],
113}
114
115</pre>
116</div>
117
118<div class="method">
119    <code class="details" id="get">get(accountId, webPropertyId, customDataSourceId, uploadId)</code>
120  <pre>List uploads to which the user has access.
121
122Args:
123  accountId: string, Account Id for the upload to retrieve. (required)
124  webPropertyId: string, Web property Id for the upload to retrieve. (required)
125  customDataSourceId: string, Custom data source Id for upload to retrieve. (required)
126  uploadId: string, Upload Id to retrieve. (required)
127
128Returns:
129  An object of the form:
130
131    { # Metadata returned for an upload operation.
132  &quot;accountId&quot;: &quot;A String&quot;, # Account Id to which this upload belongs.
133  &quot;customDataSourceId&quot;: &quot;A String&quot;, # Custom data source Id to which this data import belongs.
134  &quot;errors&quot;: [ # Data import errors collection.
135    &quot;A String&quot;,
136  ],
137  &quot;id&quot;: &quot;A String&quot;, # A unique ID for this upload.
138  &quot;kind&quot;: &quot;analytics#upload&quot;, # Resource type for Analytics upload.
139  &quot;status&quot;: &quot;A String&quot;, # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
140  &quot;uploadTime&quot;: &quot;A String&quot;, # Time this file is uploaded.
141}</pre>
142</div>
143
144<div class="method">
145    <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</code>
146  <pre>List uploads to which the user has access.
147
148Args:
149  accountId: string, Account Id for the uploads to retrieve. (required)
150  webPropertyId: string, Web property Id for the uploads to retrieve. (required)
151  customDataSourceId: string, Custom data source Id for uploads to retrieve. (required)
152  max_results: integer, The maximum number of uploads to include in this response.
153  start_index: integer, A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.
154
155Returns:
156  An object of the form:
157
158    { # Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.
159  &quot;items&quot;: [ # A list of uploads.
160    { # Metadata returned for an upload operation.
161      &quot;accountId&quot;: &quot;A String&quot;, # Account Id to which this upload belongs.
162      &quot;customDataSourceId&quot;: &quot;A String&quot;, # Custom data source Id to which this data import belongs.
163      &quot;errors&quot;: [ # Data import errors collection.
164        &quot;A String&quot;,
165      ],
166      &quot;id&quot;: &quot;A String&quot;, # A unique ID for this upload.
167      &quot;kind&quot;: &quot;analytics#upload&quot;, # Resource type for Analytics upload.
168      &quot;status&quot;: &quot;A String&quot;, # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
169      &quot;uploadTime&quot;: &quot;A String&quot;, # Time this file is uploaded.
170    },
171  ],
172  &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.
173  &quot;kind&quot;: &quot;analytics#uploads&quot;, # Collection type.
174  &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this upload collection.
175  &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this upload collection.
176  &quot;startIndex&quot;: 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
177  &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of resources in the result.
178}</pre>
179</div>
180
181<div class="method">
182    <code class="details" id="uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</code>
183  <pre>Upload data for a custom data source.
184
185Args:
186  accountId: string, Account Id associated with the upload. (required)
187  webPropertyId: string, Web property UA-string associated with the upload. (required)
188  customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
189  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
190  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
191
192Returns:
193  An object of the form:
194
195    { # Metadata returned for an upload operation.
196  &quot;accountId&quot;: &quot;A String&quot;, # Account Id to which this upload belongs.
197  &quot;customDataSourceId&quot;: &quot;A String&quot;, # Custom data source Id to which this data import belongs.
198  &quot;errors&quot;: [ # Data import errors collection.
199    &quot;A String&quot;,
200  ],
201  &quot;id&quot;: &quot;A String&quot;, # A unique ID for this upload.
202  &quot;kind&quot;: &quot;analytics#upload&quot;, # Resource type for Analytics upload.
203  &quot;status&quot;: &quot;A String&quot;, # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
204  &quot;uploadTime&quot;: &quot;A String&quot;, # Time this file is uploaded.
205}</pre>
206</div>
207
208</body></html>