Constructor
new CustomDimension(propertiesopt)
Constructs a new CustomDimension.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.analytics.admin.v1alpha.ICustomDimension |
<optional> |
Properties to set |
- Implements:
-
- ICustomDimension
Members
DimensionScope
DimensionScope enum.
Properties:
| Name | Type | Description |
|---|---|---|
DIMENSION_SCOPE_UNSPECIFIED |
number |
DIMENSION_SCOPE_UNSPECIFIED value |
EVENT |
number |
EVENT value |
USER |
number |
USER value |
description
CustomDimension description.
disallowAdsPersonalization
CustomDimension disallowAdsPersonalization.
displayName
CustomDimension displayName.
name
CustomDimension name.
parameterName
CustomDimension parameterName.
scope
CustomDimension scope.
Methods
(static) create(propertiesopt) → {google.analytics.admin.v1alpha.CustomDimension}
Creates a new CustomDimension instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.analytics.admin.v1alpha.ICustomDimension |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CustomDimension |
CustomDimension instance |
(static) decode(reader, lengthopt) → {google.analytics.admin.v1alpha.CustomDimension}
Decodes a CustomDimension message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CustomDimension |
CustomDimension |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.analytics.admin.v1alpha.CustomDimension}
Decodes a CustomDimension message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CustomDimension |
CustomDimension |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified CustomDimension message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.admin.v1alpha.ICustomDimension |
CustomDimension message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified CustomDimension message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.admin.v1alpha.ICustomDimension |
CustomDimension message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.analytics.admin.v1alpha.CustomDimension}
Creates a CustomDimension message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.analytics.admin.v1alpha.CustomDimension |
CustomDimension |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a CustomDimension message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.analytics.admin.v1alpha.CustomDimension |
CustomDimension |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a CustomDimension message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|
toJSON() → {Object.<string, *>}
Converts this CustomDimension to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |