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