Represents a RunReportRequest.
Package
@google-analytics/dataConstructors
(constructor)(properties)
constructor(properties?: google.analytics.data.v1beta.IRunReportRequest);Constructs a new RunReportRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRunReportRequest
Properties to set |
Properties
cohortSpec
public cohortSpec?: (google.analytics.data.v1beta.ICohortSpec|null);RunReportRequest cohortSpec.
currencyCode
public currencyCode: string;RunReportRequest currencyCode.
dateRanges
public dateRanges: google.analytics.data.v1beta.IDateRange[];RunReportRequest dateRanges.
dimensionFilter
public dimensionFilter?: (google.analytics.data.v1beta.IFilterExpression|null);RunReportRequest dimensionFilter.
dimensions
public dimensions: google.analytics.data.v1beta.IDimension[];RunReportRequest dimensions.
keepEmptyRows
public keepEmptyRows: boolean;RunReportRequest keepEmptyRows.
limit
public limit: (number|Long|string);RunReportRequest limit.
metricAggregations
public metricAggregations: google.analytics.data.v1beta.MetricAggregation[];RunReportRequest metricAggregations.
metricFilter
public metricFilter?: (google.analytics.data.v1beta.IFilterExpression|null);RunReportRequest metricFilter.
metrics
public metrics: google.analytics.data.v1beta.IMetric[];RunReportRequest metrics.
offset
public offset: (number|Long|string);RunReportRequest offset.
orderBys
public orderBys: google.analytics.data.v1beta.IOrderBy[];RunReportRequest orderBys.
property
public property: string;RunReportRequest property.
returnPropertyQuota
public returnPropertyQuota: boolean;RunReportRequest returnPropertyQuota.
Methods
create(properties)
public static create(properties?: google.analytics.data.v1beta.IRunReportRequest): google.analytics.data.v1beta.RunReportRequest;Creates a new RunReportRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRunReportRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RunReportRequest |
RunReportRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1beta.RunReportRequest;Decodes a RunReportRequest 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 |
RunReportRequest |
RunReportRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1beta.RunReportRequest;Decodes a RunReportRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RunReportRequest |
RunReportRequest |
encode(message, writer)
public static encode(message: google.analytics.data.v1beta.IRunReportRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RunReportRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRunReportRequest
RunReportRequest 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.IRunReportRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RunReportRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRunReportRequest
RunReportRequest 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.RunReportRequest;Creates a RunReportRequest 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 |
RunReportRequest |
RunReportRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RunReportRequest
| 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 RunReportRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.analytics.data.v1beta.RunReportRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RunReportRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RunReportRequest
RunReportRequest |
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 RunReportRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|