1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="#delete">delete(accountId, webPropertyId, profileId, unsampledReportId)</a></code></p> 79 <p class="firstline">Deletes an unsampled report.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(accountId, webPropertyId, profileId, unsampledReportId)</a></code></p> 82 <p class="firstline">Returns a single unsampled report.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(accountId, webPropertyId, profileId, body)</a></code></p> 85 <p class="firstline">Create a new unsampled report.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</a></code></p> 88 <p class="firstline">Lists unsampled reports to which the user has access.</p> 89 <h3>Method Details</h3> 90 <div class="method"> 91 <code class="details" id="delete">delete(accountId, webPropertyId, profileId, unsampledReportId)</code> 92 <pre>Deletes an unsampled report. 93 94 Args: 95 accountId: string, Account ID to delete the unsampled report for. (required) 96 webPropertyId: string, Web property ID to delete the unsampled reports for. (required) 97 profileId: string, View (Profile) ID to delete the unsampled report for. (required) 98 unsampledReportId: string, ID of the unsampled report to be deleted. (required) 99 </pre> 100 </div> 101 102 <div class="method"> 103 <code class="details" id="get">get(accountId, webPropertyId, profileId, unsampledReportId)</code> 104 <pre>Returns a single unsampled report. 105 106 Args: 107 accountId: string, Account ID to retrieve unsampled report for. (required) 108 webPropertyId: string, Web property ID to retrieve unsampled reports for. (required) 109 profileId: string, View (Profile) ID to retrieve unsampled report for. (required) 110 unsampledReportId: string, ID of the unsampled report to retrieve. (required) 111 112 Returns: 113 An object of the form: 114 115 { # JSON template for Analytics unsampled report resource. 116 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 117 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 118 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 119 "bucketId": "A String", # Id of the bucket the file object is stored in. 120 "objectId": "A String", # Id of the file object containing the report data. 121 }, 122 "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. 123 "dimensions": "A String", # The dimensions for the unsampled report. 124 "created": "A String", # Time this unsampled report was created. 125 "segment": "A String", # The segment for the unsampled report. 126 "start-date": "A String", # The start date for the unsampled report. 127 "updated": "A String", # Time this unsampled report was last modified. 128 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 129 "documentId": "A String", # Id of the document/file containing the report data. 130 }, 131 "metrics": "A String", # The metrics for the unsampled report. 132 "title": "A String", # Title of the unsampled report. 133 "filters": "A String", # The filters for the unsampled report. 134 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 135 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 136 "end-date": "A String", # The end date for the unsampled report. 137 "id": "A String", # Unsampled report ID. 138 "selfLink": "A String", # Link for this unsampled report. 139 "accountId": "A String", # Account ID to which this unsampled report belongs. 140 }</pre> 141 </div> 142 143 <div class="method"> 144 <code class="details" id="insert">insert(accountId, webPropertyId, profileId, body)</code> 145 <pre>Create a new unsampled report. 146 147 Args: 148 accountId: string, Account ID to create the unsampled report for. (required) 149 webPropertyId: string, Web property ID to create the unsampled report for. (required) 150 profileId: string, View (Profile) ID to create the unsampled report for. (required) 151 body: object, The request body. (required) 152 The object takes the form of: 153 154 { # JSON template for Analytics unsampled report resource. 155 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 156 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 157 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 158 "bucketId": "A String", # Id of the bucket the file object is stored in. 159 "objectId": "A String", # Id of the file object containing the report data. 160 }, 161 "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. 162 "dimensions": "A String", # The dimensions for the unsampled report. 163 "created": "A String", # Time this unsampled report was created. 164 "segment": "A String", # The segment for the unsampled report. 165 "start-date": "A String", # The start date for the unsampled report. 166 "updated": "A String", # Time this unsampled report was last modified. 167 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 168 "documentId": "A String", # Id of the document/file containing the report data. 169 }, 170 "metrics": "A String", # The metrics for the unsampled report. 171 "title": "A String", # Title of the unsampled report. 172 "filters": "A String", # The filters for the unsampled report. 173 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 174 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 175 "end-date": "A String", # The end date for the unsampled report. 176 "id": "A String", # Unsampled report ID. 177 "selfLink": "A String", # Link for this unsampled report. 178 "accountId": "A String", # Account ID to which this unsampled report belongs. 179 } 180 181 182 Returns: 183 An object of the form: 184 185 { # JSON template for Analytics unsampled report resource. 186 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 187 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 188 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 189 "bucketId": "A String", # Id of the bucket the file object is stored in. 190 "objectId": "A String", # Id of the file object containing the report data. 191 }, 192 "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. 193 "dimensions": "A String", # The dimensions for the unsampled report. 194 "created": "A String", # Time this unsampled report was created. 195 "segment": "A String", # The segment for the unsampled report. 196 "start-date": "A String", # The start date for the unsampled report. 197 "updated": "A String", # Time this unsampled report was last modified. 198 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 199 "documentId": "A String", # Id of the document/file containing the report data. 200 }, 201 "metrics": "A String", # The metrics for the unsampled report. 202 "title": "A String", # Title of the unsampled report. 203 "filters": "A String", # The filters for the unsampled report. 204 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 205 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 206 "end-date": "A String", # The end date for the unsampled report. 207 "id": "A String", # Unsampled report ID. 208 "selfLink": "A String", # Link for this unsampled report. 209 "accountId": "A String", # Account ID to which this unsampled report belongs. 210 }</pre> 211 </div> 212 213 <div class="method"> 214 <code class="details" id="list">list(accountId, webPropertyId, profileId, max_results=None, start_index=None)</code> 215 <pre>Lists unsampled reports to which the user has access. 216 217 Args: 218 accountId: string, Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. (required) 219 webPropertyId: string, Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. (required) 220 profileId: string, View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. (required) 221 max_results: integer, The maximum number of unsampled reports to include in this response. 222 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. 223 224 Returns: 225 An object of the form: 226 227 { # 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. 228 "username": "A String", # Email ID of the authenticated user 229 "kind": "analytics#unsampledReports", # Collection type. 230 "items": [ # A list of unsampled reports. 231 { # JSON template for Analytics unsampled report resource. 232 "status": "A String", # Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. 233 "kind": "analytics#unsampledReport", # Resource type for an Analytics unsampled report. 234 "cloudStorageDownloadDetails": { # Download details for a file stored in Google Cloud Storage. 235 "bucketId": "A String", # Id of the bucket the file object is stored in. 236 "objectId": "A String", # Id of the file object containing the report data. 237 }, 238 "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. 239 "dimensions": "A String", # The dimensions for the unsampled report. 240 "created": "A String", # Time this unsampled report was created. 241 "segment": "A String", # The segment for the unsampled report. 242 "start-date": "A String", # The start date for the unsampled report. 243 "updated": "A String", # Time this unsampled report was last modified. 244 "driveDownloadDetails": { # Download details for a file stored in Google Drive. 245 "documentId": "A String", # Id of the document/file containing the report data. 246 }, 247 "metrics": "A String", # The metrics for the unsampled report. 248 "title": "A String", # Title of the unsampled report. 249 "filters": "A String", # The filters for the unsampled report. 250 "webPropertyId": "A String", # Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. 251 "profileId": "A String", # View (Profile) ID to which this unsampled report belongs. 252 "end-date": "A String", # The end date for the unsampled report. 253 "id": "A String", # Unsampled report ID. 254 "selfLink": "A String", # Link for this unsampled report. 255 "accountId": "A String", # Account ID to which this unsampled report belongs. 256 }, 257 ], 258 "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. 259 "previousLink": "A String", # Link to previous page for this unsampled report collection. 260 "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. 261 "nextLink": "A String", # Link to next page for this unsampled report collection. 262 "totalResults": 42, # The total number of results for the query, regardless of the number of resources in the result. 263 }</pre> 264 </div> 265 266 </body></html>
