| 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="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.customDimensions.html">customDimensions</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#archive">archive(name, body=None, x__xgafv=None)</a></code></p> |
| 79 |
<p class="firstline">Archives a CustomDimension on a property.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#close">close()</a></code></p> |
| 82 |
<p class="firstline">Close httplib2 connections.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Creates a CustomDimension.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Lookup for a single CustomDimension.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">Lists CustomDimensions on a property.</p> |
| 92 |
<p class="toc_element"> |
| 93 |
<code><a href="#list_next">list_next()</a></code></p> |
| 94 |
<p class="firstline">Retrieves the next page of results.</p> |
| 95 |
<p class="toc_element"> |
| 96 |
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 97 |
<p class="firstline">Updates a CustomDimension on a property.</p> |
| 98 |
<h3>Method Details</h3> |
| 99 |
<div class="method"> |
| 100 |
<code class="details" id="archive">archive(name, body=None, x__xgafv=None)</code> |
| 101 |
<pre>Archives a CustomDimension on a property. |
| 102 |
|
| 103 |
Args: |
| 104 |
name: string, Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 (required) |
| 105 |
body: object, The request body. |
| 106 |
The object takes the form of: |
| 107 |
|
| 108 |
{ # Request message for ArchiveCustomDimension RPC. |
| 109 |
} |
| 110 |
|
| 111 |
x__xgafv: string, V1 error format. |
| 112 |
Allowed values |
| 113 |
1 - v1 error format |
| 114 |
2 - v2 error format |
| 115 |
|
| 116 |
Returns: |
| 117 |
An object of the form: |
| 118 |
|
| 119 |
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| 120 |
}</pre> |
| 121 |
</div> |
| 122 |
|
| 123 |
<div class="method"> |
| 124 |
<code class="details" id="close">close()</code> |
| 125 |
<pre>Close httplib2 connections.</pre> |
| 126 |
</div> |
| 127 |
|
| 128 |
<div class="method"> |
| 129 |
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 130 |
<pre>Creates a CustomDimension. |
| 131 |
|
| 132 |
Args: |
| 133 |
parent: string, Required. Example format: properties/1234 (required) |
| 134 |
body: object, The request body. |
| 135 |
The object takes the form of: |
| 136 |
|
| 137 |
{ # A definition for a CustomDimension. |
| 138 |
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. |
| 139 |
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. |
| 140 |
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |
| 141 |
"name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| 142 |
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. |
| 143 |
"scope": "A String", # Required. Immutable. The scope of this dimension. |
| 144 |
} |
| 145 |
|
| 146 |
x__xgafv: string, V1 error format. |
| 147 |
Allowed values |
| 148 |
1 - v1 error format |
| 149 |
2 - v2 error format |
| 150 |
|
| 151 |
Returns: |
| 152 |
An object of the form: |
| 153 |
|
| 154 |
{ # A definition for a CustomDimension. |
| 155 |
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. |
| 156 |
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. |
| 157 |
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |
| 158 |
"name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| 159 |
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. |
| 160 |
"scope": "A String", # Required. Immutable. The scope of this dimension. |
| 161 |
}</pre> |
| 162 |
</div> |
| 163 |
|
| 164 |
<div class="method"> |
| 165 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 166 |
<pre>Lookup for a single CustomDimension. |
| 167 |
|
| 168 |
Args: |
| 169 |
name: string, Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 (required) |
| 170 |
x__xgafv: string, V1 error format. |
| 171 |
Allowed values |
| 172 |
1 - v1 error format |
| 173 |
2 - v2 error format |
| 174 |
|
| 175 |
Returns: |
| 176 |
An object of the form: |
| 177 |
|
| 178 |
{ # A definition for a CustomDimension. |
| 179 |
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. |
| 180 |
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. |
| 181 |
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |
| 182 |
"name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| 183 |
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. |
| 184 |
"scope": "A String", # Required. Immutable. The scope of this dimension. |
| 185 |
}</pre> |
| 186 |
</div> |
| 187 |
|
| 188 |
<div class="method"> |
| 189 |
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 190 |
<pre>Lists CustomDimensions on a property. |
| 191 |
|
| 192 |
Args: |
| 193 |
parent: string, Required. Example format: properties/1234 (required) |
| 194 |
pageSize: integer, Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). |
| 195 |
pageToken: string, Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. |
| 196 |
x__xgafv: string, V1 error format. |
| 197 |
Allowed values |
| 198 |
1 - v1 error format |
| 199 |
2 - v2 error format |
| 200 |
|
| 201 |
Returns: |
| 202 |
An object of the form: |
| 203 |
|
| 204 |
{ # Response message for ListCustomDimensions RPC. |
| 205 |
"customDimensions": [ # List of CustomDimensions. |
| 206 |
{ # A definition for a CustomDimension. |
| 207 |
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. |
| 208 |
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. |
| 209 |
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |
| 210 |
"name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| 211 |
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. |
| 212 |
"scope": "A String", # Required. Immutable. The scope of this dimension. |
| 213 |
}, |
| 214 |
], |
| 215 |
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| 216 |
}</pre> |
| 217 |
</div> |
| 218 |
|
| 219 |
<div class="method"> |
| 220 |
<code class="details" id="list_next">list_next()</code> |
| 221 |
<pre>Retrieves the next page of results. |
| 222 |
|
| 223 |
Args: |
| 224 |
previous_request: The request for the previous page. (required) |
| 225 |
previous_response: The response from the request for the previous page. (required) |
| 226 |
|
| 227 |
Returns: |
| 228 |
A request object that you can call 'execute()' on to request the next |
| 229 |
page. Returns None if there are no more items in the collection. |
| 230 |
</pre> |
| 231 |
</div> |
| 232 |
|
| 233 |
<div class="method"> |
| 234 |
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 235 |
<pre>Updates a CustomDimension on a property. |
| 236 |
|
| 237 |
Args: |
| 238 |
name: string, Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} (required) |
| 239 |
body: object, The request body. |
| 240 |
The object takes the form of: |
| 241 |
|
| 242 |
{ # A definition for a CustomDimension. |
| 243 |
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. |
| 244 |
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. |
| 245 |
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |
| 246 |
"name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| 247 |
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. |
| 248 |
"scope": "A String", # Required. Immutable. The scope of this dimension. |
| 249 |
} |
| 250 |
|
| 251 |
updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. |
| 252 |
x__xgafv: string, V1 error format. |
| 253 |
Allowed values |
| 254 |
1 - v1 error format |
| 255 |
2 - v2 error format |
| 256 |
|
| 257 |
Returns: |
| 258 |
An object of the form: |
| 259 |
|
| 260 |
{ # A definition for a CustomDimension. |
| 261 |
"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters. |
| 262 |
"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions. |
| 263 |
"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |
| 264 |
"name": "A String", # Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |
| 265 |
"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. |
| 266 |
"scope": "A String", # Required. Immutable. The scope of this dimension. |
| 267 |
}</pre> |
| 268 |
</div> |
| 269 |
|
| 270 |
</body></html> |