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