John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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.dailyUploads.html">dailyUploads</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#delete">delete(accountId, webPropertyId, customDataSourceId, date, type)</a></code></p> |
| 79 | <p class="firstline">Delete uploaded data for the given date.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#list">list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)</a></code></p> |
| 82 | <p class="firstline">List daily uploads to which the user has access.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#upload">upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)</a></code></p> |
| 85 | <p class="firstline">Update/Overwrite data for a custom data source.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="delete">delete(accountId, webPropertyId, customDataSourceId, date, type)</code> |
| 89 | <pre>Delete uploaded data for the given date. |
| 90 | |
| 91 | Args: |
| 92 | accountId: string, Account Id associated with daily upload delete. (required) |
| 93 | webPropertyId: string, Web property Id associated with daily upload delete. (required) |
| 94 | customDataSourceId: string, Custom data source Id associated with daily upload delete. (required) |
| 95 | date: string, Date for which data is to be deleted. Date should be formatted as YYYY-MM-DD. (required) |
| 96 | type: string, Type of data for this delete. (required) |
| 97 | Allowed values |
| 98 | cost - Value for specifying cost data upload. |
| 99 | </pre> |
| 100 | </div> |
| 101 | |
| 102 | <div class="method"> |
| 103 | <code class="details" id="list">list(accountId, webPropertyId, customDataSourceId, start_date, end_date, max_results=None, start_index=None)</code> |
| 104 | <pre>List daily uploads to which the user has access. |
| 105 | |
| 106 | Args: |
| 107 | accountId: string, Account Id for the daily uploads to retrieve. (required) |
| 108 | webPropertyId: string, Web property Id for the daily uploads to retrieve. (required) |
| 109 | customDataSourceId: string, Custom data source Id for daily uploads to retrieve. (required) |
| 110 | start_date: string, Start date of the form YYYY-MM-DD. (required) |
| 111 | end_date: string, End date of the form YYYY-MM-DD. (required) |
| 112 | max_results: integer, The maximum number of custom data sources to include in this response. |
| 113 | start_index: integer, A 1-based index of the first daily upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| 114 | |
| 115 | Returns: |
| 116 | An object of the form: |
| 117 | |
| 118 | { # A daily upload collection lists Analytics daily uploads to which the user has access. Each resource in the collection corresponds to a single Analytics daily upload. |
| 119 | "username": "A String", # Email ID of the authenticated user |
| 120 | "kind": "analytics#dailyUploads", # Collection type. Value is analytics#dailyUploads. |
| 121 | "items": [ # A collection of daily uploads. |
| 122 | { # Metadata for daily upload entity. |
| 123 | "recentChanges": [ # Change log for last 10 changes in chronological order. |
| 124 | { |
| 125 | "change": "A String", # The type of change: APPEND, RESET, or DELETE. |
| 126 | "time": "A String", # The time when the change occurred. |
| 127 | }, |
| 128 | ], |
| 129 | "kind": "analytics#dailyUpload", # Resource type for Analytics daily upload. |
| 130 | "modifiedTime": "A String", # Time this daily upload was last modified. |
| 131 | "appendCount": 42, # Number of appends for this date. |
| 132 | "customDataSourceId": "A String", # Custom data source ID to which this daily upload belongs. |
| 133 | "date": "A String", # Date associated with daily upload. |
| 134 | "webPropertyId": "A String", # Web property ID of the form UA-XXXXX-YY to which this daily upload belongs. |
| 135 | "createdTime": "A String", # Time this daily upload was created. |
| 136 | "parentLink": { # Parent link for a daily upload. Points to the custom data source to which this daily upload belongs. |
| 137 | "href": "A String", # Link to the custom data source to which this daily upload belongs. |
| 138 | "type": "analytics#customDataSource", # Value is "analytics#customDataSource". |
| 139 | }, |
| 140 | "selfLink": "A String", # Link for this daily upload. |
| 141 | "accountId": "A String", # Account ID to which this daily upload belongs. |
| 142 | }, |
| 143 | ], |
| 144 | "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. |
| 145 | "previousLink": "A String", # Link to previous page for this daily upload collection. |
| 146 | "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| 147 | "nextLink": "A String", # Link to next page for this daily upload collection. |
| 148 | "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| 149 | }</pre> |
| 150 | </div> |
| 151 | |
| 152 | <div class="method"> |
| 153 | <code class="details" id="upload">upload(accountId, webPropertyId, customDataSourceId, date, appendNumber, type, reset=None, media_body=None)</code> |
| 154 | <pre>Update/Overwrite data for a custom data source. |
| 155 | |
| 156 | Args: |
| 157 | accountId: string, Account Id associated with daily upload. (required) |
| 158 | webPropertyId: string, Web property Id associated with daily upload. (required) |
| 159 | customDataSourceId: string, Custom data source Id to which the data being uploaded belongs. (required) |
| 160 | date: string, Date for which data is uploaded. Date should be formatted as YYYY-MM-DD. (required) |
| 161 | appendNumber: integer, Append number for this upload indexed from 1. (required) |
| 162 | type: string, Type of data for this upload. (required) |
| 163 | Allowed values |
| 164 | cost - Value for specifying cost data upload. |
| 165 | reset: boolean, Reset/Overwrite all previous appends for this date and start over with this file as the first upload. |
| 166 | media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| 167 | |
| 168 | Returns: |
| 169 | An object of the form: |
| 170 | |
| 171 | { # Metadata returned for a successful append operation. |
| 172 | "kind": "analytics#dailyUploadAppend", # Resource type for Analytics daily upload append. |
| 173 | "customDataSourceId": "A String", # Custom data source Id to which this daily upload append belongs. |
| 174 | "appendNumber": 42, # Append number. |
| 175 | "webPropertyId": "A String", # Web property Id of the form UA-XXXXX-YY to which this daily upload append belongs. |
| 176 | "date": "A String", # Date associated with daily upload append. |
| 177 | "nextAppendLink": "A String", |
| 178 | "accountId": "A String", # Account Id to which this daily upload append belongs. |
| 179 | }</pre> |
| 180 | </div> |
| 181 | |
| 182 | </body></html> |