1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body)</a></code></p>
<p class="firstline">Delete data associated with a previous upload.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, webPropertyId, customDataSourceId, uploadId)</a></code></p>
<p class="firstline">List uploads to which the user has access.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</a></code></p>
<p class="firstline">List uploads to which the user has access.</p>
<p class="toc_element">
<code><a href="#uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</a></code></p>
<p class="firstline">Upload data for a custom data source.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="deleteUploadData">deleteUploadData(accountId, webPropertyId, customDataSourceId, body)</code>
<pre>Delete data associated with a previous upload.
Args:
accountId: string, Account Id for the uploads to be deleted. (required)
webPropertyId: string, Web property Id for the uploads to be deleted. (required)
customDataSourceId: string, Custom data source Id for the uploads to be deleted. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Request template for the delete upload data request.
"customDataImportUids": [ # A list of upload UIDs.
"A String",
],
}
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, webPropertyId, customDataSourceId, uploadId)</code>
<pre>List uploads to which the user has access.
Args:
accountId: string, Account Id for the upload to retrieve. (required)
webPropertyId: string, Web property Id for the upload to retrieve. (required)
customDataSourceId: string, Custom data source Id for upload to retrieve. (required)
uploadId: string, Upload Id to retrieve. (required)
Returns:
An object of the form:
{ # Metadata returned for an upload operation.
"status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
"kind": "analytics#upload", # Resource type for Analytics upload.
"errors": [ # Data import errors collection.
"A String",
],
"customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
"uploadTime": "A String", # Time this file is uploaded.
"id": "A String", # A unique ID for this upload.
"accountId": "A String", # Account Id to which this upload belongs.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, max_results=None, start_index=None)</code>
<pre>List uploads to which the user has access.
Args:
accountId: string, Account Id for the uploads to retrieve. (required)
webPropertyId: string, Web property Id for the uploads to retrieve. (required)
customDataSourceId: string, Custom data source Id for uploads to retrieve. (required)
max_results: integer, The maximum number of uploads to include in this response.
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.
Returns:
An object of the form:
{ # 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.
"kind": "analytics#uploads", # Collection type.
"items": [ # A list of uploads.
{ # Metadata returned for an upload operation.
"status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
"kind": "analytics#upload", # Resource type for Analytics upload.
"errors": [ # Data import errors collection.
"A String",
],
"customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
"uploadTime": "A String", # Time this file is uploaded.
"id": "A String", # A unique ID for this upload.
"accountId": "A String", # Account Id to which this upload belongs.
},
],
"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.
"previousLink": "A String", # Link to previous page for this upload collection.
"startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.
"nextLink": "A String", # Link to next page for this upload collection.
"totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result.
}</pre>
</div>
<div class="method">
<code class="details" id="uploadData">uploadData(accountId, webPropertyId, customDataSourceId, media_body=None, media_mime_type=None)</code>
<pre>Upload data for a custom data source.
Args:
accountId: string, Account Id associated with the upload. (required)
webPropertyId: string, Web property UA-string associated with the upload. (required)
customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required)
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Returns:
An object of the form:
{ # Metadata returned for an upload operation.
"status": "A String", # Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.
"kind": "analytics#upload", # Resource type for Analytics upload.
"errors": [ # Data import errors collection.
"A String",
],
"customDataSourceId": "A String", # Custom data source Id to which this data import belongs.
"uploadTime": "A String", # Time this file is uploaded.
"id": "A String", # A unique ID for this upload.
"accountId": "A String", # Account Id to which this upload belongs.
}</pre>
</div>
</body></html>
|
