Class protos.google.analytics.data.v1alpha.AlphaAnalyticsData (6.1.0)

Represents an AlphaAnalyticsData

Inheritance

$protobuf.rpc.Service > protos.google.analytics.data.v1alpha.AlphaAnalyticsData

Package

@google-analytics/data

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new AlphaAnalyticsData service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new AlphaAnalyticsData 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
AlphaAnalyticsData

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

createAudienceList(request, callback)

public createAudienceList(request: google.analytics.data.v1alpha.ICreateAudienceListRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.CreateAudienceListCallback): void;

Calls CreateAudienceList.

Parameters
Name Description
request ICreateAudienceListRequest

CreateAudienceListRequest message or plain object
callback CreateAudienceListCallback

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

createAudienceList(request)

public createAudienceList(request: google.analytics.data.v1alpha.ICreateAudienceListRequest): Promise<google.longrunning.Operation>;

Calls CreateAudienceList.

Parameter
Name Description
request ICreateAudienceListRequest

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

Promise

createRecurringAudienceList(request, callback)

public createRecurringAudienceList(request: google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.CreateRecurringAudienceListCallback): void;

Calls CreateRecurringAudienceList.

Parameters
Name Description
request ICreateRecurringAudienceListRequest

CreateRecurringAudienceListRequest message or plain object
callback CreateRecurringAudienceListCallback

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

createRecurringAudienceList(request)

public createRecurringAudienceList(request: google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest): Promise<google.analytics.data.v1alpha.RecurringAudienceList>;

Calls CreateRecurringAudienceList.

Parameter
Name Description
request ICreateRecurringAudienceListRequest

CreateRecurringAudienceListRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.RecurringAudienceList>

Promise

createReportTask(request, callback)

public createReportTask(request: google.analytics.data.v1alpha.ICreateReportTaskRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.CreateReportTaskCallback): void;

Calls CreateReportTask.

Parameters
Name Description
request ICreateReportTaskRequest

CreateReportTaskRequest message or plain object
callback CreateReportTaskCallback

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

createReportTask(request)

public createReportTask(request: google.analytics.data.v1alpha.ICreateReportTaskRequest): Promise<google.longrunning.Operation>;

Calls CreateReportTask.

Parameter
Name Description
request ICreateReportTaskRequest

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

Promise

getAudienceList(request, callback)

public getAudienceList(request: google.analytics.data.v1alpha.IGetAudienceListRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.GetAudienceListCallback): void;

Calls GetAudienceList.

Parameters
Name Description
request IGetAudienceListRequest

GetAudienceListRequest message or plain object
callback GetAudienceListCallback

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

getAudienceList(request)

public getAudienceList(request: google.analytics.data.v1alpha.IGetAudienceListRequest): Promise<google.analytics.data.v1alpha.AudienceList>;

Calls GetAudienceList.

Parameter
Name Description
request IGetAudienceListRequest

GetAudienceListRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.AudienceList>

Promise

getMetadata(request, callback)

public getMetadata(request: google.analytics.data.v1alpha.IGetMetadataRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.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.v1alpha.IGetMetadataRequest): Promise<google.analytics.data.v1alpha.Metadata>;

Calls GetMetadata.

Parameter
Name Description
request IGetMetadataRequest

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

Promise

getPropertyQuotasSnapshot(request, callback)

public getPropertyQuotasSnapshot(request: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.GetPropertyQuotasSnapshotCallback): void;

Calls GetPropertyQuotasSnapshot.

Parameters
Name Description
request IGetPropertyQuotasSnapshotRequest

GetPropertyQuotasSnapshotRequest message or plain object
callback GetPropertyQuotasSnapshotCallback

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

getPropertyQuotasSnapshot(request)

public getPropertyQuotasSnapshot(request: google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest): Promise<google.analytics.data.v1alpha.PropertyQuotasSnapshot>;

Calls GetPropertyQuotasSnapshot.

Parameter
Name Description
request IGetPropertyQuotasSnapshotRequest

GetPropertyQuotasSnapshotRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.PropertyQuotasSnapshot>

Promise

getRecurringAudienceList(request, callback)

public getRecurringAudienceList(request: google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.GetRecurringAudienceListCallback): void;

Calls GetRecurringAudienceList.

Parameters
Name Description
request IGetRecurringAudienceListRequest

GetRecurringAudienceListRequest message or plain object
callback GetRecurringAudienceListCallback

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

getRecurringAudienceList(request)

public getRecurringAudienceList(request: google.analytics.data.v1alpha.IGetRecurringAudienceListRequest): Promise<google.analytics.data.v1alpha.RecurringAudienceList>;

Calls GetRecurringAudienceList.

Parameter
Name Description
request IGetRecurringAudienceListRequest

GetRecurringAudienceListRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.RecurringAudienceList>

Promise

getReportTask(request, callback)

public getReportTask(request: google.analytics.data.v1alpha.IGetReportTaskRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.GetReportTaskCallback): void;

Calls GetReportTask.

Parameters
Name Description
request IGetReportTaskRequest

GetReportTaskRequest message or plain object
callback GetReportTaskCallback

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

getReportTask(request)

public getReportTask(request: google.analytics.data.v1alpha.IGetReportTaskRequest): Promise<google.analytics.data.v1alpha.ReportTask>;

Calls GetReportTask.

Parameter
Name Description
request IGetReportTaskRequest

GetReportTaskRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.ReportTask>

Promise

listAudienceLists(request, callback)

public listAudienceLists(request: google.analytics.data.v1alpha.IListAudienceListsRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.ListAudienceListsCallback): void;

Calls ListAudienceLists.

Parameters
Name Description
request IListAudienceListsRequest

ListAudienceListsRequest message or plain object
callback ListAudienceListsCallback

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

listAudienceLists(request)

public listAudienceLists(request: google.analytics.data.v1alpha.IListAudienceListsRequest): Promise<google.analytics.data.v1alpha.ListAudienceListsResponse>;

Calls ListAudienceLists.

Parameter
Name Description
request IListAudienceListsRequest

ListAudienceListsRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.ListAudienceListsResponse>

Promise

listRecurringAudienceLists(request, callback)

public listRecurringAudienceLists(request: google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.ListRecurringAudienceListsCallback): void;

Calls ListRecurringAudienceLists.

Parameters
Name Description
request IListRecurringAudienceListsRequest

ListRecurringAudienceListsRequest message or plain object
callback ListRecurringAudienceListsCallback

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

listRecurringAudienceLists(request)

public listRecurringAudienceLists(request: google.analytics.data.v1alpha.IListRecurringAudienceListsRequest): Promise<google.analytics.data.v1alpha.ListRecurringAudienceListsResponse>;

Calls ListRecurringAudienceLists.

Parameter
Name Description
request IListRecurringAudienceListsRequest

ListRecurringAudienceListsRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.ListRecurringAudienceListsResponse>

Promise

listReportTasks(request, callback)

public listReportTasks(request: google.analytics.data.v1alpha.IListReportTasksRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.ListReportTasksCallback): void;

Calls ListReportTasks.

Parameters
Name Description
request IListReportTasksRequest

ListReportTasksRequest message or plain object
callback ListReportTasksCallback

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

listReportTasks(request)

public listReportTasks(request: google.analytics.data.v1alpha.IListReportTasksRequest): Promise<google.analytics.data.v1alpha.ListReportTasksResponse>;

Calls ListReportTasks.

Parameter
Name Description
request IListReportTasksRequest

ListReportTasksRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.ListReportTasksResponse>

Promise

queryAudienceList(request, callback)

public queryAudienceList(request: google.analytics.data.v1alpha.IQueryAudienceListRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.QueryAudienceListCallback): void;

Calls QueryAudienceList.

Parameters
Name Description
request IQueryAudienceListRequest

QueryAudienceListRequest message or plain object
callback QueryAudienceListCallback

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

queryAudienceList(request)

public queryAudienceList(request: google.analytics.data.v1alpha.IQueryAudienceListRequest): Promise<google.analytics.data.v1alpha.QueryAudienceListResponse>;

Calls QueryAudienceList.

Parameter
Name Description
request IQueryAudienceListRequest

QueryAudienceListRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.QueryAudienceListResponse>

Promise

queryReportTask(request, callback)

public queryReportTask(request: google.analytics.data.v1alpha.IQueryReportTaskRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.QueryReportTaskCallback): void;

Calls QueryReportTask.

Parameters
Name Description
request IQueryReportTaskRequest

QueryReportTaskRequest message or plain object
callback QueryReportTaskCallback

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

queryReportTask(request)

public queryReportTask(request: google.analytics.data.v1alpha.IQueryReportTaskRequest): Promise<google.analytics.data.v1alpha.QueryReportTaskResponse>;

Calls QueryReportTask.

Parameter
Name Description
request IQueryReportTaskRequest

QueryReportTaskRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.QueryReportTaskResponse>

Promise

runFunnelReport(request, callback)

public runFunnelReport(request: google.analytics.data.v1alpha.IRunFunnelReportRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReportCallback): void;

Calls RunFunnelReport.

Parameters
Name Description
request IRunFunnelReportRequest

RunFunnelReportRequest message or plain object
callback RunFunnelReportCallback

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

runFunnelReport(request)

public runFunnelReport(request: google.analytics.data.v1alpha.IRunFunnelReportRequest): Promise<google.analytics.data.v1alpha.RunFunnelReportResponse>;

Calls RunFunnelReport.

Parameter
Name Description
request IRunFunnelReportRequest

RunFunnelReportRequest message or plain object
Returns
Type Description
Promise<google.analytics.data.v1alpha.RunFunnelReportResponse>

Promise

runReport(request, callback)

public runReport(request: google.analytics.data.v1alpha.IRunReportRequest, callback: google.analytics.data.v1alpha.AlphaAnalyticsData.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.v1alpha.IRunReportRequest): Promise<google.analytics.data.v1alpha.RunReportResponse>;

Calls RunReport.

Parameter
Name Description
request IRunReportRequest

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

Promise