Represents a FunnelBreakdown.
Package
@google-analytics/dataConstructors
(constructor)(properties)
constructor(properties?: google.analytics.data.v1alpha.IFunnelBreakdown);
Constructs a new FunnelBreakdown.
Parameter | |
---|---|
Name | Description |
properties |
IFunnelBreakdown
Properties to set |
Properties
_limit
public _limit?: "limit";
FunnelBreakdown _limit.
breakdownDimension
public breakdownDimension?: (google.analytics.data.v1alpha.IDimension|null);
FunnelBreakdown breakdownDimension.
limit
public limit?: (number|Long|string|null);
FunnelBreakdown limit.
Methods
create(properties)
public static create(properties?: google.analytics.data.v1alpha.IFunnelBreakdown): google.analytics.data.v1alpha.FunnelBreakdown;
Creates a new FunnelBreakdown instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IFunnelBreakdown
Properties to set |
Returns | |
---|---|
Type | Description |
FunnelBreakdown |
FunnelBreakdown instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1alpha.FunnelBreakdown;
Decodes a FunnelBreakdown 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 |
FunnelBreakdown |
FunnelBreakdown |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1alpha.FunnelBreakdown;
Decodes a FunnelBreakdown message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
FunnelBreakdown |
FunnelBreakdown |
encode(message, writer)
public static encode(message: google.analytics.data.v1alpha.IFunnelBreakdown, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified FunnelBreakdown message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IFunnelBreakdown
FunnelBreakdown 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.v1alpha.IFunnelBreakdown, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified FunnelBreakdown message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IFunnelBreakdown
FunnelBreakdown 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.v1alpha.FunnelBreakdown;
Creates a FunnelBreakdown 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 |
FunnelBreakdown |
FunnelBreakdown |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for FunnelBreakdown
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 FunnelBreakdown to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.analytics.data.v1alpha.FunnelBreakdown, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a FunnelBreakdown message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
FunnelBreakdown
FunnelBreakdown |
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 FunnelBreakdown message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|