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