Class protos.google.analytics.data.v1beta.BetaAnalyticsData (4.12.0)

Represents a BetaAnalyticsData

Inheritance

$protobuf.rpc.Service > protos.google.analytics.data.v1beta.BetaAnalyticsData

Package

@google-analytics/data

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new BetaAnalyticsData service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchRunPivotReports(request, callback)

public batchRunPivotReports(request: google.analytics.data.v1beta.IBatchRunPivotReportsRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.BatchRunPivotReportsCallback): void;

Calls BatchRunPivotReports.

Parameters
Name Description
request IBatchRunPivotReportsRequest

BatchRunPivotReportsRequest message or plain object
callback BatchRunPivotReportsCallback

Node-style callback called with the error, if any, and BatchRunPivotReportsResponse
Returns
Type Description
void

batchRunPivotReports(request)

public batchRunPivotReports(request: google.analytics.data.v1beta.IBatchRunPivotReportsRequest): Promise<google.analytics.data.v1beta.BatchRunPivotReportsResponse>;

Calls BatchRunPivotReports.

Parameter
Name Description
request IBatchRunPivotReportsRequest

BatchRunPivotReportsRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.BatchRunPivotReportsResponse>

Promise

batchRunReports(request, callback)

public batchRunReports(request: google.analytics.data.v1beta.IBatchRunReportsRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.BatchRunReportsCallback): void;

Calls BatchRunReports.

Parameters
Name Description
request IBatchRunReportsRequest

BatchRunReportsRequest message or plain object
callback BatchRunReportsCallback

Node-style callback called with the error, if any, and BatchRunReportsResponse
Returns
Type Description
void

batchRunReports(request)

public batchRunReports(request: google.analytics.data.v1beta.IBatchRunReportsRequest): Promise<google.analytics.data.v1beta.BatchRunReportsResponse>;

Calls BatchRunReports.

Parameter
Name Description
request IBatchRunReportsRequest

BatchRunReportsRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.BatchRunReportsResponse>

Promise

checkCompatibility(request, callback)

public checkCompatibility(request: google.analytics.data.v1beta.ICheckCompatibilityRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.CheckCompatibilityCallback): void;

Calls CheckCompatibility.

Parameters
Name Description
request ICheckCompatibilityRequest

CheckCompatibilityRequest message or plain object
callback CheckCompatibilityCallback

Node-style callback called with the error, if any, and CheckCompatibilityResponse
Returns
Type Description
void

checkCompatibility(request)

public checkCompatibility(request: google.analytics.data.v1beta.ICheckCompatibilityRequest): Promise<google.analytics.data.v1beta.CheckCompatibilityResponse>;

Calls CheckCompatibility.

Parameter
Name Description
request ICheckCompatibilityRequest

CheckCompatibilityRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.CheckCompatibilityResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): BetaAnalyticsData;

Creates new BetaAnalyticsData service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
BetaAnalyticsData

RPC service. Useful where requests and/or responses are streamed.

createAudienceExport(request, callback)

public createAudienceExport(request: google.analytics.data.v1beta.ICreateAudienceExportRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.CreateAudienceExportCallback): void;

Calls CreateAudienceExport.

Parameters
Name Description
request ICreateAudienceExportRequest

CreateAudienceExportRequest message or plain object
callback CreateAudienceExportCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createAudienceExport(request)

public createAudienceExport(request: google.analytics.data.v1beta.ICreateAudienceExportRequest): Promise<google.longrunning.Operation>;

Calls CreateAudienceExport.

Parameter
Name Description
request ICreateAudienceExportRequest

CreateAudienceExportRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

getAudienceExport(request, callback)

public getAudienceExport(request: google.analytics.data.v1beta.IGetAudienceExportRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.GetAudienceExportCallback): void;

Calls GetAudienceExport.

Parameters
Name Description
request IGetAudienceExportRequest

GetAudienceExportRequest message or plain object
callback GetAudienceExportCallback

Node-style callback called with the error, if any, and AudienceExport
Returns
Type Description
void

getAudienceExport(request)

public getAudienceExport(request: google.analytics.data.v1beta.IGetAudienceExportRequest): Promise<google.analytics.data.v1beta.AudienceExport>;

Calls GetAudienceExport.

Parameter
Name Description
request IGetAudienceExportRequest

GetAudienceExportRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.AudienceExport>

Promise

getMetadata(request, callback)

public getMetadata(request: google.analytics.data.v1beta.IGetMetadataRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.GetMetadataCallback): void;

Calls GetMetadata.

Parameters
Name Description
request IGetMetadataRequest

GetMetadataRequest message or plain object
callback GetMetadataCallback

Node-style callback called with the error, if any, and Metadata
Returns
Type Description
void

getMetadata(request)

public getMetadata(request: google.analytics.data.v1beta.IGetMetadataRequest): Promise<google.analytics.data.v1beta.Metadata>;

Calls GetMetadata.

Parameter
Name Description
request IGetMetadataRequest

GetMetadataRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.Metadata>

Promise

listAudienceExports(request, callback)

public listAudienceExports(request: google.analytics.data.v1beta.IListAudienceExportsRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.ListAudienceExportsCallback): void;

Calls ListAudienceExports.

Parameters
Name Description
request IListAudienceExportsRequest

ListAudienceExportsRequest message or plain object
callback ListAudienceExportsCallback

Node-style callback called with the error, if any, and ListAudienceExportsResponse
Returns
Type Description
void

listAudienceExports(request)

public listAudienceExports(request: google.analytics.data.v1beta.IListAudienceExportsRequest): Promise<google.analytics.data.v1beta.ListAudienceExportsResponse>;

Calls ListAudienceExports.

Parameter
Name Description
request IListAudienceExportsRequest

ListAudienceExportsRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.ListAudienceExportsResponse>

Promise

queryAudienceExport(request, callback)

public queryAudienceExport(request: google.analytics.data.v1beta.IQueryAudienceExportRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.QueryAudienceExportCallback): void;

Calls QueryAudienceExport.

Parameters
Name Description
request IQueryAudienceExportRequest

QueryAudienceExportRequest message or plain object
callback QueryAudienceExportCallback

Node-style callback called with the error, if any, and QueryAudienceExportResponse
Returns
Type Description
void

queryAudienceExport(request)

public queryAudienceExport(request: google.analytics.data.v1beta.IQueryAudienceExportRequest): Promise<google.analytics.data.v1beta.QueryAudienceExportResponse>;

Calls QueryAudienceExport.

Parameter
Name Description
request IQueryAudienceExportRequest

QueryAudienceExportRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.QueryAudienceExportResponse>

Promise

runPivotReport(request, callback)

public runPivotReport(request: google.analytics.data.v1beta.IRunPivotReportRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.RunPivotReportCallback): void;

Calls RunPivotReport.

Parameters
Name Description
request IRunPivotReportRequest

RunPivotReportRequest message or plain object
callback RunPivotReportCallback

Node-style callback called with the error, if any, and RunPivotReportResponse
Returns
Type Description
void

runPivotReport(request)

public runPivotReport(request: google.analytics.data.v1beta.IRunPivotReportRequest): Promise<google.analytics.data.v1beta.RunPivotReportResponse>;

Calls RunPivotReport.

Parameter
Name Description
request IRunPivotReportRequest

RunPivotReportRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.RunPivotReportResponse>

Promise

runRealtimeReport(request, callback)

public runRealtimeReport(request: google.analytics.data.v1beta.IRunRealtimeReportRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.RunRealtimeReportCallback): void;

Calls RunRealtimeReport.

Parameters
Name Description
request IRunRealtimeReportRequest

RunRealtimeReportRequest message or plain object
callback RunRealtimeReportCallback

Node-style callback called with the error, if any, and RunRealtimeReportResponse
Returns
Type Description
void

runRealtimeReport(request)

public runRealtimeReport(request: google.analytics.data.v1beta.IRunRealtimeReportRequest): Promise<google.analytics.data.v1beta.RunRealtimeReportResponse>;

Calls RunRealtimeReport.

Parameter
Name Description
request IRunRealtimeReportRequest

RunRealtimeReportRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.RunRealtimeReportResponse>

Promise

runReport(request, callback)

public runReport(request: google.analytics.data.v1beta.IRunReportRequest, callback: google.analytics.data.v1beta.BetaAnalyticsData.RunReportCallback): void;

Calls RunReport.

Parameters
Name Description
request IRunReportRequest

RunReportRequest message or plain object
callback RunReportCallback

Node-style callback called with the error, if any, and RunReportResponse
Returns
Type Description
void

runReport(request)

public runReport(request: google.analytics.data.v1beta.IRunReportRequest): Promise<google.analytics.data.v1beta.RunReportResponse>;

Calls RunReport.

Parameter
Name Description
request IRunReportRequest

RunReportRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1beta.RunReportResponse>

Promise