Service Interface for the Analytics Admin API (GA4). v1beta
Package
@google-analytics/admin
Constructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of AnalyticsAdminServiceClient.
Parameters |
---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of google-gax . Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new AnalyticsAdminServiceClient({fallback: 'rest'}, gax); ```
|
Properties
analyticsAdminServiceStub
analyticsAdminServiceStub?: Promise<{
[name: string]: Function;
}>;
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
accountPath(account)
accountPath(account: string): string;
Return a fully-qualified account resource name string.
Parameter |
---|
Name | Description |
account |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
accountSummaryPath(accountSummary)
accountSummaryPath(accountSummary: string): string;
Return a fully-qualified accountSummary resource name string.
Parameter |
---|
Name | Description |
accountSummary |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
acknowledgeUserDataCollection(request, options)
acknowledgeUserDataCollection(request?: protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse,
(protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | undefined),
{} | undefined
]>;
Acknowledges the terms of user data collection for the specified property.
This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse,
(protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The property for which to acknowledge user data collection.
*/
// const property = 'abc123'
/**
* Required. An acknowledgement that the caller of this method understands the terms
* of user data collection.
* This field must contain the exact value:
* "I acknowledge that I have the necessary privacy disclosures and rights
* from my end users for the collection and processing of their data,
* including the association of such data with the visitation information
* Google Analytics collects from my site and/or app property."
*/
// const acknowledgement = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callAcknowledgeUserDataCollection() {
// Construct request
const request = {
property,
acknowledgement,
};
// Run request
const response = await adminClient.acknowledgeUserDataCollection(request);
console.log(response);
}
callAcknowledgeUserDataCollection();
acknowledgeUserDataCollection(request, options, callback)
acknowledgeUserDataCollection(request: protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
acknowledgeUserDataCollection(request, callback)
acknowledgeUserDataCollection(request: protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, callback: Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
archiveCustomDimension(request, options)
archiveCustomDimension(request?: protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | undefined),
{} | undefined
]>;
Archives a CustomDimension on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the CustomDimension to archive.
* Example format: properties/1234/customDimensions/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callArchiveCustomDimension() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.archiveCustomDimension(request);
console.log(response);
}
callArchiveCustomDimension();
archiveCustomDimension(request, options, callback)
archiveCustomDimension(request: protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
archiveCustomDimension(request, callback)
archiveCustomDimension(request: protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
archiveCustomMetric(request, options)
archiveCustomMetric(request?: protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | undefined),
{} | undefined
]>;
Archives a CustomMetric on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the CustomMetric to archive.
* Example format: properties/1234/customMetrics/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callArchiveCustomMetric() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.archiveCustomMetric(request);
console.log(response);
}
callArchiveCustomMetric();
archiveCustomMetric(request, options, callback)
archiveCustomMetric(request: protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
archiveCustomMetric(request, callback)
archiveCustomMetric(request: protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
close()
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<void> | {Promise} A promise that resolves when the client is closed.
|
conversionEventPath(property, conversionEvent)
conversionEventPath(property: string, conversionEvent: string): string;
Return a fully-qualified conversionEvent resource name string.
Parameters |
---|
Name | Description |
property |
string
|
conversionEvent |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
createConversionEvent(request, options)
createConversionEvent(request?: protos.google.analytics.admin.v1beta.ICreateConversionEventRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IConversionEvent,
(protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | undefined),
{} | undefined
]>;
Creates a conversion event with the specified attributes.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateConversionEventRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IConversionEvent,
(protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The conversion event to create.
*/
// const conversionEvent = {}
/**
* Required. The resource name of the parent property where this conversion event will
* be created. Format: properties/123
*/
// const parent = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateConversionEvent() {
// Construct request
const request = {
conversionEvent,
parent,
};
// Run request
const response = await adminClient.createConversionEvent(request);
console.log(response);
}
callCreateConversionEvent();
createConversionEvent(request, options, callback)
createConversionEvent(request: protos.google.analytics.admin.v1beta.ICreateConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateConversionEventRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createConversionEvent(request, callback)
createConversionEvent(request: protos.google.analytics.admin.v1beta.ICreateConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateConversionEventRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createCustomDimension(request, options)
createCustomDimension(request?: protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension,
(protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | undefined),
{} | undefined
]>;
Creates a CustomDimension.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension,
(protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The CustomDimension to create.
*/
// const customDimension = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateCustomDimension() {
// Construct request
const request = {
parent,
customDimension,
};
// Run request
const response = await adminClient.createCustomDimension(request);
console.log(response);
}
callCreateCustomDimension();
createCustomDimension(request, options, callback)
createCustomDimension(request: protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createCustomDimension(request, callback)
createCustomDimension(request: protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createCustomMetric(request, options)
createCustomMetric(request?: protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric,
(protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | undefined),
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric,
(protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The CustomMetric to create.
*/
// const customMetric = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateCustomMetric() {
// Construct request
const request = {
parent,
customMetric,
};
// Run request
const response = await adminClient.createCustomMetric(request);
console.log(response);
}
callCreateCustomMetric();
createCustomMetric(request, options, callback)
createCustomMetric(request: protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createCustomMetric(request, callback)
createCustomMetric(request: protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createDataStream(request, options)
createDataStream(request?: protos.google.analytics.admin.v1beta.ICreateDataStreamRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataStream,
protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | undefined,
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateDataStreamRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataStream,
protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The DataStream to create.
*/
// const dataStream = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateDataStream() {
// Construct request
const request = {
parent,
dataStream,
};
// Run request
const response = await adminClient.createDataStream(request);
console.log(response);
}
callCreateDataStream();
createDataStream(request, options, callback)
createDataStream(request: protos.google.analytics.admin.v1beta.ICreateDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateDataStreamRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createDataStream(request, callback)
createDataStream(request: protos.google.analytics.admin.v1beta.ICreateDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateDataStreamRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createFirebaseLink(request, options)
createFirebaseLink(request?: protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IFirebaseLink,
(protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | undefined),
{} | undefined
]>;
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IFirebaseLink,
(protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Format: properties/{property_id}
* Example: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The Firebase link to create.
*/
// const firebaseLink = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateFirebaseLink() {
// Construct request
const request = {
parent,
firebaseLink,
};
// Run request
const response = await adminClient.createFirebaseLink(request);
console.log(response);
}
callCreateFirebaseLink();
createFirebaseLink(request, options, callback)
createFirebaseLink(request: protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createFirebaseLink(request, callback)
createFirebaseLink(request: protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, callback: Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createGoogleAdsLink(request, options)
createGoogleAdsLink(request?: protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IGoogleAdsLink,
(protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | undefined),
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IGoogleAdsLink,
(protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The GoogleAdsLink to create.
*/
// const googleAdsLink = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateGoogleAdsLink() {
// Construct request
const request = {
parent,
googleAdsLink,
};
// Run request
const response = await adminClient.createGoogleAdsLink(request);
console.log(response);
}
callCreateGoogleAdsLink();
createGoogleAdsLink(request, options, callback)
createGoogleAdsLink(request: protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createGoogleAdsLink(request, callback)
createGoogleAdsLink(request: protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createMeasurementProtocolSecret(request, options)
createMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Creates a measurement protocol secret.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The parent resource where this secret will be created.
* Format: properties/{property}/dataStreams/{dataStream}
*/
// const parent = 'abc123'
/**
* Required. The measurement protocol secret to create.
*/
// const measurementProtocolSecret = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateMeasurementProtocolSecret() {
// Construct request
const request = {
parent,
measurementProtocolSecret,
};
// Run request
const response = await adminClient.createMeasurementProtocolSecret(request);
console.log(response);
}
callCreateMeasurementProtocolSecret();
createMeasurementProtocolSecret(request, options, callback)
createMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createMeasurementProtocolSecret(request, callback)
createMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createProperty(request, options)
createProperty(request?: protos.google.analytics.admin.v1beta.ICreatePropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.ICreatePropertyRequest | undefined,
{} | undefined
]>;
Creates an "GA4" property with the specified location and attributes.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreatePropertyRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.ICreatePropertyRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The property to create.
* Note: the supplied property must specify its parent.
*/
// const property = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateProperty() {
// Construct request
const request = {
property,
};
// Run request
const response = await adminClient.createProperty(request);
console.log(response);
}
callCreateProperty();
createProperty(request, options, callback)
createProperty(request: protos.google.analytics.admin.v1beta.ICreatePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreatePropertyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
createProperty(request, callback)
createProperty(request: protos.google.analytics.admin.v1beta.ICreatePropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ICreatePropertyRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
customDimensionPath(property, customDimension)
customDimensionPath(property: string, customDimension: string): string;
Return a fully-qualified customDimension resource name string.
Parameters |
---|
Name | Description |
property |
string
|
customDimension |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
customMetricPath(property, customMetric)
customMetricPath(property: string, customMetric: string): string;
Return a fully-qualified customMetric resource name string.
Parameters |
---|
Name | Description |
property |
string
|
customMetric |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
dataRetentionSettingsPath(property)
dataRetentionSettingsPath(property: string): string;
Return a fully-qualified dataRetentionSettings resource name string.
Parameter |
---|
Name | Description |
property |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
dataSharingSettingsPath(account)
dataSharingSettingsPath(account: string): string;
Return a fully-qualified dataSharingSettings resource name string.
Parameter |
---|
Name | Description |
account |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
dataStreamPath(property, dataStream)
dataStreamPath(property: string, dataStream: string): string;
Return a fully-qualified dataStream resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
deleteAccount(request, options)
deleteAccount(request?: protos.google.analytics.admin.v1beta.IDeleteAccountRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.analytics.admin.v1beta.IDeleteAccountRequest | undefined,
{} | undefined
]>;
Marks target Account as soft-deleted (ie: "trashed") and returns it.
This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.
If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteAccountRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.analytics.admin.v1beta.IDeleteAccountRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the Account to soft-delete.
* Format: accounts/{account}
* Example: "accounts/100"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteAccount() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteAccount(request);
console.log(response);
}
callDeleteAccount();
deleteAccount(request, options, callback)
deleteAccount(request: protos.google.analytics.admin.v1beta.IDeleteAccountRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteAccountRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteAccount(request, callback)
deleteAccount(request: protos.google.analytics.admin.v1beta.IDeleteAccountRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteAccountRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteConversionEvent(request, options)
deleteConversionEvent(request?: protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | undefined),
{} | undefined
]>;
Deletes a conversion event in a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The resource name of the conversion event to delete.
* Format: properties/{property}/conversionEvents/{conversion_event}
* Example: "properties/123/conversionEvents/456"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteConversionEvent() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteConversionEvent(request);
console.log(response);
}
callDeleteConversionEvent();
deleteConversionEvent(request, options, callback)
deleteConversionEvent(request: protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteConversionEvent(request, callback)
deleteConversionEvent(request: protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteDataStream(request, options)
deleteDataStream(request?: protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | undefined,
{} | undefined
]>;
Deletes a DataStream on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the DataStream to delete.
* Example format: properties/1234/dataStreams/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteDataStream() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteDataStream(request);
console.log(response);
}
callDeleteDataStream();
deleteDataStream(request, options, callback)
deleteDataStream(request: protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteDataStream(request, callback)
deleteDataStream(request: protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteFirebaseLink(request, options)
deleteFirebaseLink(request?: protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | undefined),
{} | undefined
]>;
Deletes a FirebaseLink on a property
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}
* Example: properties/1234/firebaseLinks/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteFirebaseLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteFirebaseLink(request);
console.log(response);
}
callDeleteFirebaseLink();
deleteFirebaseLink(request, options, callback)
deleteFirebaseLink(request: protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteFirebaseLink(request, callback)
deleteFirebaseLink(request: protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteGoogleAdsLink(request, options)
deleteGoogleAdsLink(request?: protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | undefined),
{} | undefined
]>;
Deletes a GoogleAdsLink on a property
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. Example format: properties/1234/googleAdsLinks/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteGoogleAdsLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteGoogleAdsLink(request);
console.log(response);
}
callDeleteGoogleAdsLink();
deleteGoogleAdsLink(request, options, callback)
deleteGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteGoogleAdsLink(request, callback)
deleteGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteMeasurementProtocolSecret(request, options)
deleteMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Deletes target MeasurementProtocolSecret.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the MeasurementProtocolSecret to delete.
* Format:
* properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteMeasurementProtocolSecret() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteMeasurementProtocolSecret(request);
console.log(response);
}
callDeleteMeasurementProtocolSecret();
deleteMeasurementProtocolSecret(request, options, callback)
deleteMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteMeasurementProtocolSecret(request, callback)
deleteMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteProperty(request, options)
deleteProperty(request?: protos.google.analytics.admin.v1beta.IDeletePropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.IDeletePropertyRequest | undefined,
{} | undefined
]>;
Marks target Property as soft-deleted (ie: "trashed") and returns it.
This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.
If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found, or is not an GA4 Property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeletePropertyRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.IDeletePropertyRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the Property to soft-delete.
* Format: properties/{property_id}
* Example: "properties/1000"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteProperty() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteProperty(request);
console.log(response);
}
callDeleteProperty();
deleteProperty(request, options, callback)
deleteProperty(request: protos.google.analytics.admin.v1beta.IDeletePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeletePropertyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
deleteProperty(request, callback)
deleteProperty(request: protos.google.analytics.admin.v1beta.IDeletePropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IDeletePropertyRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
firebaseLinkPath(property, firebaseLink)
firebaseLinkPath(property: string, firebaseLink: string): string;
Return a fully-qualified firebaseLink resource name string.
Parameters |
---|
Name | Description |
property |
string
|
firebaseLink |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
getAccount(request, options)
getAccount(request?: protos.google.analytics.admin.v1beta.IGetAccountRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IAccount,
protos.google.analytics.admin.v1beta.IGetAccountRequest | undefined,
{} | undefined
]>;
Lookup for a single Account.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetAccountRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IAccount,
protos.google.analytics.admin.v1beta.IGetAccountRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the account to lookup.
* Format: accounts/{account}
* Example: "accounts/100"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetAccount() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getAccount(request);
console.log(response);
}
callGetAccount();
getAccount(request, options, callback)
getAccount(request: protos.google.analytics.admin.v1beta.IGetAccountRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetAccountRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getAccount(request, callback)
getAccount(request: protos.google.analytics.admin.v1beta.IGetAccountRequest, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetAccountRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getConversionEvent(request, options)
getConversionEvent(request?: protos.google.analytics.admin.v1beta.IGetConversionEventRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IConversionEvent,
(protos.google.analytics.admin.v1beta.IGetConversionEventRequest | undefined),
{} | undefined
]>;
Retrieve a single conversion event.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetConversionEventRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IConversionEvent,
(protos.google.analytics.admin.v1beta.IGetConversionEventRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The resource name of the conversion event to retrieve.
* Format: properties/{property}/conversionEvents/{conversion_event}
* Example: "properties/123/conversionEvents/456"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetConversionEvent() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getConversionEvent(request);
console.log(response);
}
callGetConversionEvent();
getConversionEvent(request, options, callback)
getConversionEvent(request: protos.google.analytics.admin.v1beta.IGetConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetConversionEventRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getConversionEvent(request, callback)
getConversionEvent(request: protos.google.analytics.admin.v1beta.IGetConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetConversionEventRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getCustomDimension(request, options)
getCustomDimension(request?: protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension,
(protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | undefined),
{} | undefined
]>;
Lookup for a single CustomDimension.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension,
(protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the CustomDimension to get.
* Example format: properties/1234/customDimensions/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetCustomDimension() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getCustomDimension(request);
console.log(response);
}
callGetCustomDimension();
getCustomDimension(request, options, callback)
getCustomDimension(request: protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getCustomDimension(request, callback)
getCustomDimension(request: protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getCustomMetric(request, options)
getCustomMetric(request?: protos.google.analytics.admin.v1beta.IGetCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric,
protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | undefined,
{} | undefined
]>;
Lookup for a single CustomMetric.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetCustomMetricRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric,
protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the CustomMetric to get.
* Example format: properties/1234/customMetrics/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetCustomMetric() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getCustomMetric(request);
console.log(response);
}
callGetCustomMetric();
getCustomMetric(request, options, callback)
getCustomMetric(request: protos.google.analytics.admin.v1beta.IGetCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetCustomMetricRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getCustomMetric(request, callback)
getCustomMetric(request: protos.google.analytics.admin.v1beta.IGetCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetCustomMetricRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getDataRetentionSettings(request, options)
getDataRetentionSettings(request?: protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataRetentionSettings,
(protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | undefined),
{} | undefined
]>;
Returns the singleton data retention settings for this property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataRetentionSettings,
(protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the settings to lookup.
* Format:
* properties/{property}/dataRetentionSettings
* Example: "properties/1000/dataRetentionSettings"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetDataRetentionSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getDataRetentionSettings(request);
console.log(response);
}
callGetDataRetentionSettings();
getDataRetentionSettings(request, options, callback)
getDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getDataRetentionSettings(request, callback)
getDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getDataSharingSettings(request, options)
getDataSharingSettings(request?: protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataSharingSettings,
(protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | undefined),
{} | undefined
]>;
Get data sharing settings on an account. Data sharing settings are singletons.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataSharingSettings,
(protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the settings to lookup.
* Format: accounts/{account}/dataSharingSettings
* Example: "accounts/1000/dataSharingSettings"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetDataSharingSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getDataSharingSettings(request);
console.log(response);
}
callGetDataSharingSettings();
getDataSharingSettings(request, options, callback)
getDataSharingSettings(request: protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getDataSharingSettings(request, callback)
getDataSharingSettings(request: protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getDataStream(request, options)
getDataStream(request?: protos.google.analytics.admin.v1beta.IGetDataStreamRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataStream,
protos.google.analytics.admin.v1beta.IGetDataStreamRequest | undefined,
{} | undefined
]>;
Lookup for a single DataStream.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataStreamRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataStream,
protos.google.analytics.admin.v1beta.IGetDataStreamRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the DataStream to get.
* Example format: properties/1234/dataStreams/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetDataStream() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getDataStream(request);
console.log(response);
}
callGetDataStream();
getDataStream(request, options, callback)
getDataStream(request: protos.google.analytics.admin.v1beta.IGetDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataStreamRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getDataStream(request, callback)
getDataStream(request: protos.google.analytics.admin.v1beta.IGetDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetDataStreamRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getMeasurementProtocolSecret(request, options)
getMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Lookup for a single "GA4" MeasurementProtocolSecret.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the measurement protocol secret to lookup.
* Format:
* properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetMeasurementProtocolSecret() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getMeasurementProtocolSecret(request);
console.log(response);
}
callGetMeasurementProtocolSecret();
getMeasurementProtocolSecret(request, options, callback)
getMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getMeasurementProtocolSecret(request, callback)
getMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getProjectId()
getProjectId(): Promise<string>;
Returns |
---|
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter |
---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns |
---|
Type | Description |
void | |
getProperty(request, options)
getProperty(request?: protos.google.analytics.admin.v1beta.IGetPropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.IGetPropertyRequest | undefined,
{} | undefined
]>;
Lookup for a single "GA4" Property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetPropertyRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.IGetPropertyRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The name of the property to lookup.
* Format: properties/{property_id}
* Example: "properties/1000"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetProperty() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getProperty(request);
console.log(response);
}
callGetProperty();
getProperty(request, options, callback)
getProperty(request: protos.google.analytics.admin.v1beta.IGetPropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetPropertyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
getProperty(request, callback)
getProperty(request: protos.google.analytics.admin.v1beta.IGetPropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IGetPropertyRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
googleAdsLinkPath(property, googleAdsLink)
googleAdsLinkPath(property: string, googleAdsLink: string): string;
Return a fully-qualified googleAdsLink resource name string.
Parameters |
---|
Name | Description |
property |
string
|
googleAdsLink |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listAccounts(request, options)
listAccounts(request?: protos.google.analytics.admin.v1beta.IListAccountsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IAccount[],
protos.google.analytics.admin.v1beta.IListAccountsRequest | null,
protos.google.analytics.admin.v1beta.IListAccountsResponse
]>;
Returns all accounts accessible by the caller.
Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IAccount[],
protos.google.analytics.admin.v1beta.IListAccountsRequest | null,
protos.google.analytics.admin.v1beta.IListAccountsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAccountsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listAccounts(request, options, callback)
listAccounts(request: protos.google.analytics.admin.v1beta.IListAccountsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>
|
Returns |
---|
Type | Description |
void | |
listAccounts(request, callback)
listAccounts(request: protos.google.analytics.admin.v1beta.IListAccountsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>
|
Returns |
---|
Type | Description |
void | |
listAccountsAsync(request, options)
listAccountsAsync(request?: protos.google.analytics.admin.v1beta.IListAccountsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IAccount>;
Equivalent to listAccounts
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IAccount> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
*/
/**
* The maximum number of resources to return. The service may return
* fewer than this value, even if there are additional pages.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200; (higher values will be coerced to the maximum)
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListAccounts` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAccounts` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Whether to include soft-deleted (ie: "trashed") Accounts in the
* results. Accounts can be inspected to determine whether they are deleted or
* not.
*/
// const showDeleted = true
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAccounts() {
// Construct request
const request = {
};
// Run request
const iterable = await adminClient.listAccountsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAccounts();
listAccountsStream(request, options)
listAccountsStream(request?: protos.google.analytics.admin.v1beta.IListAccountsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listAccountsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listAccountSummaries(request, options)
listAccountSummaries(request?: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IAccountSummary[],
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest | null,
protos.google.analytics.admin.v1beta.IListAccountSummariesResponse
]>;
Returns summaries of all accounts accessible by the caller.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IAccountSummary[],
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest | null,
protos.google.analytics.admin.v1beta.IListAccountSummariesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAccountSummariesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listAccountSummaries(request, options, callback)
listAccountSummaries(request: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>
|
Returns |
---|
Type | Description |
void | |
listAccountSummaries(request, callback)
listAccountSummaries(request: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>
|
Returns |
---|
Type | Description |
void | |
listAccountSummariesAsync(request, options)
listAccountSummariesAsync(request?: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IAccountSummary>;
Equivalent to listAccountSummaries
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IAccountSummary> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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.
*/
/**
* The maximum number of AccountSummary resources to return. The service may
* return fewer than this value, even if there are additional pages.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200; (higher values will be coerced to the maximum)
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListAccountSummaries` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAccountSummaries`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAccountSummaries() {
// Construct request
const request = {
};
// Run request
const iterable = await adminClient.listAccountSummariesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAccountSummaries();
listAccountSummariesStream(request, options)
listAccountSummariesStream(request?: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListAccountSummariesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listAccountSummariesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listConversionEvents(request, options)
listConversionEvents(request?: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IConversionEvent[],
protos.google.analytics.admin.v1beta.IListConversionEventsRequest | null,
protos.google.analytics.admin.v1beta.IListConversionEventsResponse
]>;
Returns a list of conversion events in the specified parent property.
Returns an empty list if no conversion events are found.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListConversionEventsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IConversionEvent[],
protos.google.analytics.admin.v1beta.IListConversionEventsRequest | null,
protos.google.analytics.admin.v1beta.IListConversionEventsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listConversionEventsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listConversionEvents(request, options, callback)
listConversionEvents(request: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListConversionEventsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>
|
Returns |
---|
Type | Description |
void | |
listConversionEvents(request, callback)
listConversionEvents(request: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListConversionEventsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>
|
Returns |
---|
Type | Description |
void | |
listConversionEventsAsync(request, options)
listConversionEventsAsync(request?: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IConversionEvent>;
Equivalent to listConversionEvents
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListConversionEventsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IConversionEvent> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. The resource name of the parent property.
* Example: 'properties/123'
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200; (higher values will be coerced to the maximum)
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListConversionEvents` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListConversionEvents`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListConversionEvents() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listConversionEventsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListConversionEvents();
listConversionEventsStream(request, options)
listConversionEventsStream(request?: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListConversionEventsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listConversionEventsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCustomDimensions(request, options)
listCustomDimensions(request?: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension[],
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest | null,
protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse
]>;
Lists CustomDimensions on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension[],
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest | null,
protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCustomDimensionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCustomDimensions(request, options, callback)
listCustomDimensions(request: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>
|
Returns |
---|
Type | Description |
void | |
listCustomDimensions(request, callback)
listCustomDimensions(request: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>
|
Returns |
---|
Type | Description |
void | |
listCustomDimensionsAsync(request, options)
listCustomDimensionsAsync(request?: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.ICustomDimension>;
Equivalent to listCustomDimensions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.ICustomDimension> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200 (higher values will be coerced to the maximum).
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListCustomDimensions` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListCustomDimensions`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListCustomDimensions() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listCustomDimensionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCustomDimensions();
listCustomDimensionsStream(request, options)
listCustomDimensionsStream(request?: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listCustomDimensionsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCustomMetrics(request, options)
listCustomMetrics(request?: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric[],
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest | null,
protos.google.analytics.admin.v1beta.IListCustomMetricsResponse
]>;
Lists CustomMetrics on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric[],
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest | null,
protos.google.analytics.admin.v1beta.IListCustomMetricsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCustomMetricsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listCustomMetrics(request, options, callback)
listCustomMetrics(request: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>
|
Returns |
---|
Type | Description |
void | |
listCustomMetrics(request, callback)
listCustomMetrics(request: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>
|
Returns |
---|
Type | Description |
void | |
listCustomMetricsAsync(request, options)
listCustomMetricsAsync(request?: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.ICustomMetric>;
Equivalent to listCustomMetrics
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.ICustomMetric> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200 (higher values will be coerced to the maximum).
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListCustomMetrics` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListCustomMetrics` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListCustomMetrics() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listCustomMetricsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCustomMetrics();
listCustomMetricsStream(request, options)
listCustomMetricsStream(request?: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListCustomMetricsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listCustomMetricsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listDataStreams(request, options)
listDataStreams(request?: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataStream[],
protos.google.analytics.admin.v1beta.IListDataStreamsRequest | null,
protos.google.analytics.admin.v1beta.IListDataStreamsResponse
]>;
Lists DataStreams on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListDataStreamsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataStream[],
protos.google.analytics.admin.v1beta.IListDataStreamsRequest | null,
protos.google.analytics.admin.v1beta.IListDataStreamsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDataStreamsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listDataStreams(request, options, callback)
listDataStreams(request: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListDataStreamsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>
|
Returns |
---|
Type | Description |
void | |
listDataStreams(request, callback)
listDataStreams(request: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListDataStreamsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>
|
Returns |
---|
Type | Description |
void | |
listDataStreamsAsync(request, options)
listDataStreamsAsync(request?: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IDataStream>;
Equivalent to listDataStreams
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListDataStreamsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IDataStream> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200 (higher values will be coerced to the maximum).
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListDataStreams` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListDataStreams` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListDataStreams() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listDataStreamsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDataStreams();
listDataStreamsStream(request, options)
listDataStreamsStream(request?: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListDataStreamsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listDataStreamsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listFirebaseLinks(request, options)
listFirebaseLinks(request?: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IFirebaseLink[],
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest | null,
protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse
]>;
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IFirebaseLink[],
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest | null,
protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listFirebaseLinksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listFirebaseLinks(request, options, callback)
listFirebaseLinks(request: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>
|
Returns |
---|
Type | Description |
void | |
listFirebaseLinks(request, callback)
listFirebaseLinks(request: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>
|
Returns |
---|
Type | Description |
void | |
listFirebaseLinksAsync(request, options)
listFirebaseLinksAsync(request?: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IFirebaseLink>;
Equivalent to listFirebaseLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IFirebaseLink> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. Format: properties/{property_id}
* Example: properties/1234
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return. The service may return
* fewer than this value, even if there are additional pages.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200; (higher values will be coerced to the maximum)
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListFirebaseLinks` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListProperties` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListFirebaseLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listFirebaseLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListFirebaseLinks();
listFirebaseLinksStream(request, options)
listFirebaseLinksStream(request?: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listFirebaseLinksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listGoogleAdsLinks(request, options)
listGoogleAdsLinks(request?: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IGoogleAdsLink[],
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest | null,
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse
]>;
Lists GoogleAdsLinks on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IGoogleAdsLink[],
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest | null,
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listGoogleAdsLinksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listGoogleAdsLinks(request, options, callback)
listGoogleAdsLinks(request: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>
|
Returns |
---|
Type | Description |
void | |
listGoogleAdsLinks(request, callback)
listGoogleAdsLinks(request: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>
|
Returns |
---|
Type | Description |
void | |
listGoogleAdsLinksAsync(request, options)
listGoogleAdsLinksAsync(request?: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IGoogleAdsLink>;
Equivalent to listGoogleAdsLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IGoogleAdsLink> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. Example format: properties/1234
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200 (higher values will be coerced to the maximum).
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListGoogleAdsLinks` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListGoogleAdsLinks` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListGoogleAdsLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listGoogleAdsLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListGoogleAdsLinks();
listGoogleAdsLinksStream(request, options)
listGoogleAdsLinksStream(request?: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listGoogleAdsLinksAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listMeasurementProtocolSecrets(request, options)
listMeasurementProtocolSecrets(request?: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret[],
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest | null,
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse
]>;
Returns child MeasurementProtocolSecrets under the specified parent Property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret[],
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest | null,
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listMeasurementProtocolSecretsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listMeasurementProtocolSecrets(request, options, callback)
listMeasurementProtocolSecrets(request: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>
|
Returns |
---|
Type | Description |
void | |
listMeasurementProtocolSecrets(request, callback)
listMeasurementProtocolSecrets(request: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>
|
Returns |
---|
Type | Description |
void | |
listMeasurementProtocolSecretsAsync(request, options)
listMeasurementProtocolSecretsAsync(request?: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>;
Equivalent to listMeasurementProtocolSecrets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. The resource name of the parent stream.
* Format:
* properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
*/
// const parent = 'abc123'
/**
* The maximum number of resources to return.
* If unspecified, at most 10 resources will be returned.
* The maximum value is 10. Higher values will be coerced to the maximum.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListMeasurementProtocolSecrets`
* call. Provide this to retrieve the subsequent page. When paginating, all
* other parameters provided to `ListMeasurementProtocolSecrets` must match
* the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListMeasurementProtocolSecrets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await adminClient.listMeasurementProtocolSecretsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListMeasurementProtocolSecrets();
listMeasurementProtocolSecretsStream(request, options)
listMeasurementProtocolSecretsStream(request?: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listMeasurementProtocolSecretsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProperties(request, options)
listProperties(request?: protos.google.analytics.admin.v1beta.IListPropertiesRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IProperty[],
protos.google.analytics.admin.v1beta.IListPropertiesRequest | null,
protos.google.analytics.admin.v1beta.IListPropertiesResponse
]>;
Returns child Properties under the specified parent Account.
Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListPropertiesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IProperty[],
protos.google.analytics.admin.v1beta.IListPropertiesRequest | null,
protos.google.analytics.admin.v1beta.IListPropertiesResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listPropertiesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
listProperties(request, options, callback)
listProperties(request: protos.google.analytics.admin.v1beta.IListPropertiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListPropertiesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>
|
Returns |
---|
Type | Description |
void | |
listProperties(request, callback)
listProperties(request: protos.google.analytics.admin.v1beta.IListPropertiesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListPropertiesRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>
|
Returns |
---|
Type | Description |
void | |
listPropertiesAsync(request, options)
listPropertiesAsync(request?: protos.google.analytics.admin.v1beta.IListPropertiesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IProperty>;
Equivalent to listProperties
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListPropertiesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IProperty> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. An expression for filtering the results of the request.
* Fields eligible for filtering are:
* `parent:`(The resource name of the parent account/property) or
* `ancestor:`(The resource name of the parent account) or
* `firebase_project:`(The id or number of the linked firebase project).
* Some examples of filters:
* ```
* | Filter | Description |
* |-----------------------------|-------------------------------------------|
* | parent:accounts/123 | The account with account id: 123. |
* | parent:properties/123 | The property with property id: 123. |
* | ancestor:accounts/123 | The account with account id: 123. |
* | firebase_project:project-id | The firebase project with id: project-id. |
* | firebase_project:123 | The firebase project with number: 123. |
* ```
*/
// const filter = 'abc123'
/**
* The maximum number of resources to return. The service may return
* fewer than this value, even if there are additional pages.
* If unspecified, at most 50 resources will be returned.
* The maximum value is 200; (higher values will be coerced to the maximum)
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListProperties` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListProperties` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* Whether to include soft-deleted (ie: "trashed") Properties in the
* results. Properties can be inspected to determine whether they are deleted
* or not.
*/
// const showDeleted = true
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListProperties() {
// Construct request
const request = {
filter,
};
// Run request
const iterable = await adminClient.listPropertiesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProperties();
listPropertiesStream(request, options)
listPropertiesStream(request?: protos.google.analytics.admin.v1beta.IListPropertiesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IListPropertiesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 listPropertiesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
matchAccountFromAccountName(accountName)
matchAccountFromAccountName(accountName: string): string | number;
Parse the account from Account resource.
Parameter |
---|
Name | Description |
accountName |
string
A fully-qualified path representing Account resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the account.
|
matchAccountFromDataSharingSettingsName(dataSharingSettingsName)
matchAccountFromDataSharingSettingsName(dataSharingSettingsName: string): string | number;
Parse the account from DataSharingSettings resource.
Parameter |
---|
Name | Description |
dataSharingSettingsName |
string
A fully-qualified path representing DataSharingSettings resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the account.
|
matchAccountSummaryFromAccountSummaryName(accountSummaryName)
matchAccountSummaryFromAccountSummaryName(accountSummaryName: string): string | number;
Parse the account_summary from AccountSummary resource.
Parameter |
---|
Name | Description |
accountSummaryName |
string
A fully-qualified path representing AccountSummary resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the account_summary.
|
matchConversionEventFromConversionEventName(conversionEventName)
matchConversionEventFromConversionEventName(conversionEventName: string): string | number;
Parse the conversion_event from ConversionEvent resource.
Parameter |
---|
Name | Description |
conversionEventName |
string
A fully-qualified path representing ConversionEvent resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the conversion_event.
|
matchCustomDimensionFromCustomDimensionName(customDimensionName)
matchCustomDimensionFromCustomDimensionName(customDimensionName: string): string | number;
Parse the custom_dimension from CustomDimension resource.
Parameter |
---|
Name | Description |
customDimensionName |
string
A fully-qualified path representing CustomDimension resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the custom_dimension.
|
matchCustomMetricFromCustomMetricName(customMetricName)
matchCustomMetricFromCustomMetricName(customMetricName: string): string | number;
Parse the custom_metric from CustomMetric resource.
Parameter |
---|
Name | Description |
customMetricName |
string
A fully-qualified path representing CustomMetric resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the custom_metric.
|
matchDataStreamFromDataStreamName(dataStreamName)
matchDataStreamFromDataStreamName(dataStreamName: string): string | number;
Parse the data_stream from DataStream resource.
Parameter |
---|
Name | Description |
dataStreamName |
string
A fully-qualified path representing DataStream resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the data_stream.
|
matchDataStreamFromMeasurementProtocolSecretName(measurementProtocolSecretName)
matchDataStreamFromMeasurementProtocolSecretName(measurementProtocolSecretName: string): string | number;
Parse the data_stream from MeasurementProtocolSecret resource.
Parameter |
---|
Name | Description |
measurementProtocolSecretName |
string
A fully-qualified path representing MeasurementProtocolSecret resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the data_stream.
|
matchFirebaseLinkFromFirebaseLinkName(firebaseLinkName)
matchFirebaseLinkFromFirebaseLinkName(firebaseLinkName: string): string | number;
Parse the firebase_link from FirebaseLink resource.
Parameter |
---|
Name | Description |
firebaseLinkName |
string
A fully-qualified path representing FirebaseLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the firebase_link.
|
matchGoogleAdsLinkFromGoogleAdsLinkName(googleAdsLinkName)
matchGoogleAdsLinkFromGoogleAdsLinkName(googleAdsLinkName: string): string | number;
Parse the google_ads_link from GoogleAdsLink resource.
Parameter |
---|
Name | Description |
googleAdsLinkName |
string
A fully-qualified path representing GoogleAdsLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the google_ads_link.
|
matchMeasurementProtocolSecretFromMeasurementProtocolSecretName(measurementProtocolSecretName)
matchMeasurementProtocolSecretFromMeasurementProtocolSecretName(measurementProtocolSecretName: string): string | number;
Parse the measurement_protocol_secret from MeasurementProtocolSecret resource.
Parameter |
---|
Name | Description |
measurementProtocolSecretName |
string
A fully-qualified path representing MeasurementProtocolSecret resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the measurement_protocol_secret.
|
matchPropertyFromConversionEventName(conversionEventName)
matchPropertyFromConversionEventName(conversionEventName: string): string | number;
Parse the property from ConversionEvent resource.
Parameter |
---|
Name | Description |
conversionEventName |
string
A fully-qualified path representing ConversionEvent resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromCustomDimensionName(customDimensionName)
matchPropertyFromCustomDimensionName(customDimensionName: string): string | number;
Parse the property from CustomDimension resource.
Parameter |
---|
Name | Description |
customDimensionName |
string
A fully-qualified path representing CustomDimension resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromCustomMetricName(customMetricName)
matchPropertyFromCustomMetricName(customMetricName: string): string | number;
Parse the property from CustomMetric resource.
Parameter |
---|
Name | Description |
customMetricName |
string
A fully-qualified path representing CustomMetric resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromDataRetentionSettingsName(dataRetentionSettingsName)
matchPropertyFromDataRetentionSettingsName(dataRetentionSettingsName: string): string | number;
Parse the property from DataRetentionSettings resource.
Parameter |
---|
Name | Description |
dataRetentionSettingsName |
string
A fully-qualified path representing DataRetentionSettings resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromDataStreamName(dataStreamName)
matchPropertyFromDataStreamName(dataStreamName: string): string | number;
Parse the property from DataStream resource.
Parameter |
---|
Name | Description |
dataStreamName |
string
A fully-qualified path representing DataStream resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromFirebaseLinkName(firebaseLinkName)
matchPropertyFromFirebaseLinkName(firebaseLinkName: string): string | number;
Parse the property from FirebaseLink resource.
Parameter |
---|
Name | Description |
firebaseLinkName |
string
A fully-qualified path representing FirebaseLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromGoogleAdsLinkName(googleAdsLinkName)
matchPropertyFromGoogleAdsLinkName(googleAdsLinkName: string): string | number;
Parse the property from GoogleAdsLink resource.
Parameter |
---|
Name | Description |
googleAdsLinkName |
string
A fully-qualified path representing GoogleAdsLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromMeasurementProtocolSecretName(measurementProtocolSecretName)
matchPropertyFromMeasurementProtocolSecretName(measurementProtocolSecretName: string): string | number;
Parse the property from MeasurementProtocolSecret resource.
Parameter |
---|
Name | Description |
measurementProtocolSecretName |
string
A fully-qualified path representing MeasurementProtocolSecret resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromPropertyName(propertyName)
matchPropertyFromPropertyName(propertyName: string): string | number;
Parse the property from Property resource.
Parameter |
---|
Name | Description |
propertyName |
string
A fully-qualified path representing Property resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
measurementProtocolSecretPath(property, dataStream, measurementProtocolSecret)
measurementProtocolSecretPath(property: string, dataStream: string, measurementProtocolSecret: string): string;
Return a fully-qualified measurementProtocolSecret resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
string
|
measurementProtocolSecret |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
propertyPath(property)
propertyPath(property: string): string;
Return a fully-qualified property resource name string.
Parameter |
---|
Name | Description |
property |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
provisionAccountTicket(request, options)
provisionAccountTicket(request?: protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse,
(protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | undefined),
{} | undefined
]>;
Requests a ticket for creating an account.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse,
(protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* The account to create.
*/
// const account = {}
/**
* Redirect URI where the user will be sent after accepting Terms of Service.
* Must be configured in Developers Console as a Redirect URI
*/
// const redirectUri = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callProvisionAccountTicket() {
// Construct request
const request = {
};
// Run request
const response = await adminClient.provisionAccountTicket(request);
console.log(response);
}
callProvisionAccountTicket();
provisionAccountTicket(request, options, callback)
provisionAccountTicket(request: protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
provisionAccountTicket(request, callback)
provisionAccountTicket(request: protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
searchChangeHistoryEvents(request, options)
searchChangeHistoryEvents(request?: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IChangeHistoryEvent[],
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest | null,
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse
]>;
Searches through all changes to an account or its children given the specified set of filters.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IChangeHistoryEvent[],
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest | null,
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using searchChangeHistoryEventsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
searchChangeHistoryEvents(request, options, callback)
searchChangeHistoryEvents(request: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>
|
Returns |
---|
Type | Description |
void | |
searchChangeHistoryEvents(request, callback)
searchChangeHistoryEvents(request: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest
|
callback |
PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>
|
Returns |
---|
Type | Description |
void | |
searchChangeHistoryEventsAsync(request, options)
searchChangeHistoryEventsAsync(request?: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IChangeHistoryEvent>;
Equivalent to searchChangeHistoryEvents
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1beta.IChangeHistoryEvent> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. The account resource for which to return change history resources.
*/
// const account = 'abc123'
/**
* Optional. Resource name for a child property. If set, only return changes
* made to this property or its child resources.
*/
// const property = 'abc123'
/**
* Optional. If set, only return changes if they are for a resource that matches at
* least one of these types.
*/
// const resourceType = 1234
/**
* Optional. If set, only return changes that match one or more of these types of
* actions.
*/
// const action = 1234
/**
* Optional. If set, only return changes if they are made by a user in this list.
*/
// const actorEmail = 'abc123'
/**
* Optional. If set, only return changes made after this time (inclusive).
*/
// const earliestChangeTime = {}
/**
* Optional. If set, only return changes made before this time (inclusive).
*/
// const latestChangeTime = {}
/**
* Optional. The maximum number of ChangeHistoryEvent items to return.
* The service may return fewer than this value, even if there are additional
* pages. If unspecified, at most 50 items will be returned.
* The maximum value is 200 (higher values will be coerced to the maximum).
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `SearchChangeHistoryEvents` call.
* Provide this to retrieve the subsequent page. When paginating, all other
* parameters provided to `SearchChangeHistoryEvents` must match the call that
* provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callSearchChangeHistoryEvents() {
// Construct request
const request = {
account,
};
// Run request
const iterable = await adminClient.searchChangeHistoryEventsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callSearchChangeHistoryEvents();
searchChangeHistoryEventsStream(request, options)
searchChangeHistoryEventsStream(request?: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 searchChangeHistoryEventsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
updateAccount(request, options)
updateAccount(request?: protos.google.analytics.admin.v1beta.IUpdateAccountRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IAccount,
protos.google.analytics.admin.v1beta.IUpdateAccountRequest | undefined,
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateAccountRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IAccount,
protos.google.analytics.admin.v1beta.IUpdateAccountRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The account to update.
* The account's `name` field is used to identify the account.
*/
// const account = {}
/**
* Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace
* the entire entity, use one path with the string "*" to match all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateAccount() {
// Construct request
const request = {
account,
updateMask,
};
// Run request
const response = await adminClient.updateAccount(request);
console.log(response);
}
callUpdateAccount();
updateAccount(request, options, callback)
updateAccount(request: protos.google.analytics.admin.v1beta.IUpdateAccountRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateAccountRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateAccount(request, callback)
updateAccount(request: protos.google.analytics.admin.v1beta.IUpdateAccountRequest, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateAccountRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateCustomDimension(request, options)
updateCustomDimension(request?: protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension,
(protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | undefined),
{} | undefined
]>;
Updates a CustomDimension on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomDimension,
(protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* The CustomDimension to update
*/
// const customDimension = {}
/**
* Required. The list of fields to be updated. Omitted fields will not be updated.
* To replace the entire entity, use one path with the string "*" to match
* all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateCustomDimension() {
// Construct request
const request = {
updateMask,
};
// Run request
const response = await adminClient.updateCustomDimension(request);
console.log(response);
}
callUpdateCustomDimension();
updateCustomDimension(request, options, callback)
updateCustomDimension(request: protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateCustomDimension(request, callback)
updateCustomDimension(request: protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateCustomMetric(request, options)
updateCustomMetric(request?: protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric,
(protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | undefined),
{} | undefined
]>;
Updates a CustomMetric on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.ICustomMetric,
(protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* The CustomMetric to update
*/
// const customMetric = {}
/**
* Required. The list of fields to be updated. Omitted fields will not be updated.
* To replace the entire entity, use one path with the string "*" to match
* all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateCustomMetric() {
// Construct request
const request = {
updateMask,
};
// Run request
const response = await adminClient.updateCustomMetric(request);
console.log(response);
}
callUpdateCustomMetric();
updateCustomMetric(request, options, callback)
updateCustomMetric(request: protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateCustomMetric(request, callback)
updateCustomMetric(request: protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateDataRetentionSettings(request, options)
updateDataRetentionSettings(request?: protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataRetentionSettings,
(protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | undefined),
{} | undefined
]>;
Updates the singleton data retention settings for this property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataRetentionSettings,
(protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The settings to update.
* The `name` field is used to identify the settings to be updated.
*/
// const dataRetentionSettings = {}
/**
* Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace
* the entire entity, use one path with the string "*" to match all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateDataRetentionSettings() {
// Construct request
const request = {
dataRetentionSettings,
updateMask,
};
// Run request
const response = await adminClient.updateDataRetentionSettings(request);
console.log(response);
}
callUpdateDataRetentionSettings();
updateDataRetentionSettings(request, options, callback)
updateDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateDataRetentionSettings(request, callback)
updateDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateDataStream(request, options)
updateDataStream(request?: protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IDataStream,
protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | undefined,
{} | undefined
]>;
Updates a DataStream on a property.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IDataStream,
protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* The DataStream to update
*/
// const dataStream = {}
/**
* Required. The list of fields to be updated. Omitted fields will not be updated.
* To replace the entire entity, use one path with the string "*" to match
* all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateDataStream() {
// Construct request
const request = {
updateMask,
};
// Run request
const response = await adminClient.updateDataStream(request);
console.log(response);
}
callUpdateDataStream();
updateDataStream(request, options, callback)
updateDataStream(request: protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateDataStream(request, callback)
updateDataStream(request: protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateGoogleAdsLink(request, options)
updateGoogleAdsLink(request?: protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IGoogleAdsLink,
(protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | undefined),
{} | undefined
]>;
Updates a GoogleAdsLink on a property
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IGoogleAdsLink,
(protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* The GoogleAdsLink to update
*/
// const googleAdsLink = {}
/**
* Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace
* the entire entity, use one path with the string "*" to match all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateGoogleAdsLink() {
// Construct request
const request = {
updateMask,
};
// Run request
const response = await adminClient.updateGoogleAdsLink(request);
console.log(response);
}
callUpdateGoogleAdsLink();
updateGoogleAdsLink(request, options, callback)
updateGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateGoogleAdsLink(request, callback)
updateGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateMeasurementProtocolSecret(request, options)
updateMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Updates a measurement protocol secret.
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The measurement protocol secret to update.
*/
// const measurementProtocolSecret = {}
/**
* The list of fields to be updated. Omitted fields will not be updated.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateMeasurementProtocolSecret() {
// Construct request
const request = {
measurementProtocolSecret,
};
// Run request
const response = await adminClient.updateMeasurementProtocolSecret(request);
console.log(response);
}
callUpdateMeasurementProtocolSecret();
updateMeasurementProtocolSecret(request, options, callback)
updateMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateMeasurementProtocolSecret(request, callback)
updateMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateProperty(request, options)
updateProperty(request?: protos.google.analytics.admin.v1beta.IUpdatePropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | undefined,
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdatePropertyRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
Promise<[
protos.google.analytics.admin.v1beta.IProperty,
protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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. The property to update.
* The property's `name` field is used to identify the property to be
* updated.
*/
// const property = {}
/**
* Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace
* the entire entity, use one path with the string "*" to match all fields.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateProperty() {
// Construct request
const request = {
property,
updateMask,
};
// Run request
const response = await adminClient.updateProperty(request);
console.log(response);
}
callUpdateProperty();
updateProperty(request, options, callback)
updateProperty(request: protos.google.analytics.admin.v1beta.IUpdatePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdatePropertyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |
updateProperty(request, callback)
updateProperty(request: protos.google.analytics.admin.v1beta.IUpdatePropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters |
---|
Name | Description |
request |
protos.google.analytics.admin.v1beta.IUpdatePropertyRequest
|
callback |
Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>
|
Returns |
---|
Type | Description |
void | |