| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [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.customDimensions.html">customDimensions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 81 | <code><a href="#get">get(accountId, webPropertyId, customDimensionId)</a></code></p> |
| 82 | <p class="firstline">Get a custom dimension to which the user has access.</p> |
| 83 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 84 | <code><a href="#insert">insert(accountId, webPropertyId, body=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 85 | <p class="firstline">Create a new custom dimension.</p> |
| 86 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 87 | <code><a href="#list">list(accountId, webPropertyId, max_results=None, start_index=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 88 | <p class="firstline">Lists custom dimensions to which the user has access.</p> |
| 89 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 91 | <p class="firstline">Updates an existing custom dimension. This method supports patch semantics.</p> |
| 92 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 93 | <code><a href="#update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</a></code></p> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 94 | <p class="firstline">Updates an existing custom dimension.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 97 | <code class="details" id="close">close()</code> |
| 98 | <pre>Close httplib2 connections.</pre> |
| 99 | </div> |
| 100 | |
| 101 | <div class="method"> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 102 | <code class="details" id="get">get(accountId, webPropertyId, customDimensionId)</code> |
| 103 | <pre>Get a custom dimension to which the user has access. |
| 104 | |
| 105 | Args: |
| 106 | accountId: string, Account ID for the custom dimension to retrieve. (required) |
| 107 | webPropertyId: string, Web property ID for the custom dimension to retrieve. (required) |
| 108 | customDimensionId: string, The ID of the custom dimension to retrieve. (required) |
| 109 | |
| 110 | Returns: |
| 111 | An object of the form: |
| 112 | |
| 113 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 114 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 115 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 116 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 117 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 118 | }, |
| 119 | "name": "A String", # Name of the custom dimension. |
| 120 | "webPropertyId": "A String", # Property ID. |
| 121 | "id": "A String", # Custom dimension ID. |
| 122 | "accountId": "A String", # Account ID. |
| 123 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 124 | "selfLink": "A String", # Link for the custom dimension |
| 125 | "index": 42, # Index of the custom dimension. |
| 126 | "created": "A String", # Time the custom dimension was created. |
| 127 | "updated": "A String", # Time the custom dimension was last modified. |
| 128 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 129 | }</pre> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 130 | </div> |
| 131 | |
| 132 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 133 | <code class="details" id="insert">insert(accountId, webPropertyId, body=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 134 | <pre>Create a new custom dimension. |
| 135 | |
| 136 | Args: |
| 137 | accountId: string, Account ID for the custom dimension to create. (required) |
| 138 | webPropertyId: string, Web property ID for the custom dimension to create. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 139 | body: object, The request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 140 | The object takes the form of: |
| 141 | |
| 142 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 143 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 144 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 145 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 146 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 147 | }, |
| 148 | "name": "A String", # Name of the custom dimension. |
| 149 | "webPropertyId": "A String", # Property ID. |
| 150 | "id": "A String", # Custom dimension ID. |
| 151 | "accountId": "A String", # Account ID. |
| 152 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 153 | "selfLink": "A String", # Link for the custom dimension |
| 154 | "index": 42, # Index of the custom dimension. |
| 155 | "created": "A String", # Time the custom dimension was created. |
| 156 | "updated": "A String", # Time the custom dimension was last modified. |
| 157 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 158 | } |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 159 | |
| 160 | |
| 161 | Returns: |
| 162 | An object of the form: |
| 163 | |
| 164 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 165 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 166 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 167 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 168 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 169 | }, |
| 170 | "name": "A String", # Name of the custom dimension. |
| 171 | "webPropertyId": "A String", # Property ID. |
| 172 | "id": "A String", # Custom dimension ID. |
| 173 | "accountId": "A String", # Account ID. |
| 174 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 175 | "selfLink": "A String", # Link for the custom dimension |
| 176 | "index": 42, # Index of the custom dimension. |
| 177 | "created": "A String", # Time the custom dimension was created. |
| 178 | "updated": "A String", # Time the custom dimension was last modified. |
| 179 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 180 | }</pre> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 181 | </div> |
| 182 | |
| 183 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 184 | <code class="details" id="list">list(accountId, webPropertyId, max_results=None, start_index=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 185 | <pre>Lists custom dimensions to which the user has access. |
| 186 | |
| 187 | Args: |
| 188 | accountId: string, Account ID for the custom dimensions to retrieve. (required) |
| 189 | webPropertyId: string, Web property ID for the custom dimensions to retrieve. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 190 | max_results: integer, The maximum number of custom dimensions to include in this response. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 191 | start_index: integer, An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 192 | |
| 193 | Returns: |
| 194 | An object of the form: |
| 195 | |
| 196 | { # A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 197 | "items": [ # Collection of custom dimensions. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 198 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 199 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 200 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 201 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 202 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 203 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 204 | "name": "A String", # Name of the custom dimension. |
| 205 | "webPropertyId": "A String", # Property ID. |
| 206 | "id": "A String", # Custom dimension ID. |
| 207 | "accountId": "A String", # Account ID. |
| 208 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 209 | "selfLink": "A String", # Link for the custom dimension |
| 210 | "index": 42, # Index of the custom dimension. |
| 211 | "created": "A String", # Time the custom dimension was created. |
| 212 | "updated": "A String", # Time the custom dimension was last modified. |
| 213 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 214 | }, |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 215 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 216 | "totalResults": 42, # The total number of results for the query, regardless of the number of results in the response. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 217 | "startIndex": 42, # The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 218 | "previousLink": "A String", # Link to previous page for this custom dimension collection. |
| 219 | "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. |
| 220 | "username": "A String", # Email ID of the authenticated user |
| 221 | "nextLink": "A String", # Link to next page for this custom dimension collection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 222 | "kind": "analytics#customDimensions", # Collection type. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 223 | }</pre> |
| 224 | </div> |
| 225 | |
| 226 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 227 | <code class="details" id="patch">patch(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 228 | <pre>Updates an existing custom dimension. This method supports patch semantics. |
| 229 | |
| 230 | Args: |
| 231 | accountId: string, Account ID for the custom dimension to update. (required) |
| 232 | webPropertyId: string, Web property ID for the custom dimension to update. (required) |
| 233 | customDimensionId: string, Custom dimension ID for the custom dimension to update. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 234 | body: object, The request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 235 | The object takes the form of: |
| 236 | |
| 237 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 238 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 239 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 240 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 241 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 242 | }, |
| 243 | "name": "A String", # Name of the custom dimension. |
| 244 | "webPropertyId": "A String", # Property ID. |
| 245 | "id": "A String", # Custom dimension ID. |
| 246 | "accountId": "A String", # Account ID. |
| 247 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 248 | "selfLink": "A String", # Link for the custom dimension |
| 249 | "index": 42, # Index of the custom dimension. |
| 250 | "created": "A String", # Time the custom dimension was created. |
| 251 | "updated": "A String", # Time the custom dimension was last modified. |
| 252 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 253 | } |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 254 | |
| 255 | ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. |
| 256 | |
| 257 | Returns: |
| 258 | An object of the form: |
| 259 | |
| 260 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 261 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 262 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 263 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 264 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 265 | }, |
| 266 | "name": "A String", # Name of the custom dimension. |
| 267 | "webPropertyId": "A String", # Property ID. |
| 268 | "id": "A String", # Custom dimension ID. |
| 269 | "accountId": "A String", # Account ID. |
| 270 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 271 | "selfLink": "A String", # Link for the custom dimension |
| 272 | "index": 42, # Index of the custom dimension. |
| 273 | "created": "A String", # Time the custom dimension was created. |
| 274 | "updated": "A String", # Time the custom dimension was last modified. |
| 275 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 276 | }</pre> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 277 | </div> |
| 278 | |
| 279 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 280 | <code class="details" id="update">update(accountId, webPropertyId, customDimensionId, body=None, ignoreCustomDataSourceLinks=None)</code> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 281 | <pre>Updates an existing custom dimension. |
| 282 | |
| 283 | Args: |
| 284 | accountId: string, Account ID for the custom dimension to update. (required) |
| 285 | webPropertyId: string, Web property ID for the custom dimension to update. (required) |
| 286 | customDimensionId: string, Custom dimension ID for the custom dimension to update. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 287 | body: object, The request body. |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 288 | The object takes the form of: |
| 289 | |
| 290 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 291 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 292 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 293 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 294 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 295 | }, |
| 296 | "name": "A String", # Name of the custom dimension. |
| 297 | "webPropertyId": "A String", # Property ID. |
| 298 | "id": "A String", # Custom dimension ID. |
| 299 | "accountId": "A String", # Account ID. |
| 300 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 301 | "selfLink": "A String", # Link for the custom dimension |
| 302 | "index": 42, # Index of the custom dimension. |
| 303 | "created": "A String", # Time the custom dimension was created. |
| 304 | "updated": "A String", # Time the custom dimension was last modified. |
| 305 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 306 | } |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 307 | |
| 308 | ignoreCustomDataSourceLinks: boolean, Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. |
| 309 | |
| 310 | Returns: |
| 311 | An object of the form: |
| 312 | |
| 313 | { # JSON template for Analytics Custom Dimension. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 314 | "scope": "A String", # Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. |
| 315 | "parentLink": { # Parent link for the custom dimension. Points to the property to which the custom dimension belongs. |
| 316 | "href": "A String", # Link to the property to which the custom dimension belongs. |
| 317 | "type": "analytics#webproperty", # Type of the parent link. Set to "analytics#webproperty". |
| 318 | }, |
| 319 | "name": "A String", # Name of the custom dimension. |
| 320 | "webPropertyId": "A String", # Property ID. |
| 321 | "id": "A String", # Custom dimension ID. |
| 322 | "accountId": "A String", # Account ID. |
| 323 | "active": True or False, # Boolean indicating whether the custom dimension is active. |
| 324 | "selfLink": "A String", # Link for the custom dimension |
| 325 | "index": 42, # Index of the custom dimension. |
| 326 | "created": "A String", # Time the custom dimension was created. |
| 327 | "updated": "A String", # Time the custom dimension was last modified. |
| 328 | "kind": "analytics#customDimension", # Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. |
| 329 | }</pre> |
| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 330 | </div> |
| 331 | |
| 332 | </body></html> |