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