Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 5ae088dc027b89517b896a89a0aeb2ca80f492cf / . / docs / dyn / analytics_v3.management.uploads.html
blob: afbc93e22826ad2fcc58568c077f497842b6c6f5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -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.uploads.html">uploads</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]87 <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, start_index=None, max_results=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">List uploads to which the user has access.</p>
89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]90 <code><a href="#uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91<p class="firstline">Upload data for a custom data source.</p>
92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code class="details" id="deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107 The object takes the form of:
108
109{ # Request template for the delete upload data request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &quot;customDataImportUids&quot;: [ # A list of upload UIDs.
111 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]132 &quot;status&quot;: &quot;A String&quot;, # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 &quot;uploadTime&quot;: &quot;A String&quot;, # Time this file is uploaded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;errors&quot;: [ # Data import errors collection.
135 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]137 &quot;customDataSourceId&quot;: &quot;A String&quot;, # Custom data source Id to which this data import belongs.
138 &quot;kind&quot;: &quot;analytics#upload&quot;, # Resource type for Analytics upload.
139 &quot;accountId&quot;: &quot;A String&quot;, # Account Id to which this upload belongs.
140 &quot;id&quot;: &quot;A String&quot;, # A unique ID for this upload.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 }</pre>
142</div>
143
144<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, start_index=None, max_results=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]152 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153 max_results: integer, The maximum number of uploads to include in this response.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]159 &quot;previousLink&quot;: &quot;A String&quot;, # Link to previous page for this upload collection.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 &quot;items&quot;: [ # A list of uploads.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]161 { # Metadata returned for an upload operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 &quot;status&quot;: &quot;A String&quot;, # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]163 &quot;uploadTime&quot;: &quot;A String&quot;, # Time this file is uploaded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &quot;errors&quot;: [ # Data import errors collection.
165 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]166 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]167 &quot;customDataSourceId&quot;: &quot;A String&quot;, # Custom data source Id to which this data import belongs.
168 &quot;kind&quot;: &quot;analytics#upload&quot;, # Resource type for Analytics upload.
169 &quot;accountId&quot;: &quot;A String&quot;, # Account Id to which this upload belongs.
170 &quot;id&quot;: &quot;A String&quot;, # A unique ID for this upload.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 },
172 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]173 &quot;kind&quot;: &quot;analytics#uploads&quot;, # Collection type.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]174 &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 Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]175 &quot;nextLink&quot;: &quot;A String&quot;, # Link to next page for this upload collection.
176 &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.
177 &quot;totalResults&quot;: 42, # The total number of results for the query, regardless of the number of resources in the result.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]178 }</pre>
179</div>
180
181<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]182 <code class="details" id="uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]190 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]191
192Returns:
193 An object of the form:
194
195 { # Metadata returned for an upload operation.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]196 &quot;status&quot;: &quot;A String&quot;, # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]197 &quot;uploadTime&quot;: &quot;A String&quot;, # Time this file is uploaded.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;errors&quot;: [ # Data import errors collection.
199 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]201 &quot;customDataSourceId&quot;: &quot;A String&quot;, # Custom data source Id to which this data import belongs.
202 &quot;kind&quot;: &quot;analytics#upload&quot;, # Resource type for Analytics upload.
203 &quot;accountId&quot;: &quot;A String&quot;, # Account Id to which this upload belongs.
204 &quot;id&quot;: &quot;A String&quot;, # A unique ID for this upload.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 }</pre>
206</div>
207
208</body></html>