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.unsampledReports.html">unsampledReports</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="#delete">delete(accountId, webPropertyId, profileId, unsampledReportId)</a></code></p> 82<p class="firstline">Deletes an unsampled report.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(accountId, webPropertyId, profileId, unsampledReportId)</a></code></p> 85<p class="firstline">Returns a single unsampled report.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(accountId, webPropertyId, profileId, body=None)</a></code></p> 88<p class="firstline">Create a new unsampled report.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p> 91<p class="firstline">Lists unsampled reports to which the user has access.</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="delete">delete(accountId, webPropertyId, profileId, unsampledReportId)</code> 100 <pre>Deletes an unsampled report. 101 102Args: 103 accountId: string, Account ID to delete the unsampled report for. (required) 104 webPropertyId: string, Web property ID to delete the unsampled reports for. (required) 105 profileId: string, View (Profile) ID to delete the unsampled report for. (required) 106 unsampledReportId: string, ID of the unsampled report to be deleted. (required) 107</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="get">get(accountId, webPropertyId, profileId, unsampledReportId)</code> 112 <pre>Returns a single unsampled report. 113 114Args: 115 accountId: string, Account ID to retrieve unsampled report for. (required) 116 webPropertyId: string, Web property ID to retrieve unsampled reports for. (required) 117 profileId: string, View (Profile) ID to retrieve unsampled report for. (required) 118 unsampledReportId: string, ID of the unsampled report to retrieve. (required) 119 120Returns: 121 An object of the form: 122 123 { # JSON template for Analytics unsampled report resource. 124 "accountId": "A String", # Account ID to which this unsampled report belongs. 125 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 126 "bucketId": "A String", # Id of the bucket the file object is stored in. 127 "objectId": "A String", # Id of the file object containing the report data. 128 }, 129 "created": "A String", # Time this unsampled report was created. 130 "dimensions": "A String", # The dimensions for the unsampled report. 131 "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. 132 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 133 "documentId": "A String", # Id of the document/file containing the report data. 134 }, 135 "end-date": "A String", # The end date for the unsampled report. 136 "filters": "A String", # The filters for the unsampled report. 137 "id": "A String", # Unsampled report ID. 138 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 139 "metrics": "A String", # The metrics for the unsampled report. 140 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 141 "segment": "A String", # The segment for the unsampled report. 142 "selfLink": "A String", # Link for this unsampled report. 143 "start-date": "A String", # The start date for the unsampled report. 144 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 145 "title": "A String", # Title of the unsampled report. 146 "updated": "A String", # Time this unsampled report was last modified. 147 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 148}</pre> 149</div> 150 151<div class="method"> 152 <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body=None)</code> 153 <pre>Create a new unsampled report. 154 155Args: 156 accountId: string, Account ID to create the unsampled report for. (required) 157 webPropertyId: string, Web property ID to create the unsampled report for. (required) 158 profileId: string, View (Profile) ID to create the unsampled report for. (required) 159 body: object, The request body. 160 The object takes the form of: 161 162{ # JSON template for Analytics unsampled report resource. 163 "accountId": "A String", # Account ID to which this unsampled report belongs. 164 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 165 "bucketId": "A String", # Id of the bucket the file object is stored in. 166 "objectId": "A String", # Id of the file object containing the report data. 167 }, 168 "created": "A String", # Time this unsampled report was created. 169 "dimensions": "A String", # The dimensions for the unsampled report. 170 "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. 171 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 172 "documentId": "A String", # Id of the document/file containing the report data. 173 }, 174 "end-date": "A String", # The end date for the unsampled report. 175 "filters": "A String", # The filters for the unsampled report. 176 "id": "A String", # Unsampled report ID. 177 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 178 "metrics": "A String", # The metrics for the unsampled report. 179 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 180 "segment": "A String", # The segment for the unsampled report. 181 "selfLink": "A String", # Link for this unsampled report. 182 "start-date": "A String", # The start date for the unsampled report. 183 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 184 "title": "A String", # Title of the unsampled report. 185 "updated": "A String", # Time this unsampled report was last modified. 186 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 187} 188 189 190Returns: 191 An object of the form: 192 193 { # JSON template for Analytics unsampled report resource. 194 "accountId": "A String", # Account ID to which this unsampled report belongs. 195 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 196 "bucketId": "A String", # Id of the bucket the file object is stored in. 197 "objectId": "A String", # Id of the file object containing the report data. 198 }, 199 "created": "A String", # Time this unsampled report was created. 200 "dimensions": "A String", # The dimensions for the unsampled report. 201 "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. 202 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 203 "documentId": "A String", # Id of the document/file containing the report data. 204 }, 205 "end-date": "A String", # The end date for the unsampled report. 206 "filters": "A String", # The filters for the unsampled report. 207 "id": "A String", # Unsampled report ID. 208 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 209 "metrics": "A String", # The metrics for the unsampled report. 210 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 211 "segment": "A String", # The segment for the unsampled report. 212 "selfLink": "A String", # Link for this unsampled report. 213 "start-date": "A String", # The start date for the unsampled report. 214 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 215 "title": "A String", # Title of the unsampled report. 216 "updated": "A String", # Time this unsampled report was last modified. 217 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 218}</pre> 219</div> 220 221<div class="method"> 222 <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code> 223 <pre>Lists unsampled reports to which the user has access. 224 225Args: 226 accountId: string, Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. (required) 227 webPropertyId: string, Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. (required) 228 profileId: string, View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. (required) 229 max_results: integer, The maximum number of unsampled reports to include in this response. 230 start_index: integer, An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. 231 232Returns: 233 An object of the form: 234 235 { # An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report. 236 "items": [ # A list of unsampled reports. 237 { # JSON template for Analytics unsampled report resource. 238 "accountId": "A String", # Account ID to which this unsampled report belongs. 239 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 240 "bucketId": "A String", # Id of the bucket the file object is stored in. 241 "objectId": "A String", # Id of the file object containing the report data. 242 }, 243 "created": "A String", # Time this unsampled report was created. 244 "dimensions": "A String", # The dimensions for the unsampled report. 245 "downloadType": "A String", # The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. 246 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 247 "documentId": "A String", # Id of the document/file containing the report data. 248 }, 249 "end-date": "A String", # The end date for the unsampled report. 250 "filters": "A String", # The filters for the unsampled report. 251 "id": "A String", # Unsampled report ID. 252 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 253 "metrics": "A String", # The metrics for the unsampled report. 254 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 255 "segment": "A String", # The segment for the unsampled report. 256 "selfLink": "A String", # Link for this unsampled report. 257 "start-date": "A String", # The start date for the unsampled report. 258 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 259 "title": "A String", # Title of the unsampled report. 260 "updated": "A String", # Time this unsampled report was last modified. 261 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 262 }, 263 ], 264 "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. 265 "kind": "analytics#unsampledReports", # Collection type. 266 "nextLink": "A String", # Link to next page for this unsampled report collection. 267 "previousLink": "A String", # Link to previous page for this unsampled report collection. 268 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. 269 "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result. 270 "username": "A String", # Email ID of the authenticated user 271}</pre> 272</div> 273 274</body></html>