Represents a DimensionMetadata.
Package
@google-analytics/dataConstructors
(constructor)(properties)
constructor(properties?: google.analytics.data.v1beta.IDimensionMetadata);Constructs a new DimensionMetadata.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDimensionMetadata
Properties to set |
Properties
apiName
public apiName: string;DimensionMetadata apiName.
category
public category: string;DimensionMetadata category.
customDefinition
public customDefinition: boolean;DimensionMetadata customDefinition.
deprecatedApiNames
public deprecatedApiNames: string[];DimensionMetadata deprecatedApiNames.
description
public description: string;DimensionMetadata description.
uiName
public uiName: string;DimensionMetadata uiName.
Methods
create(properties)
public static create(properties?: google.analytics.data.v1beta.IDimensionMetadata): google.analytics.data.v1beta.DimensionMetadata;Creates a new DimensionMetadata instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDimensionMetadata
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
DimensionMetadata instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1beta.DimensionMetadata;Decodes a DimensionMetadata message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
DimensionMetadata |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1beta.DimensionMetadata;Decodes a DimensionMetadata message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
DimensionMetadata |
encode(message, writer)
public static encode(message: google.analytics.data.v1beta.IDimensionMetadata, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DimensionMetadata message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDimensionMetadata
DimensionMetadata message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.analytics.data.v1beta.IDimensionMetadata, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DimensionMetadata message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDimensionMetadata
DimensionMetadata message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.analytics.data.v1beta.DimensionMetadata;Creates a DimensionMetadata message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
DimensionMetadata |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DimensionMetadata
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this DimensionMetadata to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.analytics.data.v1beta.DimensionMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DimensionMetadata message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DimensionMetadata
DimensionMetadata |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a DimensionMetadata message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|