AlphaAnalyticsData

google.analytics.data.v1alpha. AlphaAnalyticsData

Represents an AlphaAnalyticsData

Constructor

new AlphaAnalyticsData(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new AlphaAnalyticsData service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

createAudienceList(request, callback) → {undefined}

Calls CreateAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ICreateAudienceListRequest

CreateAudienceListRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.CreateAudienceListCallback

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

createAudienceList(request) → {Promise.<google.longrunning.Operation>}

Calls CreateAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ICreateAudienceListRequest

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

Promise

createRecurringAudienceList(request, callback) → {undefined}

Calls CreateRecurringAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest

CreateRecurringAudienceListRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.CreateRecurringAudienceListCallback

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

createRecurringAudienceList(request) → {Promise.<google.analytics.data.v1alpha.RecurringAudienceList>}

Calls CreateRecurringAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest

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

Promise

createReportTask(request, callback) → {undefined}

Calls CreateReportTask.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ICreateReportTaskRequest

CreateReportTaskRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.CreateReportTaskCallback

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

createReportTask(request) → {Promise.<google.longrunning.Operation>}

Calls CreateReportTask.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ICreateReportTaskRequest

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

Promise

getAudienceList(request, callback) → {undefined}

Calls GetAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetAudienceListRequest

GetAudienceListRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.GetAudienceListCallback

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

getAudienceList(request) → {Promise.<google.analytics.data.v1alpha.AudienceList>}

Calls GetAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetAudienceListRequest

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

Promise

getPropertyQuotasSnapshot(request, callback) → {undefined}

Calls GetPropertyQuotasSnapshot.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest

GetPropertyQuotasSnapshotRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.GetPropertyQuotasSnapshotCallback

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

getPropertyQuotasSnapshot(request) → {Promise.<google.analytics.data.v1alpha.PropertyQuotasSnapshot>}

Calls GetPropertyQuotasSnapshot.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest

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

Promise

getRecurringAudienceList(request, callback) → {undefined}

Calls GetRecurringAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetRecurringAudienceListRequest

GetRecurringAudienceListRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.GetRecurringAudienceListCallback

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

getRecurringAudienceList(request) → {Promise.<google.analytics.data.v1alpha.RecurringAudienceList>}

Calls GetRecurringAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetRecurringAudienceListRequest

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

Promise

getReportTask(request, callback) → {undefined}

Calls GetReportTask.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetReportTaskRequest

GetReportTaskRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.GetReportTaskCallback

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

getReportTask(request) → {Promise.<google.analytics.data.v1alpha.ReportTask>}

Calls GetReportTask.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IGetReportTaskRequest

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

Promise

listAudienceLists(request, callback) → {undefined}

Calls ListAudienceLists.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IListAudienceListsRequest

ListAudienceListsRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.ListAudienceListsCallback

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

listAudienceLists(request) → {Promise.<google.analytics.data.v1alpha.ListAudienceListsResponse>}

Calls ListAudienceLists.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IListAudienceListsRequest

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

Promise

listRecurringAudienceLists(request, callback) → {undefined}

Calls ListRecurringAudienceLists.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IListRecurringAudienceListsRequest

ListRecurringAudienceListsRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.ListRecurringAudienceListsCallback

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

listRecurringAudienceLists(request) → {Promise.<google.analytics.data.v1alpha.ListRecurringAudienceListsResponse>}

Calls ListRecurringAudienceLists.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IListRecurringAudienceListsRequest

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

Promise

listReportTasks(request, callback) → {undefined}

Calls ListReportTasks.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IListReportTasksRequest

ListReportTasksRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.ListReportTasksCallback

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

listReportTasks(request) → {Promise.<google.analytics.data.v1alpha.ListReportTasksResponse>}

Calls ListReportTasks.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IListReportTasksRequest

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

Promise

queryAudienceList(request, callback) → {undefined}

Calls QueryAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IQueryAudienceListRequest

QueryAudienceListRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.QueryAudienceListCallback

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

queryAudienceList(request) → {Promise.<google.analytics.data.v1alpha.QueryAudienceListResponse>}

Calls QueryAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IQueryAudienceListRequest

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

Promise

queryReportTask(request, callback) → {undefined}

Calls QueryReportTask.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IQueryReportTaskRequest

QueryReportTaskRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.QueryReportTaskCallback

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

queryReportTask(request) → {Promise.<google.analytics.data.v1alpha.QueryReportTaskResponse>}

Calls QueryReportTask.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IQueryReportTaskRequest

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

Promise

runFunnelReport(request, callback) → {undefined}

Calls RunFunnelReport.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IRunFunnelReportRequest

RunFunnelReportRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.RunFunnelReportCallback

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

runFunnelReport(request) → {Promise.<google.analytics.data.v1alpha.RunFunnelReportResponse>}

Calls RunFunnelReport.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.IRunFunnelReportRequest

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

Promise

sheetExportAudienceList(request, callback) → {undefined}

Calls SheetExportAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ISheetExportAudienceListRequest

SheetExportAudienceListRequest message or plain object
callback google.analytics.data.v1alpha.AlphaAnalyticsData.SheetExportAudienceListCallback

Node-style callback called with the error, if any, and SheetExportAudienceListResponse
Returns:
Type Description
undefined

sheetExportAudienceList(request) → {Promise.<google.analytics.data.v1alpha.SheetExportAudienceListResponse>}

Calls SheetExportAudienceList.

Parameters:
Name Type Description
request google.analytics.data.v1alpha.ISheetExportAudienceListRequest

SheetExportAudienceListRequest message or plain object
Returns:
Type Description
Promise.<google.analytics.data.v1alpha.SheetExportAudienceListResponse>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {AlphaAnalyticsData}

Creates new AlphaAnalyticsData service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
AlphaAnalyticsData

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

Type Definitions

CreateAudienceListCallback(error, responseopt)

Callback as used by createAudienceList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

CreateRecurringAudienceListCallback(error, responseopt)

Callback as used by createRecurringAudienceList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.RecurringAudienceList <optional>

RecurringAudienceList

CreateReportTaskCallback(error, responseopt)

Callback as used by createReportTask.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetAudienceListCallback(error, responseopt)

Callback as used by getAudienceList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.AudienceList <optional>

AudienceList

GetPropertyQuotasSnapshotCallback(error, responseopt)

Callback as used by getPropertyQuotasSnapshot.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.PropertyQuotasSnapshot <optional>

PropertyQuotasSnapshot

GetRecurringAudienceListCallback(error, responseopt)

Callback as used by getRecurringAudienceList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.RecurringAudienceList <optional>

RecurringAudienceList

GetReportTaskCallback(error, responseopt)

Callback as used by getReportTask.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.ReportTask <optional>

ReportTask

ListAudienceListsCallback(error, responseopt)

Callback as used by listAudienceLists.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.ListAudienceListsResponse <optional>

ListAudienceListsResponse

ListRecurringAudienceListsCallback(error, responseopt)

Callback as used by listRecurringAudienceLists.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.ListRecurringAudienceListsResponse <optional>

ListRecurringAudienceListsResponse

ListReportTasksCallback(error, responseopt)

Callback as used by listReportTasks.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.ListReportTasksResponse <optional>

ListReportTasksResponse

QueryAudienceListCallback(error, responseopt)

Callback as used by queryAudienceList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.QueryAudienceListResponse <optional>

QueryAudienceListResponse

QueryReportTaskCallback(error, responseopt)

Callback as used by queryReportTask.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.QueryReportTaskResponse <optional>

QueryReportTaskResponse

RunFunnelReportCallback(error, responseopt)

Callback as used by runFunnelReport.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.RunFunnelReportResponse <optional>

RunFunnelReportResponse

SheetExportAudienceListCallback(error, responseopt)

Callback as used by sheetExportAudienceList.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.analytics.data.v1alpha.SheetExportAudienceListResponse <optional>

SheetExportAudienceListResponse