Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e52ea21dea8ae127d4e4fbfa54a1056c45cf69b5 / . / docs / dyn / analytics_v3.management.uploads.html
blob: 7f6c68f14c59d622d8a1912c72d0191a5bde78e7 [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">
78 <code><a href="#deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body)</a></code></p>
79<p class="firstline">Delete data associated with a previous upload.</p>
80<p class="toc_element">
81 <code><a href="#get">get(accountId, webPropertyId, customDataSourceId, uploadId)</a></code></p>
82<p class="firstline">List uploads to which the user has access.</p>
83<p class="toc_element">
84 <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</a></code></p>
85<p class="firstline">List uploads to which the user has access.</p>
86<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]87 <code><a href="#migrateDataImport">migrateDataImport(accountId, webPropertyId, customDataSourceId)</a></code></p>
88<p class="firstline">Migrate custom data source and data imports to latest version.</p>
89<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90 <code><a href="#uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=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="deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body)</code>
95 <pre>Delete data associated with a previous upload.
96
97Args:
98 accountId: string, Account Id for the uploads to be deleted. (required)
99 webPropertyId: string, Web property Id for the uploads to be deleted. (required)
100 customDataSourceId: string, Custom data source Id for the uploads to be deleted. (required)
101 body: object, The request body. (required)
102 The object takes the form of:
103
104{ # Request template for the delete upload data request.
105 "customDataImportUids": [ # A list of upload UIDs.
106 "A String",
107 ],
108 }
109
110</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="get">get(accountId, webPropertyId, customDataSourceId, uploadId)</code>
115 <pre>List uploads to which the user has access.
116
117Args:
118 accountId: string, Account Id for the upload to retrieve. (required)
119 webPropertyId: string, Web property Id for the upload to retrieve. (required)
120 customDataSourceId: string, Custom data source Id for upload to retrieve. (required)
121 uploadId: string, Upload Id to retrieve. (required)
122
123Returns:
124 An object of the form:
125
126 { # Metadata returned for an upload operation.
127 "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
128 "kind": "analytics#upload", # Resource type for Analytics upload.
129 "errors": [ # Data import errors collection.
130 "A String",
131 ],
132 "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
133 "id": "A String", # A unique ID for this upload.
134 "accountId": "A String", # Account Id to which this upload belongs.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</code>
140 <pre>List uploads to which the user has access.
141
142Args:
143 accountId: string, Account Id for the uploads to retrieve. (required)
144 webPropertyId: string, Web property Id for the uploads to retrieve. (required)
145 customDataSourceId: string, Custom data source Id for uploads to retrieve. (required)
146 max_results: integer, The maximum number of uploads to include in this response.
147 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.
148
149Returns:
150 An object of the form:
151
152 { # 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.
153 "kind": "analytics#uploads", # Collection type.
154 "items": [ # A list of uploads.
155 { # Metadata returned for an upload operation.
156 "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
157 "kind": "analytics#upload", # Resource type for Analytics upload.
158 "errors": [ # Data import errors collection.
159 "A String",
160 ],
161 "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
162 "id": "A String", # A unique ID for this upload.
163 "accountId": "A String", # Account Id to which this upload belongs.
164 },
165 ],
166 "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.
167 "previousLink": "A String", # Link to previous page for this upload collection.
168 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
169 "nextLink": "A String", # Link to next page for this upload collection.
170 "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
171 }</pre>
172</div>
173
174<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]175 <code class="details" id="migrateDataImport">migrateDataImport(accountId, webPropertyId, customDataSourceId)</code>
176 <pre>Migrate custom data source and data imports to latest version.
177
178Args:
179 accountId: string, Account Id for migration. (required)
180 webPropertyId: string, Web property Id for migration. (required)
181 customDataSourceId: string, Custom data source Id for migration. (required)
182</pre>
183</div>
184
185<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]186 <code class="details" id="uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None)</code>
187 <pre>Upload data for a custom data source.
188
189Args:
190 accountId: string, Account Id associated with the upload. (required)
191 webPropertyId: string, Web property UA-string associated with the upload. (required)
192 customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
193 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
194
195Returns:
196 An object of the form:
197
198 { # Metadata returned for an upload operation.
199 "status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
200 "kind": "analytics#upload", # Resource type for Analytics upload.
201 "errors": [ # Data import errors collection.
202 "A String",
203 ],
204 "customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
205 "id": "A String", # A unique ID for this upload.
206 "accountId": "A String", # Account Id to which this upload belongs.
207 }</pre>
208</div>
209
210</body></html>