Constructor
new BetaAnalyticsDataClient(optionsopt, gaxInstanceopt)
Construct an instance of BetaAnalyticsDataClient.
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
audienceExportPath(property, audience_export) → {string}
Return a fully-qualified audienceExport resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string | |
audience_export |
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) checkCreateAudienceExportProgress(name) → {Promise}
Check the status of the long running operation returned by createAudienceExport()
.
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 export will be created.
* Format: `properties/{property}`
*/
// const parent = 'abc123'
/**
* Required. The audience export to create.
*/
// const audienceExport = {}
// Imports the Data library
const {BetaAnalyticsDataClient} = require('@google-analytics/data').v1beta;
// Instantiates a client
const dataClient = new BetaAnalyticsDataClient();
async function callCreateAudienceExport() {
// Construct request
const request = {
parent,
audienceExport,
};
// Run request
const [operation] = await dataClient.createAudienceExport(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateAudienceExport();
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. |
listAudienceExportsAsync(request, optionsopt) → {Object}
Equivalent to listAudienceExports
, 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 AudienceExport. 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 exports for this property will be listed in the
* response. Format: `properties/{property}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of audience exports to return. The service may
* return fewer than this value. If unspecified, at most 200 audience exports
* 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 `ListAudienceExports`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAudienceExports`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Data library
const {BetaAnalyticsDataClient} = require('@google-analytics/data').v1beta;
// Instantiates a client
const dataClient = new BetaAnalyticsDataClient();
async function callListAudienceExports() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = dataClient.listAudienceExportsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAudienceExports();
listAudienceExportsStream(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 AudienceExport 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)
```
matchAudienceExportFromAudienceExportName(audienceExportName) → {string}
Parse the audience_export from AudienceExport resource.
Parameters:
Name | Type | Description |
---|---|---|
audienceExportName |
string |
A fully-qualified path representing AudienceExport resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the audience_export. |
matchPropertyFromAudienceExportName(audienceExportName) → {string}
Parse the property from AudienceExport resource.
Parameters:
Name | Type | Description |
---|---|---|
audienceExportName |
string |
A fully-qualified path representing AudienceExport resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the property. |
matchPropertyFromMetadataName(metadataName) → {string}
Parse the property from Metadata resource.
Parameters:
Name | Type | Description |
---|---|---|
metadataName |
string |
A fully-qualified path representing Metadata 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. |
metadataPath(property) → {string}
Return a fully-qualified metadata resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
propertyPath(property) → {string}
Return a fully-qualified property resource name string.
Parameters:
Name | Type | Description |
---|---|---|
property |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |