Class protos.google.analytics.admin.v1alpha.RunAccessReportRequest (7.3.0)

Represents a RunAccessReportRequest.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1alpha.IRunAccessReportRequest);

Constructs a new RunAccessReportRequest.

Parameter
Name Description
properties IRunAccessReportRequest

Properties to set

Properties

dateRanges

public dateRanges: google.analytics.admin.v1alpha.IAccessDateRange[];

RunAccessReportRequest dateRanges.

dimensionFilter

public dimensionFilter?: (google.analytics.admin.v1alpha.IAccessFilterExpression|null);

RunAccessReportRequest dimensionFilter.

dimensions

public dimensions: google.analytics.admin.v1alpha.IAccessDimension[];

RunAccessReportRequest dimensions.

entity

public entity: string;

RunAccessReportRequest entity.

expandGroups

public expandGroups: boolean;

RunAccessReportRequest expandGroups.

includeAllUsers

public includeAllUsers: boolean;

RunAccessReportRequest includeAllUsers.

limit

public limit: (number|Long|string);

RunAccessReportRequest limit.

metricFilter

public metricFilter?: (google.analytics.admin.v1alpha.IAccessFilterExpression|null);

RunAccessReportRequest metricFilter.

metrics

public metrics: google.analytics.admin.v1alpha.IAccessMetric[];

RunAccessReportRequest metrics.

offset

public offset: (number|Long|string);

RunAccessReportRequest offset.

orderBys

public orderBys: google.analytics.admin.v1alpha.IAccessOrderBy[];

RunAccessReportRequest orderBys.

returnEntityQuota

public returnEntityQuota: boolean;

RunAccessReportRequest returnEntityQuota.

timeZone

public timeZone: string;

RunAccessReportRequest timeZone.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1alpha.IRunAccessReportRequest): google.analytics.admin.v1alpha.RunAccessReportRequest;

Creates a new RunAccessReportRequest instance using the specified properties.

Parameter
Name Description
properties IRunAccessReportRequest

Properties to set

Returns
Type Description
RunAccessReportRequest

RunAccessReportRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1alpha.RunAccessReportRequest;

Decodes a RunAccessReportRequest 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
RunAccessReportRequest

RunAccessReportRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1alpha.RunAccessReportRequest;

Decodes a RunAccessReportRequest message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RunAccessReportRequest

RunAccessReportRequest

encode(message, writer)

public static encode(message: google.analytics.admin.v1alpha.IRunAccessReportRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RunAccessReportRequest message. Does not implicitly messages.

Parameters
Name Description
message IRunAccessReportRequest

RunAccessReportRequest 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.admin.v1alpha.IRunAccessReportRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RunAccessReportRequest message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IRunAccessReportRequest

RunAccessReportRequest 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.admin.v1alpha.RunAccessReportRequest;

Creates a RunAccessReportRequest 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
RunAccessReportRequest

RunAccessReportRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for RunAccessReportRequest

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 RunAccessReportRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.analytics.admin.v1alpha.RunAccessReportRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a RunAccessReportRequest message. Also converts values to other types if specified.

Parameters
Name Description
message RunAccessReportRequest

RunAccessReportRequest

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 RunAccessReportRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not