Constructor
new AlphaAnalyticsDataClient(optionsopt, gaxInstanceopt)
Construct an instance of AlphaAnalyticsDataClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service.
apiEndpoint
The DNS address for this API service - same as servicePath.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
audienceListPath(property, audience_list) → {string}
Return a fully-qualified audienceList resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string | |
audience_list |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
cancelOperation(request, optionsopt, callbackopt) → {Promise}
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of
1, corresponding to Code.CANCELLED
.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```
(async) checkCreateAudienceListProgress(name) → {Promise}
Check the status of the long running operation returned by createAudienceList()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource where this audience list will be created.
* Format: `properties/{property}`
*/
// const parent = 'abc123'
/**
* Required. The audience list to create.
*/
// const audienceList = {}
// Imports the Data library
const {AlphaAnalyticsDataClient} = require('@google-cloud/data').v1alpha;
// Instantiates a client
const dataClient = new AlphaAnalyticsDataClient();
async function callCreateAudienceList() {
// Construct request
const request = {
parent,
audienceList,
};
// Run request
const [operation] = await dataClient.createAudienceList(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateAudienceList();
(async) checkCreateReportTaskProgress(name) → {Promise}
Check the status of the long running operation returned by createReportTask()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource where this report task will be created.
* Format: `properties/{propertyId}`
*/
// const parent = 'abc123'
/**
* Required. The report task configuration to create.
*/
// const reportTask = {}
// Imports the Data library
const {AlphaAnalyticsDataClient} = require('@google-cloud/data').v1alpha;
// Instantiates a client
const dataClient = new AlphaAnalyticsDataClient();
async function callCreateReportTask() {
// Construct request
const request = {
parent,
reportTask,
};
// Run request
const [operation] = await dataClient.createReportTask(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateReportTask();
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
deleteOperation(request, optionsopt, callbackopt) → {Promise}
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```
getOperation(request, optionsopt, callbackopt) → {Promise}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing google.longrunning.Operation. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
listAudienceListsAsync(request, optionsopt) → {Object}
Equivalent to listAudienceLists
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AudienceList. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. All audience lists for this property will be listed in the
* response. Format: `properties/{property}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of audience lists to return. The service may
* return fewer than this value. If unspecified, at most 200 audience lists
* will be returned. The maximum value is 1000 (higher values will be coerced
* to the maximum).
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListAudienceLists` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAudienceLists` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Data library
const {AlphaAnalyticsDataClient} = require('@google-cloud/data').v1alpha;
// Instantiates a client
const dataClient = new AlphaAnalyticsDataClient();
async function callListAudienceLists() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = dataClient.listAudienceListsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAudienceLists();
listAudienceListsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing AudienceList on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listOperationsAsync(request, optionsopt) → {Object}
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that conforms to iteration protocols. |
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```
listRecurringAudienceListsAsync(request, optionsopt) → {Object}
Equivalent to listRecurringAudienceLists
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing RecurringAudienceList. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. All recurring audience lists for this property will be listed in
* the response. Format: `properties/{property}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of recurring audience lists to return. The
* service may return fewer than this value. If unspecified, at most 200
* recurring audience lists will be returned. The maximum value is 1000
* (higher values will be coerced to the maximum).
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous
* `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
* page.
* When paginating, all other parameters provided to
* `ListRecurringAudienceLists` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
// Imports the Data library
const {AlphaAnalyticsDataClient} = require('@google-cloud/data').v1alpha;
// Instantiates a client
const dataClient = new AlphaAnalyticsDataClient();
async function callListRecurringAudienceLists() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = dataClient.listRecurringAudienceListsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRecurringAudienceLists();
listRecurringAudienceListsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing RecurringAudienceList on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listReportTasksAsync(request, optionsopt) → {Object}
Equivalent to listReportTasks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ReportTask. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. All report tasks for this property will be listed in the
* response. Format: `properties/{property}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of report tasks to return.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListReportTasks` call.
* Provide this to retrieve the subsequent page.
*/
// const pageToken = 'abc123'
// Imports the Data library
const {AlphaAnalyticsDataClient} = require('@google-cloud/data').v1alpha;
// Instantiates a client
const dataClient = new AlphaAnalyticsDataClient();
async function callListReportTasks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = dataClient.listReportTasksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListReportTasks();
listReportTasksStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing ReportTask on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
matchAudienceListFromAudienceListName(audienceListName) → {string}
Parse the audience_list from AudienceList resource.
Parameters:
Name | Type | Description |
---|---|---|
audienceListName |
string |
A fully-qualified path representing AudienceList resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the audience_list. |
matchPropertyFromAudienceListName(audienceListName) → {string}
Parse the property from AudienceList resource.
Parameters:
Name | Type | Description |
---|---|---|
audienceListName |
string |
A fully-qualified path representing AudienceList resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the property. |
matchPropertyFromPropertyName(propertyName) → {string}
Parse the property from Property resource.
Parameters:
Name | Type | Description |
---|---|---|
propertyName |
string |
A fully-qualified path representing Property resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the property. |
matchPropertyFromPropertyQuotasSnapshotName(propertyQuotasSnapshotName) → {string}
Parse the property from PropertyQuotasSnapshot resource.
Parameters:
Name | Type | Description |
---|---|---|
propertyQuotasSnapshotName |
string |
A fully-qualified path representing PropertyQuotasSnapshot resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the property. |
matchPropertyFromRecurringAudienceListName(recurringAudienceListName) → {string}
Parse the property from RecurringAudienceList resource.
Parameters:
Name | Type | Description |
---|---|---|
recurringAudienceListName |
string |
A fully-qualified path representing RecurringAudienceList resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the property. |
matchPropertyFromReportTaskName(reportTaskName) → {string}
Parse the property from ReportTask resource.
Parameters:
Name | Type | Description |
---|---|---|
reportTaskName |
string |
A fully-qualified path representing ReportTask resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the property. |
matchRecurringAudienceListFromRecurringAudienceListName(recurringAudienceListName) → {string}
Parse the recurring_audience_list from RecurringAudienceList resource.
Parameters:
Name | Type | Description |
---|---|---|
recurringAudienceListName |
string |
A fully-qualified path representing RecurringAudienceList resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the recurring_audience_list. |
matchReportTaskFromReportTaskName(reportTaskName) → {string}
Parse the report_task from ReportTask resource.
Parameters:
Name | Type | Description |
---|---|---|
reportTaskName |
string |
A fully-qualified path representing ReportTask resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the report_task. |
propertyPath(property) → {string}
Return a fully-qualified property resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
propertyQuotasSnapshotPath(property) → {string}
Return a fully-qualified propertyQuotasSnapshot resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
recurringAudienceListPath(property, recurring_audience_list) → {string}
Return a fully-qualified recurringAudienceList resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string | |
recurring_audience_list |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
reportTaskPath(property, report_task) → {string}
Return a fully-qualified reportTask resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string | |
report_task |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |