Method: properties.customDimensions.get
Lookup for a single CustomDimension.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customDimensions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of CustomDimension
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["This page details how to use the Google Analytics Admin API to look up a single custom dimension."],["Requests must use the `GET` method and provide the `name` of the custom dimension in the URL path."],["No request body is needed, and a successful response returns a `CustomDimension` object."],["Authorization is required with either `analytics.readonly` or `analytics.edit` scopes."]]],["To retrieve a CustomDimension, use a `GET` request to the specified URL, including the dimension's `name` in the path. The `name` parameter is required and follows the format `properties/*/customDimensions/*`. The request body should be empty. A successful response returns a `CustomDimension` instance. This action requires authorization via either the `analytics.readonly` or `analytics.edit` OAuth scopes. The URL format uses gRPC Transcoding syntax.\n"]]