Service Interface for the Analytics Admin API (GA4). v1alpha
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 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: true}, gax); ```
|
Properties
analyticsAdminServiceStub
analyticsAdminServiceStub?: Promise<{
[name: string]: Function;
}>;
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
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.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
accountAccessBindingPath(account, accessBinding)
accountAccessBindingPath(account: string, accessBinding: string): string;
Return a fully-qualified accountAccessBinding resource name string.
Parameters |
---|
Name | Description |
account |
string
|
accessBinding |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
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.v1alpha.IAcknowledgeUserDataCollectionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAcknowledgeUserDataCollectionResponse,
(protos.google.analytics.admin.v1alpha.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 through this API) before MeasurementProtocolSecret resources may be created.
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-analytics/admin').v1alpha;
// 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.v1alpha.IAcknowledgeUserDataCollectionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1alpha.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
acknowledgeUserDataCollection(request, callback)
acknowledgeUserDataCollection(request: protos.google.analytics.admin.v1alpha.IAcknowledgeUserDataCollectionRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1alpha.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
adSenseLinkPath(property, adsenseLink)
adSenseLinkPath(property: string, adsenseLink: string): string;
Return a fully-qualified adSenseLink resource name string.
Parameters |
---|
Name | Description |
property |
string
|
adsenseLink |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
approveDisplayVideo360AdvertiserLinkProposal(request, options)
approveDisplayVideo360AdvertiserLinkProposal(request?: protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalResponse,
(protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalRequest | undefined),
{} | undefined
]>;
Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.
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 DisplayVideo360AdvertiserLinkProposal to approve.
* Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callApproveDisplayVideo360AdvertiserLinkProposal() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.approveDisplayVideo360AdvertiserLinkProposal(request);
console.log(response);
}
callApproveDisplayVideo360AdvertiserLinkProposal();
approveDisplayVideo360AdvertiserLinkProposal(request, options, callback)
approveDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalResponse, protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
approveDisplayVideo360AdvertiserLinkProposal(request, callback)
approveDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalResponse, protos.google.analytics.admin.v1alpha.IApproveDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
archiveAudience(request, options)
archiveAudience(request?: protos.google.analytics.admin.v1alpha.IArchiveAudienceRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.analytics.admin.v1alpha.IArchiveAudienceRequest | undefined,
{} | undefined
]>;
Archives an Audience on a property.
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/audiences/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callArchiveAudience() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.archiveAudience(request);
console.log(response);
}
callArchiveAudience();
archiveAudience(request, options, callback)
archiveAudience(request: protos.google.analytics.admin.v1alpha.IArchiveAudienceRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IArchiveAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
archiveAudience(request, callback)
archiveAudience(request: protos.google.analytics.admin.v1alpha.IArchiveAudienceRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IArchiveAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
archiveCustomDimension(request, options)
archiveCustomDimension(request?: protos.google.analytics.admin.v1alpha.IArchiveCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IArchiveCustomDimensionRequest | undefined),
{} | undefined
]>;
Archives a CustomDimension on a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IArchiveCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
archiveCustomDimension(request, callback)
archiveCustomDimension(request: protos.google.analytics.admin.v1alpha.IArchiveCustomDimensionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
archiveCustomMetric(request, options)
archiveCustomMetric(request?: protos.google.analytics.admin.v1alpha.IArchiveCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IArchiveCustomMetricRequest | undefined),
{} | undefined
]>;
Archives a CustomMetric on a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IArchiveCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
archiveCustomMetric(request, callback)
archiveCustomMetric(request: protos.google.analytics.admin.v1alpha.IArchiveCustomMetricRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
attributionSettingsPath(property)
attributionSettingsPath(property: string): string;
Return a fully-qualified attributionSettings resource name string.
Parameter |
---|
Name | Description |
property |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
audiencePath(property, audience)
audiencePath(property: string, audience: string): string;
Return a fully-qualified audience resource name string.
Parameters |
---|
Name | Description |
property |
string
|
audience |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
batchCreateAccessBindings(request, options)
batchCreateAccessBindings(request?: protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsResponse,
(protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsRequest | undefined),
{} | undefined
]>;
Creates information about multiple access bindings to an account or property.
This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created.
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 or property that owns the access bindings. The parent
* field in the CreateAccessBindingRequest messages must either be empty or
* match this field. Formats:
* - accounts/{account}
* - properties/{property}
*/
// const parent = 'abc123'
/**
* Required. The requests specifying the access bindings to create.
* A maximum of 1000 access bindings can be created in a batch.
*/
// const requests = [1,2,3,4]
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callBatchCreateAccessBindings() {
// Construct request
const request = {
parent,
requests,
};
// Run request
const response = await adminClient.batchCreateAccessBindings(request);
console.log(response);
}
callBatchCreateAccessBindings();
batchCreateAccessBindings(request, options, callback)
batchCreateAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsResponse, protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchCreateAccessBindings(request, callback)
batchCreateAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsResponse, protos.google.analytics.admin.v1alpha.IBatchCreateAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchDeleteAccessBindings(request, options)
batchDeleteAccessBindings(request?: protos.google.analytics.admin.v1alpha.IBatchDeleteAccessBindingsRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IBatchDeleteAccessBindingsRequest | undefined),
{} | undefined
]>;
Deletes information about multiple users' links to an account or property.
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 or property that owns the access bindings. The parent
* of all provided values for the 'names' field in DeleteAccessBindingRequest
* messages must match this field. Formats:
* - accounts/{account}
* - properties/{property}
*/
// const parent = 'abc123'
/**
* Required. The requests specifying the access bindings to delete.
* A maximum of 1000 access bindings can be deleted in a batch.
*/
// const requests = [1,2,3,4]
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callBatchDeleteAccessBindings() {
// Construct request
const request = {
parent,
requests,
};
// Run request
const response = await adminClient.batchDeleteAccessBindings(request);
console.log(response);
}
callBatchDeleteAccessBindings();
batchDeleteAccessBindings(request, options, callback)
batchDeleteAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchDeleteAccessBindingsRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IBatchDeleteAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchDeleteAccessBindings(request, callback)
batchDeleteAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchDeleteAccessBindingsRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IBatchDeleteAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchGetAccessBindings(request, options)
batchGetAccessBindings(request?: protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsResponse,
(protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsRequest | undefined),
{} | undefined
]>;
Gets information about multiple access bindings to an account or property.
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 or property that owns the access bindings. The parent
* of all provided values for the 'names' field must match this field.
* Formats:
* - accounts/{account}
* - properties/{property}
*/
// const parent = 'abc123'
/**
* Required. The names of the access bindings to retrieve.
* A maximum of 1000 access bindings can be retrieved in a batch.
* Formats:
* - accounts/{account}/accessBindings/{accessBinding}
* - properties/{property}/accessBindings/{accessBinding}
*/
// const names = ['abc','def']
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callBatchGetAccessBindings() {
// Construct request
const request = {
parent,
names,
};
// Run request
const response = await adminClient.batchGetAccessBindings(request);
console.log(response);
}
callBatchGetAccessBindings();
batchGetAccessBindings(request, options, callback)
batchGetAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsResponse, protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchGetAccessBindings(request, callback)
batchGetAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsResponse, protos.google.analytics.admin.v1alpha.IBatchGetAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchUpdateAccessBindings(request, options)
batchUpdateAccessBindings(request?: protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsResponse,
(protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsRequest | undefined),
{} | undefined
]>;
Updates information about multiple access bindings to an account or property.
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 or property that owns the access bindings. The parent
* of all provided AccessBinding in UpdateAccessBindingRequest messages must
* match this field.
* Formats:
* - accounts/{account}
* - properties/{property}
*/
// const parent = 'abc123'
/**
* Required. The requests specifying the access bindings to update.
* A maximum of 1000 access bindings can be updated in a batch.
*/
// const requests = [1,2,3,4]
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callBatchUpdateAccessBindings() {
// Construct request
const request = {
parent,
requests,
};
// Run request
const response = await adminClient.batchUpdateAccessBindings(request);
console.log(response);
}
callBatchUpdateAccessBindings();
batchUpdateAccessBindings(request, options, callback)
batchUpdateAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsResponse, protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
batchUpdateAccessBindings(request, callback)
batchUpdateAccessBindings(request: protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsResponse, protos.google.analytics.admin.v1alpha.IBatchUpdateAccessBindingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
bigQueryLinkPath(property, bigqueryLink)
bigQueryLinkPath(property: string, bigqueryLink: string): string;
Return a fully-qualified bigQueryLink resource name string.
Parameters |
---|
Name | Description |
property |
string
|
bigqueryLink |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
calculatedMetricPath(property, calculatedMetric)
calculatedMetricPath(property: string, calculatedMetric: string): string;
Return a fully-qualified calculatedMetric resource name string.
Parameters |
---|
Name | Description |
property |
string
|
calculatedMetric |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
cancelDisplayVideo360AdvertiserLinkProposal(request, options)
cancelDisplayVideo360AdvertiserLinkProposal(request?: protos.google.analytics.admin.v1alpha.ICancelDisplayVideo360AdvertiserLinkProposalRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal,
(protos.google.analytics.admin.v1alpha.ICancelDisplayVideo360AdvertiserLinkProposalRequest | undefined),
{} | undefined
]>;
Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.
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 DisplayVideo360AdvertiserLinkProposal to cancel.
* Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCancelDisplayVideo360AdvertiserLinkProposal() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.cancelDisplayVideo360AdvertiserLinkProposal(request);
console.log(response);
}
callCancelDisplayVideo360AdvertiserLinkProposal();
cancelDisplayVideo360AdvertiserLinkProposal(request, options, callback)
cancelDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.ICancelDisplayVideo360AdvertiserLinkProposalRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal, protos.google.analytics.admin.v1alpha.ICancelDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
cancelDisplayVideo360AdvertiserLinkProposal(request, callback)
cancelDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.ICancelDisplayVideo360AdvertiserLinkProposalRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal, protos.google.analytics.admin.v1alpha.ICancelDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
channelGroupPath(property, channelGroup)
channelGroupPath(property: string, channelGroup: string): string;
Return a fully-qualified channelGroup resource name string.
Parameters |
---|
Name | Description |
property |
string
|
channelGroup |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
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.
|
createAccessBinding(request, options)
createAccessBinding(request?: protos.google.analytics.admin.v1alpha.ICreateAccessBindingRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccessBinding,
(protos.google.analytics.admin.v1alpha.ICreateAccessBindingRequest | undefined),
{} | undefined
]>;
Creates an access binding on an account or property.
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. Formats:
* - accounts/{account}
* - properties/{property}
*/
// const parent = 'abc123'
/**
* Required. The access binding to create.
*/
// const accessBinding = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateAccessBinding() {
// Construct request
const request = {
parent,
accessBinding,
};
// Run request
const response = await adminClient.createAccessBinding(request);
console.log(response);
}
callCreateAccessBinding();
createAccessBinding(request, options, callback)
createAccessBinding(request: protos.google.analytics.admin.v1alpha.ICreateAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAccessBinding, protos.google.analytics.admin.v1alpha.ICreateAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createAccessBinding(request, callback)
createAccessBinding(request: protos.google.analytics.admin.v1alpha.ICreateAccessBindingRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAccessBinding, protos.google.analytics.admin.v1alpha.ICreateAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createAdSenseLink(request, options)
createAdSenseLink(request?: protos.google.analytics.admin.v1alpha.ICreateAdSenseLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAdSenseLink,
(protos.google.analytics.admin.v1alpha.ICreateAdSenseLinkRequest | undefined),
{} | undefined
]>;
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 create an AdSense Link.
* Format: properties/{propertyId}
* Example: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The AdSense Link to create
*/
// const adsenseLink = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateAdSenseLink() {
// Construct request
const request = {
parent,
adsenseLink,
};
// Run request
const response = await adminClient.createAdSenseLink(request);
console.log(response);
}
callCreateAdSenseLink();
createAdSenseLink(request, options, callback)
createAdSenseLink(request: protos.google.analytics.admin.v1alpha.ICreateAdSenseLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAdSenseLink, protos.google.analytics.admin.v1alpha.ICreateAdSenseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createAdSenseLink(request, callback)
createAdSenseLink(request: protos.google.analytics.admin.v1alpha.ICreateAdSenseLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAdSenseLink, protos.google.analytics.admin.v1alpha.ICreateAdSenseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createAudience(request, options)
createAudience(request?: protos.google.analytics.admin.v1alpha.ICreateAudienceRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAudience,
protos.google.analytics.admin.v1alpha.ICreateAudienceRequest | undefined,
{} | undefined
]>;
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 audience to create.
*/
// const audience = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateAudience() {
// Construct request
const request = {
parent,
audience,
};
// Run request
const response = await adminClient.createAudience(request);
console.log(response);
}
callCreateAudience();
createAudience(request, options, callback)
createAudience(request: protos.google.analytics.admin.v1alpha.ICreateAudienceRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAudience, protos.google.analytics.admin.v1alpha.ICreateAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createAudience(request, callback)
createAudience(request: protos.google.analytics.admin.v1alpha.ICreateAudienceRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAudience, protos.google.analytics.admin.v1alpha.ICreateAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCalculatedMetric(request, options)
createCalculatedMetric(request?: protos.google.analytics.admin.v1alpha.ICreateCalculatedMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICalculatedMetric,
(protos.google.analytics.admin.v1alpha.ICreateCalculatedMetricRequest | undefined),
{} | undefined
]>;
Creates a CalculatedMetric.
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 ID to use for the calculated metric which will become the
* final component of the calculated metric's resource name.
* This value should be 1-80 characters and valid characters are
* /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique
* between all calculated metrics under a property. The calculated_metric_id
* is used when referencing this calculated metric from external APIs, for
* example, "calcMetric:{calculated_metric_id}".
*/
// const calculatedMetricId = 'abc123'
/**
* Required. The CalculatedMetric to create.
*/
// const calculatedMetric = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateCalculatedMetric() {
// Construct request
const request = {
parent,
calculatedMetricId,
calculatedMetric,
};
// Run request
const response = await adminClient.createCalculatedMetric(request);
console.log(response);
}
callCreateCalculatedMetric();
createCalculatedMetric(request, options, callback)
createCalculatedMetric(request: protos.google.analytics.admin.v1alpha.ICreateCalculatedMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICalculatedMetric, protos.google.analytics.admin.v1alpha.ICreateCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCalculatedMetric(request, callback)
createCalculatedMetric(request: protos.google.analytics.admin.v1alpha.ICreateCalculatedMetricRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICalculatedMetric, protos.google.analytics.admin.v1alpha.ICreateCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createChannelGroup(request, options)
createChannelGroup(request?: protos.google.analytics.admin.v1alpha.ICreateChannelGroupRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IChannelGroup,
(protos.google.analytics.admin.v1alpha.ICreateChannelGroupRequest | undefined),
{} | undefined
]>;
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 create a ChannelGroup.
* Example format: properties/1234
*/
// const parent = 'abc123'
/**
* Required. The ChannelGroup to create.
*/
// const channelGroup = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateChannelGroup() {
// Construct request
const request = {
parent,
channelGroup,
};
// Run request
const response = await adminClient.createChannelGroup(request);
console.log(response);
}
callCreateChannelGroup();
createChannelGroup(request, options, callback)
createChannelGroup(request: protos.google.analytics.admin.v1alpha.ICreateChannelGroupRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IChannelGroup, protos.google.analytics.admin.v1alpha.ICreateChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createChannelGroup(request, callback)
createChannelGroup(request: protos.google.analytics.admin.v1alpha.ICreateChannelGroupRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IChannelGroup, protos.google.analytics.admin.v1alpha.ICreateChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createConnectedSiteTag(request, options)
createConnectedSiteTag(request?: protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagResponse,
(protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagRequest | undefined),
{} | undefined
]>;
Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.
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 Universal Analytics property to create connected site tags for.
* This API does not support GA4 properties.
* Format: properties/{universalAnalyticsPropertyId}
* Example: properties/1234
*/
// const property = 'abc123'
/**
* Required. The tag to add to the Universal Analytics property
*/
// const connectedSiteTag = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateConnectedSiteTag() {
// Construct request
const request = {
connectedSiteTag,
};
// Run request
const response = await adminClient.createConnectedSiteTag(request);
console.log(response);
}
callCreateConnectedSiteTag();
createConnectedSiteTag(request, options, callback)
createConnectedSiteTag(request: protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagResponse, protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createConnectedSiteTag(request, callback)
createConnectedSiteTag(request: protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagResponse, protos.google.analytics.admin.v1alpha.ICreateConnectedSiteTagRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createConversionEvent(request, options)
createConversionEvent(request?: protos.google.analytics.admin.v1alpha.ICreateConversionEventRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IConversionEvent,
(protos.google.analytics.admin.v1alpha.ICreateConversionEventRequest | undefined),
{} | undefined
]>;
Creates a conversion event with the specified attributes.
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IConversionEvent, protos.google.analytics.admin.v1alpha.ICreateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createConversionEvent(request, callback)
createConversionEvent(request: protos.google.analytics.admin.v1alpha.ICreateConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IConversionEvent, protos.google.analytics.admin.v1alpha.ICreateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCustomDimension(request, options)
createCustomDimension(request?: protos.google.analytics.admin.v1alpha.ICreateCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomDimension,
(protos.google.analytics.admin.v1alpha.ICreateCustomDimensionRequest | undefined),
{} | undefined
]>;
Creates a CustomDimension.
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomDimension, protos.google.analytics.admin.v1alpha.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCustomDimension(request, callback)
createCustomDimension(request: protos.google.analytics.admin.v1alpha.ICreateCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomDimension, protos.google.analytics.admin.v1alpha.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCustomMetric(request, options)
createCustomMetric(request?: protos.google.analytics.admin.v1alpha.ICreateCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomMetric,
(protos.google.analytics.admin.v1alpha.ICreateCustomMetricRequest | undefined),
{} | undefined
]>;
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomMetric, protos.google.analytics.admin.v1alpha.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createCustomMetric(request, callback)
createCustomMetric(request: protos.google.analytics.admin.v1alpha.ICreateCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomMetric, protos.google.analytics.admin.v1alpha.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createDataStream(request, options)
createDataStream(request?: protos.google.analytics.admin.v1alpha.ICreateDataStreamRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataStream,
(protos.google.analytics.admin.v1alpha.ICreateDataStreamRequest | undefined),
{} | undefined
]>;
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataStream, protos.google.analytics.admin.v1alpha.ICreateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createDataStream(request, callback)
createDataStream(request: protos.google.analytics.admin.v1alpha.ICreateDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataStream, protos.google.analytics.admin.v1alpha.ICreateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createDisplayVideo360AdvertiserLink(request, options)
createDisplayVideo360AdvertiserLink(request?: protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink,
(protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkRequest | undefined),
{} | undefined
]>;
Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.
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 DisplayVideo360AdvertiserLink to create.
*/
// const displayVideo_360AdvertiserLink = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateDisplayVideo360AdvertiserLink() {
// Construct request
const request = {
parent,
displayVideo_360AdvertiserLink,
};
// Run request
const response = await adminClient.createDisplayVideo360AdvertiserLink(request);
console.log(response);
}
callCreateDisplayVideo360AdvertiserLink();
createDisplayVideo360AdvertiserLink(request, options, callback)
createDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink, protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createDisplayVideo360AdvertiserLink(request, callback)
createDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink, protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createDisplayVideo360AdvertiserLinkProposal(request, options)
createDisplayVideo360AdvertiserLinkProposal(request?: protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkProposalRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal,
(protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkProposalRequest | undefined),
{} | undefined
]>;
Creates a DisplayVideo360AdvertiserLinkProposal.
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 DisplayVideo360AdvertiserLinkProposal to create.
*/
// const displayVideo_360AdvertiserLinkProposal = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateDisplayVideo360AdvertiserLinkProposal() {
// Construct request
const request = {
parent,
displayVideo_360AdvertiserLinkProposal,
};
// Run request
const response = await adminClient.createDisplayVideo360AdvertiserLinkProposal(request);
console.log(response);
}
callCreateDisplayVideo360AdvertiserLinkProposal();
createDisplayVideo360AdvertiserLinkProposal(request, options, callback)
createDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkProposalRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal, protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createDisplayVideo360AdvertiserLinkProposal(request, callback)
createDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkProposalRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal, protos.google.analytics.admin.v1alpha.ICreateDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createEventCreateRule(request, options)
createEventCreateRule(request?: protos.google.analytics.admin.v1alpha.ICreateEventCreateRuleRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IEventCreateRule,
(protos.google.analytics.admin.v1alpha.ICreateEventCreateRuleRequest | undefined),
{} | undefined
]>;
Creates an EventCreateRule.
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/123/dataStreams/456
*/
// const parent = 'abc123'
/**
* Required. The EventCreateRule to create.
*/
// const eventCreateRule = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateEventCreateRule() {
// Construct request
const request = {
parent,
eventCreateRule,
};
// Run request
const response = await adminClient.createEventCreateRule(request);
console.log(response);
}
callCreateEventCreateRule();
createEventCreateRule(request, options, callback)
createEventCreateRule(request: protos.google.analytics.admin.v1alpha.ICreateEventCreateRuleRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IEventCreateRule, protos.google.analytics.admin.v1alpha.ICreateEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createEventCreateRule(request, callback)
createEventCreateRule(request: protos.google.analytics.admin.v1alpha.ICreateEventCreateRuleRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IEventCreateRule, protos.google.analytics.admin.v1alpha.ICreateEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createExpandedDataSet(request, options)
createExpandedDataSet(request?: protos.google.analytics.admin.v1alpha.ICreateExpandedDataSetRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IExpandedDataSet,
(protos.google.analytics.admin.v1alpha.ICreateExpandedDataSetRequest | undefined),
{} | undefined
]>;
Creates a ExpandedDataSet.
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 ExpandedDataSet to create.
*/
// const expandedDataSet = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateExpandedDataSet() {
// Construct request
const request = {
parent,
expandedDataSet,
};
// Run request
const response = await adminClient.createExpandedDataSet(request);
console.log(response);
}
callCreateExpandedDataSet();
createExpandedDataSet(request, options, callback)
createExpandedDataSet(request: protos.google.analytics.admin.v1alpha.ICreateExpandedDataSetRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IExpandedDataSet, protos.google.analytics.admin.v1alpha.ICreateExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createExpandedDataSet(request, callback)
createExpandedDataSet(request: protos.google.analytics.admin.v1alpha.ICreateExpandedDataSetRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IExpandedDataSet, protos.google.analytics.admin.v1alpha.ICreateExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createFirebaseLink(request, options)
createFirebaseLink(request?: protos.google.analytics.admin.v1alpha.ICreateFirebaseLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IFirebaseLink,
(protos.google.analytics.admin.v1alpha.ICreateFirebaseLinkRequest | undefined),
{} | undefined
]>;
Creates a FirebaseLink.
Properties can have at most one FirebaseLink.
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateFirebaseLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IFirebaseLink, protos.google.analytics.admin.v1alpha.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createFirebaseLink(request, callback)
createFirebaseLink(request: protos.google.analytics.admin.v1alpha.ICreateFirebaseLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IFirebaseLink, protos.google.analytics.admin.v1alpha.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createGoogleAdsLink(request, options)
createGoogleAdsLink(request?: protos.google.analytics.admin.v1alpha.ICreateGoogleAdsLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IGoogleAdsLink,
(protos.google.analytics.admin.v1alpha.ICreateGoogleAdsLinkRequest | undefined),
{} | undefined
]>;
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleAdsLink, protos.google.analytics.admin.v1alpha.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createGoogleAdsLink(request, callback)
createGoogleAdsLink(request: protos.google.analytics.admin.v1alpha.ICreateGoogleAdsLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleAdsLink, protos.google.analytics.admin.v1alpha.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createMeasurementProtocolSecret(request, options)
createMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1alpha.ICreateMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1alpha.ICreateMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Creates a measurement protocol secret.
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreateMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret, protos.google.analytics.admin.v1alpha.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createMeasurementProtocolSecret(request, callback)
createMeasurementProtocolSecret(request: protos.google.analytics.admin.v1alpha.ICreateMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret, protos.google.analytics.admin.v1alpha.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createProperty(request, options)
createProperty(request?: protos.google.analytics.admin.v1alpha.ICreatePropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IProperty,
protos.google.analytics.admin.v1alpha.ICreatePropertyRequest | undefined,
{} | undefined
]>;
Creates an "GA4" property with the specified location and attributes.
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-analytics/admin').v1alpha;
// 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.v1alpha.ICreatePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.ICreatePropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createProperty(request, callback)
createProperty(request: protos.google.analytics.admin.v1alpha.ICreatePropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.ICreatePropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createRollupProperty(request, options)
createRollupProperty(request?: protos.google.analytics.admin.v1alpha.ICreateRollupPropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICreateRollupPropertyResponse,
(protos.google.analytics.admin.v1alpha.ICreateRollupPropertyRequest | undefined),
{} | undefined
]>;
Create a roll-up property and all roll-up property source links.
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 roll-up property to create.
*/
// const rollupProperty = {}
/**
* Optional. The resource names of properties that will be sources to the
* created roll-up property.
*/
// const sourceProperties = ['abc','def']
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateRollupProperty() {
// Construct request
const request = {
rollupProperty,
};
// Run request
const response = await adminClient.createRollupProperty(request);
console.log(response);
}
callCreateRollupProperty();
createRollupProperty(request, options, callback)
createRollupProperty(request: protos.google.analytics.admin.v1alpha.ICreateRollupPropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICreateRollupPropertyResponse, protos.google.analytics.admin.v1alpha.ICreateRollupPropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createRollupProperty(request, callback)
createRollupProperty(request: protos.google.analytics.admin.v1alpha.ICreateRollupPropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICreateRollupPropertyResponse, protos.google.analytics.admin.v1alpha.ICreateRollupPropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createRollupPropertySourceLink(request, options)
createRollupPropertySourceLink(request?: protos.google.analytics.admin.v1alpha.ICreateRollupPropertySourceLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink,
(protos.google.analytics.admin.v1alpha.ICreateRollupPropertySourceLinkRequest | undefined),
{} | undefined
]>;
Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
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 roll-up property source link to create.
*/
// const rollupPropertySourceLink = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateRollupPropertySourceLink() {
// Construct request
const request = {
parent,
rollupPropertySourceLink,
};
// Run request
const response = await adminClient.createRollupPropertySourceLink(request);
console.log(response);
}
callCreateRollupPropertySourceLink();
createRollupPropertySourceLink(request, options, callback)
createRollupPropertySourceLink(request: protos.google.analytics.admin.v1alpha.ICreateRollupPropertySourceLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink, protos.google.analytics.admin.v1alpha.ICreateRollupPropertySourceLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createRollupPropertySourceLink(request, callback)
createRollupPropertySourceLink(request: protos.google.analytics.admin.v1alpha.ICreateRollupPropertySourceLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink, protos.google.analytics.admin.v1alpha.ICreateRollupPropertySourceLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSearchAds360Link(request, options)
createSearchAds360Link(request?: protos.google.analytics.admin.v1alpha.ICreateSearchAds360LinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISearchAds360Link,
(protos.google.analytics.admin.v1alpha.ICreateSearchAds360LinkRequest | undefined),
{} | undefined
]>;
Creates a SearchAds360Link.
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 SearchAds360Link to create.
*/
// const searchAds_360Link = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateSearchAds360Link() {
// Construct request
const request = {
parent,
searchAds_360Link,
};
// Run request
const response = await adminClient.createSearchAds360Link(request);
console.log(response);
}
callCreateSearchAds360Link();
createSearchAds360Link(request, options, callback)
createSearchAds360Link(request: protos.google.analytics.admin.v1alpha.ICreateSearchAds360LinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISearchAds360Link, protos.google.analytics.admin.v1alpha.ICreateSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSearchAds360Link(request, callback)
createSearchAds360Link(request: protos.google.analytics.admin.v1alpha.ICreateSearchAds360LinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISearchAds360Link, protos.google.analytics.admin.v1alpha.ICreateSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSKAdNetworkConversionValueSchema(request, options)
createSKAdNetworkConversionValueSchema(request?: protos.google.analytics.admin.v1alpha.ICreateSKAdNetworkConversionValueSchemaRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema,
(protos.google.analytics.admin.v1alpha.ICreateSKAdNetworkConversionValueSchemaRequest | undefined),
{} | undefined
]>;
Creates a SKAdNetworkConversionValueSchema.
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 schema will be created.
* Format: properties/{property}/dataStreams/{dataStream}
*/
// const parent = 'abc123'
/**
* Required. SKAdNetwork conversion value schema to create.
*/
// const skadnetworkConversionValueSchema = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateSKAdNetworkConversionValueSchema() {
// Construct request
const request = {
parent,
skadnetworkConversionValueSchema,
};
// Run request
const response = await adminClient.createSKAdNetworkConversionValueSchema(request);
console.log(response);
}
callCreateSKAdNetworkConversionValueSchema();
createSKAdNetworkConversionValueSchema(request, options, callback)
createSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.ICreateSKAdNetworkConversionValueSchemaRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema, protos.google.analytics.admin.v1alpha.ICreateSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSKAdNetworkConversionValueSchema(request, callback)
createSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.ICreateSKAdNetworkConversionValueSchemaRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema, protos.google.analytics.admin.v1alpha.ICreateSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSubproperty(request, options)
createSubproperty(request?: protos.google.analytics.admin.v1alpha.ICreateSubpropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICreateSubpropertyResponse,
(protos.google.analytics.admin.v1alpha.ICreateSubpropertyRequest | undefined),
{} | undefined
]>;
Create a subproperty and a subproperty event filter that applies to the created subproperty.
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 ordinary property for which to create a subproperty.
* Format: properties/property_id
* Example: properties/123
*/
// const parent = 'abc123'
/**
* Required. The subproperty to create.
*/
// const subproperty = {}
/**
* Optional. The subproperty event filter to create on an ordinary property.
*/
// const subpropertyEventFilter = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateSubproperty() {
// Construct request
const request = {
parent,
subproperty,
};
// Run request
const response = await adminClient.createSubproperty(request);
console.log(response);
}
callCreateSubproperty();
createSubproperty(request, options, callback)
createSubproperty(request: protos.google.analytics.admin.v1alpha.ICreateSubpropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICreateSubpropertyResponse, protos.google.analytics.admin.v1alpha.ICreateSubpropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSubproperty(request, callback)
createSubproperty(request: protos.google.analytics.admin.v1alpha.ICreateSubpropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICreateSubpropertyResponse, protos.google.analytics.admin.v1alpha.ICreateSubpropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSubpropertyEventFilter(request, options)
createSubpropertyEventFilter(request?: protos.google.analytics.admin.v1alpha.ICreateSubpropertyEventFilterRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter,
(protos.google.analytics.admin.v1alpha.ICreateSubpropertyEventFilterRequest | undefined),
{} | undefined
]>;
Creates a subproperty Event Filter.
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 ordinary property for which to create a subproperty event
* filter. Format: properties/property_id Example: properties/123
*/
// const parent = 'abc123'
/**
* Required. The subproperty event filter to create.
*/
// const subpropertyEventFilter = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callCreateSubpropertyEventFilter() {
// Construct request
const request = {
parent,
subpropertyEventFilter,
};
// Run request
const response = await adminClient.createSubpropertyEventFilter(request);
console.log(response);
}
callCreateSubpropertyEventFilter();
createSubpropertyEventFilter(request, options, callback)
createSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.ICreateSubpropertyEventFilterRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter, protos.google.analytics.admin.v1alpha.ICreateSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
createSubpropertyEventFilter(request, callback)
createSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.ICreateSubpropertyEventFilterRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter, protos.google.analytics.admin.v1alpha.ICreateSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
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.
|
dataRedactionSettingsPath(property, dataStream)
dataRedactionSettingsPath(property: string, dataStream: string): string;
Return a fully-qualified dataRedactionSettings resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
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.
|
deleteAccessBinding(request, options)
deleteAccessBinding(request?: protos.google.analytics.admin.v1alpha.IDeleteAccessBindingRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteAccessBindingRequest | undefined),
{} | undefined
]>;
Deletes an access binding on an account or property.
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. Formats:
* - accounts/{account}/accessBindings/{accessBinding}
* - properties/{property}/accessBindings/{accessBinding}
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteAccessBinding() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteAccessBinding(request);
console.log(response);
}
callDeleteAccessBinding();
deleteAccessBinding(request, options, callback)
deleteAccessBinding(request: protos.google.analytics.admin.v1alpha.IDeleteAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteAccessBinding(request, callback)
deleteAccessBinding(request: protos.google.analytics.admin.v1alpha.IDeleteAccessBindingRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteAccount(request, options)
deleteAccount(request?: protos.google.analytics.admin.v1alpha.IDeleteAccountRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
protos.google.analytics.admin.v1alpha.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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
Parameters |
---|
Name | Description |
request |
IDeleteAccountRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeleteAccountRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteAccountRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteAccount(request, callback)
deleteAccount(request: protos.google.analytics.admin.v1alpha.IDeleteAccountRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteAccountRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteAdSenseLink(request, options)
deleteAdSenseLink(request?: protos.google.analytics.admin.v1alpha.IDeleteAdSenseLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteAdSenseLinkRequest | undefined),
{} | undefined
]>;
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. Unique identifier for the AdSense Link to be deleted.
* Format: properties/{propertyId}/adSenseLinks/{linkId}
* Example: properties/1234/adSenseLinks/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteAdSenseLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteAdSenseLink(request);
console.log(response);
}
callDeleteAdSenseLink();
deleteAdSenseLink(request, options, callback)
deleteAdSenseLink(request: protos.google.analytics.admin.v1alpha.IDeleteAdSenseLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteAdSenseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteAdSenseLink(request, callback)
deleteAdSenseLink(request: protos.google.analytics.admin.v1alpha.IDeleteAdSenseLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteAdSenseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteCalculatedMetric(request, options)
deleteCalculatedMetric(request?: protos.google.analytics.admin.v1alpha.IDeleteCalculatedMetricRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteCalculatedMetricRequest | undefined),
{} | undefined
]>;
Deletes a CalculatedMetric on a property.
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 CalculatedMetric to delete.
* Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id}
* Example: properties/1234/calculatedMetrics/Metric01
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteCalculatedMetric() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteCalculatedMetric(request);
console.log(response);
}
callDeleteCalculatedMetric();
deleteCalculatedMetric(request, options, callback)
deleteCalculatedMetric(request: protos.google.analytics.admin.v1alpha.IDeleteCalculatedMetricRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteCalculatedMetric(request, callback)
deleteCalculatedMetric(request: protos.google.analytics.admin.v1alpha.IDeleteCalculatedMetricRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteChannelGroup(request, options)
deleteChannelGroup(request?: protos.google.analytics.admin.v1alpha.IDeleteChannelGroupRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteChannelGroupRequest | undefined),
{} | undefined
]>;
Deletes a ChannelGroup on a property.
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 ChannelGroup to delete.
* Example format: properties/1234/channelGroups/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteChannelGroup() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteChannelGroup(request);
console.log(response);
}
callDeleteChannelGroup();
deleteChannelGroup(request, options, callback)
deleteChannelGroup(request: protos.google.analytics.admin.v1alpha.IDeleteChannelGroupRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteChannelGroup(request, callback)
deleteChannelGroup(request: protos.google.analytics.admin.v1alpha.IDeleteChannelGroupRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteConnectedSiteTag(request, options)
deleteConnectedSiteTag(request?: protos.google.analytics.admin.v1alpha.IDeleteConnectedSiteTagRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteConnectedSiteTagRequest | undefined),
{} | undefined
]>;
Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
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 Universal Analytics property to delete connected site tags for.
* This API does not support GA4 properties.
* Format: properties/{universalAnalyticsPropertyId}
* Example: properties/1234
*/
// const property = 'abc123'
/**
* Tag ID to forward events to. Also known as the Measurement ID, or the
* "G-ID" (For example: G-12345).
*/
// const tagId = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteConnectedSiteTag() {
// Construct request
const request = {
};
// Run request
const response = await adminClient.deleteConnectedSiteTag(request);
console.log(response);
}
callDeleteConnectedSiteTag();
deleteConnectedSiteTag(request, options, callback)
deleteConnectedSiteTag(request: protos.google.analytics.admin.v1alpha.IDeleteConnectedSiteTagRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteConnectedSiteTagRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteConnectedSiteTag(request, callback)
deleteConnectedSiteTag(request: protos.google.analytics.admin.v1alpha.IDeleteConnectedSiteTagRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteConnectedSiteTagRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteConversionEvent(request, options)
deleteConversionEvent(request?: protos.google.analytics.admin.v1alpha.IDeleteConversionEventRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteConversionEventRequest | undefined),
{} | undefined
]>;
Deletes a conversion event in a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeleteConversionEventRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteConversionEvent(request, callback)
deleteConversionEvent(request: protos.google.analytics.admin.v1alpha.IDeleteConversionEventRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteDataStream(request, options)
deleteDataStream(request?: protos.google.analytics.admin.v1alpha.IDeleteDataStreamRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteDataStreamRequest | undefined),
{} | undefined
]>;
Deletes a DataStream on a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeleteDataStreamRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteDataStream(request, callback)
deleteDataStream(request: protos.google.analytics.admin.v1alpha.IDeleteDataStreamRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteDisplayVideo360AdvertiserLink(request, options)
deleteDisplayVideo360AdvertiserLink(request?: protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkRequest | undefined),
{} | undefined
]>;
Deletes a DisplayVideo360AdvertiserLink on a property.
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 DisplayVideo360AdvertiserLink to delete.
* Example format: properties/1234/displayVideo360AdvertiserLinks/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteDisplayVideo360AdvertiserLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteDisplayVideo360AdvertiserLink(request);
console.log(response);
}
callDeleteDisplayVideo360AdvertiserLink();
deleteDisplayVideo360AdvertiserLink(request, options, callback)
deleteDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteDisplayVideo360AdvertiserLink(request, callback)
deleteDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteDisplayVideo360AdvertiserLinkProposal(request, options)
deleteDisplayVideo360AdvertiserLinkProposal(request?: protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkProposalRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkProposalRequest | undefined),
{} | undefined
]>;
Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.
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 DisplayVideo360AdvertiserLinkProposal to delete.
* Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteDisplayVideo360AdvertiserLinkProposal() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteDisplayVideo360AdvertiserLinkProposal(request);
console.log(response);
}
callDeleteDisplayVideo360AdvertiserLinkProposal();
deleteDisplayVideo360AdvertiserLinkProposal(request, options, callback)
deleteDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkProposalRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteDisplayVideo360AdvertiserLinkProposal(request, callback)
deleteDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkProposalRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteEventCreateRule(request, options)
deleteEventCreateRule(request?: protos.google.analytics.admin.v1alpha.IDeleteEventCreateRuleRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteEventCreateRuleRequest | undefined),
{} | undefined
]>;
Deletes an EventCreateRule.
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/123/dataStreams/456/eventCreateRules/789
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteEventCreateRule() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteEventCreateRule(request);
console.log(response);
}
callDeleteEventCreateRule();
deleteEventCreateRule(request, options, callback)
deleteEventCreateRule(request: protos.google.analytics.admin.v1alpha.IDeleteEventCreateRuleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteEventCreateRule(request, callback)
deleteEventCreateRule(request: protos.google.analytics.admin.v1alpha.IDeleteEventCreateRuleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteExpandedDataSet(request, options)
deleteExpandedDataSet(request?: protos.google.analytics.admin.v1alpha.IDeleteExpandedDataSetRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteExpandedDataSetRequest | undefined),
{} | undefined
]>;
Deletes a ExpandedDataSet on a property.
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/expandedDataSets/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteExpandedDataSet() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteExpandedDataSet(request);
console.log(response);
}
callDeleteExpandedDataSet();
deleteExpandedDataSet(request, options, callback)
deleteExpandedDataSet(request: protos.google.analytics.admin.v1alpha.IDeleteExpandedDataSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteExpandedDataSet(request, callback)
deleteExpandedDataSet(request: protos.google.analytics.admin.v1alpha.IDeleteExpandedDataSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteFirebaseLink(request, options)
deleteFirebaseLink(request?: protos.google.analytics.admin.v1alpha.IDeleteFirebaseLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteFirebaseLinkRequest | undefined),
{} | undefined
]>;
Deletes a FirebaseLink on a property
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeleteFirebaseLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteFirebaseLink(request, callback)
deleteFirebaseLink(request: protos.google.analytics.admin.v1alpha.IDeleteFirebaseLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteGoogleAdsLink(request, options)
deleteGoogleAdsLink(request?: protos.google.analytics.admin.v1alpha.IDeleteGoogleAdsLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteGoogleAdsLinkRequest | undefined),
{} | undefined
]>;
Deletes a GoogleAdsLink on a property
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeleteGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteGoogleAdsLink(request, callback)
deleteGoogleAdsLink(request: protos.google.analytics.admin.v1alpha.IDeleteGoogleAdsLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteMeasurementProtocolSecret(request, options)
deleteMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1alpha.IDeleteMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Deletes target MeasurementProtocolSecret.
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeleteMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteMeasurementProtocolSecret(request, callback)
deleteMeasurementProtocolSecret(request: protos.google.analytics.admin.v1alpha.IDeleteMeasurementProtocolSecretRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteProperty(request, options)
deleteProperty(request?: protos.google.analytics.admin.v1alpha.IDeletePropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IProperty,
protos.google.analytics.admin.v1alpha.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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found, or is not a GA4 Property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IDeletePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.IDeletePropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteProperty(request, callback)
deleteProperty(request: protos.google.analytics.admin.v1alpha.IDeletePropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.IDeletePropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteRollupPropertySourceLink(request, options)
deleteRollupPropertySourceLink(request?: protos.google.analytics.admin.v1alpha.IDeleteRollupPropertySourceLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteRollupPropertySourceLinkRequest | undefined),
{} | undefined
]>;
Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
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}/rollupPropertySourceLinks/{rollup_property_source_link_id}
* Example: properties/1234/rollupPropertySourceLinks/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteRollupPropertySourceLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteRollupPropertySourceLink(request);
console.log(response);
}
callDeleteRollupPropertySourceLink();
deleteRollupPropertySourceLink(request, options, callback)
deleteRollupPropertySourceLink(request: protos.google.analytics.admin.v1alpha.IDeleteRollupPropertySourceLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteRollupPropertySourceLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteRollupPropertySourceLink(request, callback)
deleteRollupPropertySourceLink(request: protos.google.analytics.admin.v1alpha.IDeleteRollupPropertySourceLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteRollupPropertySourceLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteSearchAds360Link(request, options)
deleteSearchAds360Link(request?: protos.google.analytics.admin.v1alpha.IDeleteSearchAds360LinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteSearchAds360LinkRequest | undefined),
{} | undefined
]>;
Deletes a SearchAds360Link on a property.
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 SearchAds360Link to delete.
* Example format: properties/1234/SearchAds360Links/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteSearchAds360Link() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteSearchAds360Link(request);
console.log(response);
}
callDeleteSearchAds360Link();
deleteSearchAds360Link(request, options, callback)
deleteSearchAds360Link(request: protos.google.analytics.admin.v1alpha.IDeleteSearchAds360LinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteSearchAds360Link(request, callback)
deleteSearchAds360Link(request: protos.google.analytics.admin.v1alpha.IDeleteSearchAds360LinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteSKAdNetworkConversionValueSchema(request, options)
deleteSKAdNetworkConversionValueSchema(request?: protos.google.analytics.admin.v1alpha.IDeleteSKAdNetworkConversionValueSchemaRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteSKAdNetworkConversionValueSchemaRequest | undefined),
{} | undefined
]>;
Deletes target SKAdNetworkConversionValueSchema.
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 SKAdNetworkConversionValueSchema to delete.
* Format:
* properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteSKAdNetworkConversionValueSchema() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteSKAdNetworkConversionValueSchema(request);
console.log(response);
}
callDeleteSKAdNetworkConversionValueSchema();
deleteSKAdNetworkConversionValueSchema(request, options, callback)
deleteSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.IDeleteSKAdNetworkConversionValueSchemaRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteSKAdNetworkConversionValueSchema(request, callback)
deleteSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.IDeleteSKAdNetworkConversionValueSchemaRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteSubpropertyEventFilter(request, options)
deleteSubpropertyEventFilter(request?: protos.google.analytics.admin.v1alpha.IDeleteSubpropertyEventFilterRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.analytics.admin.v1alpha.IDeleteSubpropertyEventFilterRequest | undefined),
{} | undefined
]>;
Deletes a subproperty event filter.
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. Resource name of the subproperty event filter to delete.
* Format:
* properties/property_id/subpropertyEventFilters/subproperty_event_filter
* Example: properties/123/subpropertyEventFilters/456
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callDeleteSubpropertyEventFilter() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.deleteSubpropertyEventFilter(request);
console.log(response);
}
callDeleteSubpropertyEventFilter();
deleteSubpropertyEventFilter(request, options, callback)
deleteSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.IDeleteSubpropertyEventFilterRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
deleteSubpropertyEventFilter(request, callback)
deleteSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.IDeleteSubpropertyEventFilterRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1alpha.IDeleteSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
displayVideo360AdvertiserLinkPath(property)
displayVideo360AdvertiserLinkPath(property: string): string;
Return a fully-qualified displayVideo360AdvertiserLink resource name string.
Parameter |
---|
Name | Description |
property |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
displayVideo360AdvertiserLinkProposalPath(property)
displayVideo360AdvertiserLinkProposalPath(property: string): string;
Return a fully-qualified displayVideo360AdvertiserLinkProposal resource name string.
Parameter |
---|
Name | Description |
property |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
enhancedMeasurementSettingsPath(property, dataStream)
enhancedMeasurementSettingsPath(property: string, dataStream: string): string;
Return a fully-qualified enhancedMeasurementSettings resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
eventCreateRulePath(property, dataStream, eventCreateRule)
eventCreateRulePath(property: string, dataStream: string, eventCreateRule: string): string;
Return a fully-qualified eventCreateRule resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
string
|
eventCreateRule |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
expandedDataSetPath(property, expandedDataSet)
expandedDataSetPath(property: string, expandedDataSet: string): string;
Return a fully-qualified expandedDataSet resource name string.
Parameters |
---|
Name | Description |
property |
string
|
expandedDataSet |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
fetchAutomatedGa4ConfigurationOptOut(request, options)
fetchAutomatedGa4ConfigurationOptOut(request?: protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutResponse,
(protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutRequest | undefined),
{} | undefined
]>;
Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
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 UA property to get the opt out status. Note this request uses
* the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
* Format: properties/{internalWebPropertyId}
* Example: properties/1234
*/
// const property = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callFetchAutomatedGa4ConfigurationOptOut() {
// Construct request
const request = {
property,
};
// Run request
const response = await adminClient.fetchAutomatedGa4ConfigurationOptOut(request);
console.log(response);
}
callFetchAutomatedGa4ConfigurationOptOut();
fetchAutomatedGa4ConfigurationOptOut(request, options, callback)
fetchAutomatedGa4ConfigurationOptOut(request: protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutResponse, protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
fetchAutomatedGa4ConfigurationOptOut(request, callback)
fetchAutomatedGa4ConfigurationOptOut(request: protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutResponse, protos.google.analytics.admin.v1alpha.IFetchAutomatedGa4ConfigurationOptOutRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
fetchConnectedGa4Property(request, options)
fetchConnectedGa4Property(request?: protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyResponse,
(protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyRequest | undefined),
{} | undefined
]>;
Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.
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 UA property for which to look up the connected GA4 property.
* Note this request uses the
* internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
* Format: properties/{internal_web_property_id}
* Example: properties/1234
*/
// const property = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callFetchConnectedGa4Property() {
// Construct request
const request = {
property,
};
// Run request
const response = await adminClient.fetchConnectedGa4Property(request);
console.log(response);
}
callFetchConnectedGa4Property();
fetchConnectedGa4Property(request, options, callback)
fetchConnectedGa4Property(request: protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyResponse, protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
fetchConnectedGa4Property(request, callback)
fetchConnectedGa4Property(request: protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyResponse, protos.google.analytics.admin.v1alpha.IFetchConnectedGa4PropertyRequest | null | undefined, {} | null | undefined>): void;
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.
|
getAccessBinding(request, options)
getAccessBinding(request?: protos.google.analytics.admin.v1alpha.IGetAccessBindingRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccessBinding,
(protos.google.analytics.admin.v1alpha.IGetAccessBindingRequest | undefined),
{} | undefined
]>;
Gets information about an access binding.
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 access binding to retrieve.
* Formats:
* - accounts/{account}/accessBindings/{accessBinding}
* - properties/{property}/accessBindings/{accessBinding}
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetAccessBinding() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getAccessBinding(request);
console.log(response);
}
callGetAccessBinding();
getAccessBinding(request, options, callback)
getAccessBinding(request: protos.google.analytics.admin.v1alpha.IGetAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAccessBinding, protos.google.analytics.admin.v1alpha.IGetAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAccessBinding(request, callback)
getAccessBinding(request: protos.google.analytics.admin.v1alpha.IGetAccessBindingRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAccessBinding, protos.google.analytics.admin.v1alpha.IGetAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAccount(request, options)
getAccount(request?: protos.google.analytics.admin.v1alpha.IGetAccountRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccount,
protos.google.analytics.admin.v1alpha.IGetAccountRequest | undefined,
{} | undefined
]>;
Lookup for a single Account.
Parameters |
---|
Name | Description |
request |
IGetAccountRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetAccountRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAccount, protos.google.analytics.admin.v1alpha.IGetAccountRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAccount(request, callback)
getAccount(request: protos.google.analytics.admin.v1alpha.IGetAccountRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAccount, protos.google.analytics.admin.v1alpha.IGetAccountRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAdSenseLink(request, options)
getAdSenseLink(request?: protos.google.analytics.admin.v1alpha.IGetAdSenseLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAdSenseLink,
protos.google.analytics.admin.v1alpha.IGetAdSenseLinkRequest | undefined,
{} | undefined
]>;
Looks up a single AdSenseLink.
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. Unique identifier for the AdSense Link requested.
* Format: properties/{propertyId}/adSenseLinks/{linkId}
* Example: properties/1234/adSenseLinks/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetAdSenseLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getAdSenseLink(request);
console.log(response);
}
callGetAdSenseLink();
getAdSenseLink(request, options, callback)
getAdSenseLink(request: protos.google.analytics.admin.v1alpha.IGetAdSenseLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAdSenseLink, protos.google.analytics.admin.v1alpha.IGetAdSenseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAdSenseLink(request, callback)
getAdSenseLink(request: protos.google.analytics.admin.v1alpha.IGetAdSenseLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAdSenseLink, protos.google.analytics.admin.v1alpha.IGetAdSenseLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAttributionSettings(request, options)
getAttributionSettings(request?: protos.google.analytics.admin.v1alpha.IGetAttributionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAttributionSettings,
(protos.google.analytics.admin.v1alpha.IGetAttributionSettingsRequest | undefined),
{} | undefined
]>;
Lookup for a AttributionSettings singleton.
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 attribution settings to retrieve.
* Format: properties/{property}/attributionSettings
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetAttributionSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getAttributionSettings(request);
console.log(response);
}
callGetAttributionSettings();
getAttributionSettings(request, options, callback)
getAttributionSettings(request: protos.google.analytics.admin.v1alpha.IGetAttributionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAttributionSettings, protos.google.analytics.admin.v1alpha.IGetAttributionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAttributionSettings(request, callback)
getAttributionSettings(request: protos.google.analytics.admin.v1alpha.IGetAttributionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAttributionSettings, protos.google.analytics.admin.v1alpha.IGetAttributionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAudience(request, options)
getAudience(request?: protos.google.analytics.admin.v1alpha.IGetAudienceRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAudience,
protos.google.analytics.admin.v1alpha.IGetAudienceRequest | undefined,
{} | undefined
]>;
Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
Parameters |
---|
Name | Description |
request |
IGetAudienceRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 Audience to get.
* Example format: properties/1234/audiences/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetAudience() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getAudience(request);
console.log(response);
}
callGetAudience();
getAudience(request, options, callback)
getAudience(request: protos.google.analytics.admin.v1alpha.IGetAudienceRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAudience, protos.google.analytics.admin.v1alpha.IGetAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getAudience(request, callback)
getAudience(request: protos.google.analytics.admin.v1alpha.IGetAudienceRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAudience, protos.google.analytics.admin.v1alpha.IGetAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getBigQueryLink(request, options)
getBigQueryLink(request?: protos.google.analytics.admin.v1alpha.IGetBigQueryLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IBigQueryLink,
protos.google.analytics.admin.v1alpha.IGetBigQueryLinkRequest | undefined,
{} | undefined
]>;
Lookup for a single BigQuery Link.
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 BigQuery link to lookup.
* Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id}
* Example: properties/123/bigQueryLinks/456
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetBigQueryLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getBigQueryLink(request);
console.log(response);
}
callGetBigQueryLink();
getBigQueryLink(request, options, callback)
getBigQueryLink(request: protos.google.analytics.admin.v1alpha.IGetBigQueryLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IBigQueryLink, protos.google.analytics.admin.v1alpha.IGetBigQueryLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getBigQueryLink(request, callback)
getBigQueryLink(request: protos.google.analytics.admin.v1alpha.IGetBigQueryLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IBigQueryLink, protos.google.analytics.admin.v1alpha.IGetBigQueryLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCalculatedMetric(request, options)
getCalculatedMetric(request?: protos.google.analytics.admin.v1alpha.IGetCalculatedMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICalculatedMetric,
(protos.google.analytics.admin.v1alpha.IGetCalculatedMetricRequest | undefined),
{} | undefined
]>;
Lookup for a single CalculatedMetric.
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 CalculatedMetric to get.
* Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id}
* Example: properties/1234/calculatedMetrics/Metric01
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetCalculatedMetric() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getCalculatedMetric(request);
console.log(response);
}
callGetCalculatedMetric();
getCalculatedMetric(request, options, callback)
getCalculatedMetric(request: protos.google.analytics.admin.v1alpha.IGetCalculatedMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICalculatedMetric, protos.google.analytics.admin.v1alpha.IGetCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCalculatedMetric(request, callback)
getCalculatedMetric(request: protos.google.analytics.admin.v1alpha.IGetCalculatedMetricRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICalculatedMetric, protos.google.analytics.admin.v1alpha.IGetCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getChannelGroup(request, options)
getChannelGroup(request?: protos.google.analytics.admin.v1alpha.IGetChannelGroupRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IChannelGroup,
protos.google.analytics.admin.v1alpha.IGetChannelGroupRequest | undefined,
{} | undefined
]>;
Lookup for a single ChannelGroup.
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 ChannelGroup to get.
* Example format: properties/1234/channelGroups/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetChannelGroup() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getChannelGroup(request);
console.log(response);
}
callGetChannelGroup();
getChannelGroup(request, options, callback)
getChannelGroup(request: protos.google.analytics.admin.v1alpha.IGetChannelGroupRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IChannelGroup, protos.google.analytics.admin.v1alpha.IGetChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getChannelGroup(request, callback)
getChannelGroup(request: protos.google.analytics.admin.v1alpha.IGetChannelGroupRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IChannelGroup, protos.google.analytics.admin.v1alpha.IGetChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getConversionEvent(request, options)
getConversionEvent(request?: protos.google.analytics.admin.v1alpha.IGetConversionEventRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IConversionEvent,
(protos.google.analytics.admin.v1alpha.IGetConversionEventRequest | undefined),
{} | undefined
]>;
Retrieve a single conversion event.
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IConversionEvent, protos.google.analytics.admin.v1alpha.IGetConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getConversionEvent(request, callback)
getConversionEvent(request: protos.google.analytics.admin.v1alpha.IGetConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IConversionEvent, protos.google.analytics.admin.v1alpha.IGetConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCustomDimension(request, options)
getCustomDimension(request?: protos.google.analytics.admin.v1alpha.IGetCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomDimension,
(protos.google.analytics.admin.v1alpha.IGetCustomDimensionRequest | undefined),
{} | undefined
]>;
Lookup for a single CustomDimension.
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomDimension, protos.google.analytics.admin.v1alpha.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCustomDimension(request, callback)
getCustomDimension(request: protos.google.analytics.admin.v1alpha.IGetCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomDimension, protos.google.analytics.admin.v1alpha.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCustomMetric(request, options)
getCustomMetric(request?: protos.google.analytics.admin.v1alpha.IGetCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomMetric,
protos.google.analytics.admin.v1alpha.IGetCustomMetricRequest | undefined,
{} | undefined
]>;
Lookup for a single CustomMetric.
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomMetric, protos.google.analytics.admin.v1alpha.IGetCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getCustomMetric(request, callback)
getCustomMetric(request: protos.google.analytics.admin.v1alpha.IGetCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomMetric, protos.google.analytics.admin.v1alpha.IGetCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataRedactionSettings(request, options)
getDataRedactionSettings(request?: protos.google.analytics.admin.v1alpha.IGetDataRedactionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataRedactionSettings,
(protos.google.analytics.admin.v1alpha.IGetDataRedactionSettingsRequest | undefined),
{} | undefined
]>;
Lookup for a single DataRedactionSettings.
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}/dataStreams/{data_stream}/dataRedactionSettings
* Example: "properties/1000/dataStreams/2000/dataRedactionSettings"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetDataRedactionSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getDataRedactionSettings(request);
console.log(response);
}
callGetDataRedactionSettings();
getDataRedactionSettings(request, options, callback)
getDataRedactionSettings(request: protos.google.analytics.admin.v1alpha.IGetDataRedactionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRedactionSettings, protos.google.analytics.admin.v1alpha.IGetDataRedactionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataRedactionSettings(request, callback)
getDataRedactionSettings(request: protos.google.analytics.admin.v1alpha.IGetDataRedactionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRedactionSettings, protos.google.analytics.admin.v1alpha.IGetDataRedactionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataRetentionSettings(request, options)
getDataRetentionSettings(request?: protos.google.analytics.admin.v1alpha.IGetDataRetentionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataRetentionSettings,
(protos.google.analytics.admin.v1alpha.IGetDataRetentionSettingsRequest | undefined),
{} | undefined
]>;
Returns the singleton data retention settings for this property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetDataRetentionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRetentionSettings, protos.google.analytics.admin.v1alpha.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataRetentionSettings(request, callback)
getDataRetentionSettings(request: protos.google.analytics.admin.v1alpha.IGetDataRetentionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRetentionSettings, protos.google.analytics.admin.v1alpha.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataSharingSettings(request, options)
getDataSharingSettings(request?: protos.google.analytics.admin.v1alpha.IGetDataSharingSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataSharingSettings,
(protos.google.analytics.admin.v1alpha.IGetDataSharingSettingsRequest | undefined),
{} | undefined
]>;
Get data sharing settings on an account. Data sharing settings are singletons.
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetDataSharingSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataSharingSettings, protos.google.analytics.admin.v1alpha.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataSharingSettings(request, callback)
getDataSharingSettings(request: protos.google.analytics.admin.v1alpha.IGetDataSharingSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataSharingSettings, protos.google.analytics.admin.v1alpha.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataStream(request, options)
getDataStream(request?: protos.google.analytics.admin.v1alpha.IGetDataStreamRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataStream,
protos.google.analytics.admin.v1alpha.IGetDataStreamRequest | undefined,
{} | undefined
]>;
Lookup for a single DataStream.
Parameters |
---|
Name | Description |
request |
IGetDataStreamRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataStream, protos.google.analytics.admin.v1alpha.IGetDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDataStream(request, callback)
getDataStream(request: protos.google.analytics.admin.v1alpha.IGetDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataStream, protos.google.analytics.admin.v1alpha.IGetDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDisplayVideo360AdvertiserLink(request, options)
getDisplayVideo360AdvertiserLink(request?: protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink,
(protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkRequest | undefined),
{} | undefined
]>;
Look up a single DisplayVideo360AdvertiserLink
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 DisplayVideo360AdvertiserLink to get.
* Example format: properties/1234/displayVideo360AdvertiserLink/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetDisplayVideo360AdvertiserLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getDisplayVideo360AdvertiserLink(request);
console.log(response);
}
callGetDisplayVideo360AdvertiserLink();
getDisplayVideo360AdvertiserLink(request, options, callback)
getDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink, protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDisplayVideo360AdvertiserLink(request, callback)
getDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink, protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDisplayVideo360AdvertiserLinkProposal(request, options)
getDisplayVideo360AdvertiserLinkProposal(request?: protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkProposalRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal,
(protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkProposalRequest | undefined),
{} | undefined
]>;
Lookup for a single DisplayVideo360AdvertiserLinkProposal.
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 DisplayVideo360AdvertiserLinkProposal to get.
* Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetDisplayVideo360AdvertiserLinkProposal() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getDisplayVideo360AdvertiserLinkProposal(request);
console.log(response);
}
callGetDisplayVideo360AdvertiserLinkProposal();
getDisplayVideo360AdvertiserLinkProposal(request, options, callback)
getDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkProposalRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal, protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getDisplayVideo360AdvertiserLinkProposal(request, callback)
getDisplayVideo360AdvertiserLinkProposal(request: protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkProposalRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal, protos.google.analytics.admin.v1alpha.IGetDisplayVideo360AdvertiserLinkProposalRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getEnhancedMeasurementSettings(request, options)
getEnhancedMeasurementSettings(request?: protos.google.analytics.admin.v1alpha.IGetEnhancedMeasurementSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IEnhancedMeasurementSettings,
(protos.google.analytics.admin.v1alpha.IGetEnhancedMeasurementSettingsRequest | undefined),
{} | undefined
]>;
Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.
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}/dataStreams/{data_stream}/enhancedMeasurementSettings
* Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetEnhancedMeasurementSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getEnhancedMeasurementSettings(request);
console.log(response);
}
callGetEnhancedMeasurementSettings();
getEnhancedMeasurementSettings(request, options, callback)
getEnhancedMeasurementSettings(request: protos.google.analytics.admin.v1alpha.IGetEnhancedMeasurementSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IEnhancedMeasurementSettings, protos.google.analytics.admin.v1alpha.IGetEnhancedMeasurementSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getEnhancedMeasurementSettings(request, callback)
getEnhancedMeasurementSettings(request: protos.google.analytics.admin.v1alpha.IGetEnhancedMeasurementSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IEnhancedMeasurementSettings, protos.google.analytics.admin.v1alpha.IGetEnhancedMeasurementSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getEventCreateRule(request, options)
getEventCreateRule(request?: protos.google.analytics.admin.v1alpha.IGetEventCreateRuleRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IEventCreateRule,
(protos.google.analytics.admin.v1alpha.IGetEventCreateRuleRequest | undefined),
{} | undefined
]>;
Lookup for a single EventCreateRule.
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 EventCreateRule to get.
* Example format: properties/123/dataStreams/456/eventCreateRules/789
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetEventCreateRule() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getEventCreateRule(request);
console.log(response);
}
callGetEventCreateRule();
getEventCreateRule(request, options, callback)
getEventCreateRule(request: protos.google.analytics.admin.v1alpha.IGetEventCreateRuleRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IEventCreateRule, protos.google.analytics.admin.v1alpha.IGetEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getEventCreateRule(request, callback)
getEventCreateRule(request: protos.google.analytics.admin.v1alpha.IGetEventCreateRuleRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IEventCreateRule, protos.google.analytics.admin.v1alpha.IGetEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getExpandedDataSet(request, options)
getExpandedDataSet(request?: protos.google.analytics.admin.v1alpha.IGetExpandedDataSetRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IExpandedDataSet,
(protos.google.analytics.admin.v1alpha.IGetExpandedDataSetRequest | undefined),
{} | undefined
]>;
Lookup for a single ExpandedDataSet.
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 ExpandedDataSet to get.
* Example format: properties/1234/expandedDataSets/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetExpandedDataSet() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getExpandedDataSet(request);
console.log(response);
}
callGetExpandedDataSet();
getExpandedDataSet(request, options, callback)
getExpandedDataSet(request: protos.google.analytics.admin.v1alpha.IGetExpandedDataSetRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IExpandedDataSet, protos.google.analytics.admin.v1alpha.IGetExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getExpandedDataSet(request, callback)
getExpandedDataSet(request: protos.google.analytics.admin.v1alpha.IGetExpandedDataSetRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IExpandedDataSet, protos.google.analytics.admin.v1alpha.IGetExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getGlobalSiteTag(request, options)
getGlobalSiteTag(request?: protos.google.analytics.admin.v1alpha.IGetGlobalSiteTagRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IGlobalSiteTag,
(protos.google.analytics.admin.v1alpha.IGetGlobalSiteTagRequest | undefined),
{} | undefined
]>;
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
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 site tag to lookup.
* Note that site tags are singletons and do not have unique IDs.
* Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag
* Example: "properties/123/dataStreams/456/globalSiteTag"
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetGlobalSiteTag() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getGlobalSiteTag(request);
console.log(response);
}
callGetGlobalSiteTag();
getGlobalSiteTag(request, options, callback)
getGlobalSiteTag(request: protos.google.analytics.admin.v1alpha.IGetGlobalSiteTagRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IGlobalSiteTag, protos.google.analytics.admin.v1alpha.IGetGlobalSiteTagRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getGlobalSiteTag(request, callback)
getGlobalSiteTag(request: protos.google.analytics.admin.v1alpha.IGetGlobalSiteTagRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IGlobalSiteTag, protos.google.analytics.admin.v1alpha.IGetGlobalSiteTagRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getGoogleSignalsSettings(request, options)
getGoogleSignalsSettings(request?: protos.google.analytics.admin.v1alpha.IGetGoogleSignalsSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IGoogleSignalsSettings,
(protos.google.analytics.admin.v1alpha.IGetGoogleSignalsSettingsRequest | undefined),
{} | undefined
]>;
Lookup for Google Signals settings for a property.
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 google signals settings to retrieve.
* Format: properties/{property}/googleSignalsSettings
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetGoogleSignalsSettings() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getGoogleSignalsSettings(request);
console.log(response);
}
callGetGoogleSignalsSettings();
getGoogleSignalsSettings(request, options, callback)
getGoogleSignalsSettings(request: protos.google.analytics.admin.v1alpha.IGetGoogleSignalsSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleSignalsSettings, protos.google.analytics.admin.v1alpha.IGetGoogleSignalsSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getGoogleSignalsSettings(request, callback)
getGoogleSignalsSettings(request: protos.google.analytics.admin.v1alpha.IGetGoogleSignalsSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleSignalsSettings, protos.google.analytics.admin.v1alpha.IGetGoogleSignalsSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getMeasurementProtocolSecret(request, options)
getMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1alpha.IGetMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1alpha.IGetMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Lookup for a single "GA4" MeasurementProtocolSecret.
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret, protos.google.analytics.admin.v1alpha.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getMeasurementProtocolSecret(request, callback)
getMeasurementProtocolSecret(request: protos.google.analytics.admin.v1alpha.IGetMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret, protos.google.analytics.admin.v1alpha.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
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.v1alpha.IGetPropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IProperty,
protos.google.analytics.admin.v1alpha.IGetPropertyRequest | undefined,
{} | undefined
]>;
Lookup for a single "GA4" Property.
Parameters |
---|
Name | Description |
request |
IGetPropertyRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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-analytics/admin').v1alpha;
// 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.v1alpha.IGetPropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.IGetPropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getProperty(request, callback)
getProperty(request: protos.google.analytics.admin.v1alpha.IGetPropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.IGetPropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getRollupPropertySourceLink(request, options)
getRollupPropertySourceLink(request?: protos.google.analytics.admin.v1alpha.IGetRollupPropertySourceLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink,
(protos.google.analytics.admin.v1alpha.IGetRollupPropertySourceLinkRequest | undefined),
{} | undefined
]>;
Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
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 roll-up property source link to lookup.
* Format:
* properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id}
* Example: properties/123/rollupPropertySourceLinks/456
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetRollupPropertySourceLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getRollupPropertySourceLink(request);
console.log(response);
}
callGetRollupPropertySourceLink();
getRollupPropertySourceLink(request, options, callback)
getRollupPropertySourceLink(request: protos.google.analytics.admin.v1alpha.IGetRollupPropertySourceLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink, protos.google.analytics.admin.v1alpha.IGetRollupPropertySourceLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getRollupPropertySourceLink(request, callback)
getRollupPropertySourceLink(request: protos.google.analytics.admin.v1alpha.IGetRollupPropertySourceLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink, protos.google.analytics.admin.v1alpha.IGetRollupPropertySourceLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getSearchAds360Link(request, options)
getSearchAds360Link(request?: protos.google.analytics.admin.v1alpha.IGetSearchAds360LinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISearchAds360Link,
(protos.google.analytics.admin.v1alpha.IGetSearchAds360LinkRequest | undefined),
{} | undefined
]>;
Look up a single SearchAds360Link
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 SearchAds360Link to get.
* Example format: properties/1234/SearchAds360Link/5678
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetSearchAds360Link() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getSearchAds360Link(request);
console.log(response);
}
callGetSearchAds360Link();
getSearchAds360Link(request, options, callback)
getSearchAds360Link(request: protos.google.analytics.admin.v1alpha.IGetSearchAds360LinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISearchAds360Link, protos.google.analytics.admin.v1alpha.IGetSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getSearchAds360Link(request, callback)
getSearchAds360Link(request: protos.google.analytics.admin.v1alpha.IGetSearchAds360LinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISearchAds360Link, protos.google.analytics.admin.v1alpha.IGetSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getSKAdNetworkConversionValueSchema(request, options)
getSKAdNetworkConversionValueSchema(request?: protos.google.analytics.admin.v1alpha.IGetSKAdNetworkConversionValueSchemaRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema,
(protos.google.analytics.admin.v1alpha.IGetSKAdNetworkConversionValueSchemaRequest | undefined),
{} | undefined
]>;
Looks up a single SKAdNetworkConversionValueSchema.
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 SKAdNetwork conversion value schema to look
* up. Format:
* properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetSKAdNetworkConversionValueSchema() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getSKAdNetworkConversionValueSchema(request);
console.log(response);
}
callGetSKAdNetworkConversionValueSchema();
getSKAdNetworkConversionValueSchema(request, options, callback)
getSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.IGetSKAdNetworkConversionValueSchemaRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema, protos.google.analytics.admin.v1alpha.IGetSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getSKAdNetworkConversionValueSchema(request, callback)
getSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.IGetSKAdNetworkConversionValueSchemaRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema, protos.google.analytics.admin.v1alpha.IGetSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getSubpropertyEventFilter(request, options)
getSubpropertyEventFilter(request?: protos.google.analytics.admin.v1alpha.IGetSubpropertyEventFilterRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter,
(protos.google.analytics.admin.v1alpha.IGetSubpropertyEventFilterRequest | undefined),
{} | undefined
]>;
Lookup for a single subproperty Event Filter.
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. Resource name of the subproperty event filter to lookup.
* Format:
* properties/property_id/subpropertyEventFilters/subproperty_event_filter
* Example: properties/123/subpropertyEventFilters/456
*/
// const name = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callGetSubpropertyEventFilter() {
// Construct request
const request = {
name,
};
// Run request
const response = await adminClient.getSubpropertyEventFilter(request);
console.log(response);
}
callGetSubpropertyEventFilter();
getSubpropertyEventFilter(request, options, callback)
getSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.IGetSubpropertyEventFilterRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter, protos.google.analytics.admin.v1alpha.IGetSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
getSubpropertyEventFilter(request, callback)
getSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.IGetSubpropertyEventFilterRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter, protos.google.analytics.admin.v1alpha.IGetSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
globalSiteTagPath(property, dataStream)
globalSiteTagPath(property: string, dataStream: string): string;
Return a fully-qualified globalSiteTag resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
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.
|
googleSignalsSettingsPath(property)
googleSignalsSettingsPath(property: string): string;
Return a fully-qualified googleSignalsSettings resource name string.
Parameter |
---|
Name | Description |
property |
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.
|
listAccessBindings(request, options)
listAccessBindings(request?: protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccessBinding[],
protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest | null,
protos.google.analytics.admin.v1alpha.IListAccessBindingsResponse
]>;
Lists all access bindings on an account or property.
listAccessBindings(request, options, callback)
listAccessBindings(request: protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, protos.google.analytics.admin.v1alpha.IListAccessBindingsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAccessBinding>): void;
Returns |
---|
Type | Description |
void | |
listAccessBindings(request, callback)
listAccessBindings(request: protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, protos.google.analytics.admin.v1alpha.IListAccessBindingsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAccessBinding>): void;
Returns |
---|
Type | Description |
void | |
listAccessBindingsAsync(request, options)
listAccessBindingsAsync(request?: protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IAccessBinding>;
Equivalent to listAccessBindings
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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. Formats:
* - accounts/{account}
* - properties/{property}
*/
// const parent = 'abc123'
/**
* The maximum number of access bindings to return.
* The service may return fewer than this value.
* If unspecified, at most 200 access bindings will be returned.
* The maximum value is 500; values above 500 will be coerced to 500.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListAccessBindings` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAccessBindings` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAccessBindings() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listAccessBindingsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAccessBindings();
listAccessBindingsStream(request, options)
listAccessBindingsStream(request?: protos.google.analytics.admin.v1alpha.IListAccessBindingsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing AccessBinding 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 listAccessBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listAccounts(request, options)
listAccounts(request?: protos.google.analytics.admin.v1alpha.IListAccountsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccount[],
protos.google.analytics.admin.v1alpha.IListAccountsRequest | null,
protos.google.analytics.admin.v1alpha.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 |
IListAccountsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
listAccounts(request, options, callback)
listAccounts(request: protos.google.analytics.admin.v1alpha.IListAccountsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAccountsRequest, protos.google.analytics.admin.v1alpha.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAccount>): void;
Returns |
---|
Type | Description |
void | |
listAccounts(request, callback)
listAccounts(request: protos.google.analytics.admin.v1alpha.IListAccountsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAccountsRequest, protos.google.analytics.admin.v1alpha.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAccount>): void;
Returns |
---|
Type | Description |
void | |
listAccountsAsync(request, options)
listAccountsAsync(request?: protos.google.analytics.admin.v1alpha.IListAccountsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.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 |
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.v1alpha.IAccount> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Account. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAccounts() {
// Construct request
const request = {
};
// Run request
const iterable = adminClient.listAccountsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAccounts();
listAccountsStream(request, options)
listAccountsStream(request?: protos.google.analytics.admin.v1alpha.IListAccountsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
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 Account 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 for more details and examples.
|
listAccountSummaries(request, options)
listAccountSummaries(request?: protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccountSummary[],
protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest | null,
protos.google.analytics.admin.v1alpha.IListAccountSummariesResponse
]>;
Returns summaries of all accounts accessible by the caller.
listAccountSummaries(request, options, callback)
listAccountSummaries(request: protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, protos.google.analytics.admin.v1alpha.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAccountSummary>): void;
Returns |
---|
Type | Description |
void | |
listAccountSummaries(request, callback)
listAccountSummaries(request: protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, protos.google.analytics.admin.v1alpha.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAccountSummary>): void;
Returns |
---|
Type | Description |
void | |
listAccountSummariesAsync(request, options)
listAccountSummariesAsync(request?: protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IAccountSummary>;
Equivalent to listAccountSummaries
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAccountSummaries() {
// Construct request
const request = {
};
// Run request
const iterable = adminClient.listAccountSummariesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAccountSummaries();
listAccountSummariesStream(request, options)
listAccountSummariesStream(request?: protos.google.analytics.admin.v1alpha.IListAccountSummariesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing AccountSummary 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 for more details and examples.
|
listAdSenseLinks(request, options)
listAdSenseLinks(request?: protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAdSenseLink[],
protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest | null,
protos.google.analytics.admin.v1alpha.IListAdSenseLinksResponse
]>;
Lists AdSenseLinks on a property.
listAdSenseLinks(request, options, callback)
listAdSenseLinks(request: protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, protos.google.analytics.admin.v1alpha.IListAdSenseLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAdSenseLink>): void;
Returns |
---|
Type | Description |
void | |
listAdSenseLinks(request, callback)
listAdSenseLinks(request: protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, protos.google.analytics.admin.v1alpha.IListAdSenseLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAdSenseLink>): void;
Returns |
---|
Type | Description |
void | |
listAdSenseLinksAsync(request, options)
listAdSenseLinksAsync(request?: protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IAdSenseLink>;
Equivalent to listAdSenseLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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. Resource name of the parent property.
* Format: properties/{propertyId}
* Example: 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 `ListAdSenseLinks` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAdSenseLinks` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAdSenseLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listAdSenseLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAdSenseLinks();
listAdSenseLinksStream(request, options)
listAdSenseLinksStream(request?: protos.google.analytics.admin.v1alpha.IListAdSenseLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing AdSenseLink 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 listAdSenseLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listAudiences(request, options)
listAudiences(request?: protos.google.analytics.admin.v1alpha.IListAudiencesRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAudience[],
protos.google.analytics.admin.v1alpha.IListAudiencesRequest | null,
protos.google.analytics.admin.v1alpha.IListAudiencesResponse
]>;
Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
Parameters |
---|
Name | Description |
request |
IListAudiencesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
listAudiences(request, options, callback)
listAudiences(request: protos.google.analytics.admin.v1alpha.IListAudiencesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAudiencesRequest, protos.google.analytics.admin.v1alpha.IListAudiencesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAudience>): void;
Returns |
---|
Type | Description |
void | |
listAudiences(request, callback)
listAudiences(request: protos.google.analytics.admin.v1alpha.IListAudiencesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListAudiencesRequest, protos.google.analytics.admin.v1alpha.IListAudiencesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IAudience>): void;
Returns |
---|
Type | Description |
void | |
listAudiencesAsync(request, options)
listAudiencesAsync(request?: protos.google.analytics.admin.v1alpha.IListAudiencesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IAudience>;
Equivalent to listAudiences
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters |
---|
Name | Description |
request |
IListAudiencesRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.IAudience> | {Object} An iterable Object that allows async iteration. 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 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 `ListAudiences` call. Provide this
* to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAudiences` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListAudiences() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listAudiencesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAudiences();
listAudiencesStream(request, options)
listAudiencesStream(request?: protos.google.analytics.admin.v1alpha.IListAudiencesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters |
---|
Name | Description |
request |
IListAudiencesRequest
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 listAudiencesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listBigQueryLinks(request, options)
listBigQueryLinks(request?: protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IBigQueryLink[],
protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest | null,
protos.google.analytics.admin.v1alpha.IListBigQueryLinksResponse
]>;
Lists BigQuery Links on a property.
listBigQueryLinks(request, options, callback)
listBigQueryLinks(request: protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, protos.google.analytics.admin.v1alpha.IListBigQueryLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IBigQueryLink>): void;
Returns |
---|
Type | Description |
void | |
listBigQueryLinks(request, callback)
listBigQueryLinks(request: protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, protos.google.analytics.admin.v1alpha.IListBigQueryLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IBigQueryLink>): void;
Returns |
---|
Type | Description |
void | |
listBigQueryLinksAsync(request, options)
listBigQueryLinksAsync(request?: protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IBigQueryLink>;
Equivalent to listBigQueryLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 list BigQuery links under.
* 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 `ListBigQueryLinks` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListBigQueryLinks` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListBigQueryLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listBigQueryLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListBigQueryLinks();
listBigQueryLinksStream(request, options)
listBigQueryLinksStream(request?: protos.google.analytics.admin.v1alpha.IListBigQueryLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing BigQueryLink 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 listBigQueryLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listCalculatedMetrics(request, options)
listCalculatedMetrics(request?: protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICalculatedMetric[],
protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest | null,
protos.google.analytics.admin.v1alpha.IListCalculatedMetricsResponse
]>;
Lists CalculatedMetrics on a property.
listCalculatedMetrics(request, options, callback)
listCalculatedMetrics(request: protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, protos.google.analytics.admin.v1alpha.IListCalculatedMetricsResponse | null | undefined, protos.google.analytics.admin.v1alpha.ICalculatedMetric>): void;
Returns |
---|
Type | Description |
void | |
listCalculatedMetrics(request, callback)
listCalculatedMetrics(request: protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, protos.google.analytics.admin.v1alpha.IListCalculatedMetricsResponse | null | undefined, protos.google.analytics.admin.v1alpha.ICalculatedMetric>): void;
Returns |
---|
Type | Description |
void | |
listCalculatedMetricsAsync(request, options)
listCalculatedMetricsAsync(request?: protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.ICalculatedMetric>;
Equivalent to listCalculatedMetrics
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.ICalculatedMetric> | {Object} An iterable Object that allows async iteration. 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 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'
/**
* Optional. 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
/**
* Optional. A page token, received from a previous `ListCalculatedMetrics`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListCalculatedMetrics`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListCalculatedMetrics() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listCalculatedMetricsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCalculatedMetrics();
listCalculatedMetricsStream(request, options)
listCalculatedMetricsStream(request?: protos.google.analytics.admin.v1alpha.IListCalculatedMetricsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
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 listCalculatedMetricsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listChannelGroups(request, options)
listChannelGroups(request?: protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IChannelGroup[],
protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest | null,
protos.google.analytics.admin.v1alpha.IListChannelGroupsResponse
]>;
Lists ChannelGroups on a property.
listChannelGroups(request, options, callback)
listChannelGroups(request: protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, protos.google.analytics.admin.v1alpha.IListChannelGroupsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IChannelGroup>): void;
Returns |
---|
Type | Description |
void | |
listChannelGroups(request, callback)
listChannelGroups(request: protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, protos.google.analytics.admin.v1alpha.IListChannelGroupsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IChannelGroup>): void;
Returns |
---|
Type | Description |
void | |
listChannelGroupsAsync(request, options)
listChannelGroupsAsync(request?: protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IChannelGroup>;
Equivalent to listChannelGroups
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 list ChannelGroups.
* 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 `ListChannelGroups` call. Provide
* this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListChannelGroups`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListChannelGroups() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listChannelGroupsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListChannelGroups();
listChannelGroupsStream(request, options)
listChannelGroupsStream(request?: protos.google.analytics.admin.v1alpha.IListChannelGroupsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing ChannelGroup 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 listChannelGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listConnectedSiteTags(request?: protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsResponse,
(protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsRequest | undefined),
{} | undefined
]>;
Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.
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 Universal Analytics property to fetch connected site tags for.
* This does not work on GA4 properties. A maximum of 20 connected site tags
* will be returned.
* Example Format: `properties/1234`
*/
// const property = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListConnectedSiteTags() {
// Construct request
const request = {
};
// Run request
const response = await adminClient.listConnectedSiteTags(request);
console.log(response);
}
callListConnectedSiteTags();
listConnectedSiteTags(request: protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsResponse, protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
listConnectedSiteTags(request: protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsResponse, protos.google.analytics.admin.v1alpha.IListConnectedSiteTagsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
listConversionEvents(request, options)
listConversionEvents(request?: protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IConversionEvent[],
protos.google.analytics.admin.v1alpha.IListConversionEventsRequest | null,
protos.google.analytics.admin.v1alpha.IListConversionEventsResponse
]>;
Returns a list of conversion events in the specified parent property.
Returns an empty list if no conversion events are found.
listConversionEvents(request, options, callback)
listConversionEvents(request: protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, protos.google.analytics.admin.v1alpha.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IConversionEvent>): void;
Returns |
---|
Type | Description |
void | |
listConversionEvents(request, callback)
listConversionEvents(request: protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, protos.google.analytics.admin.v1alpha.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IConversionEvent>): void;
Returns |
---|
Type | Description |
void | |
listConversionEventsAsync(request, options)
listConversionEventsAsync(request?: protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IConversionEvent>;
Equivalent to listConversionEvents
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.IConversionEvent> | {Object} An iterable Object that allows async iteration. 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 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListConversionEvents() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listConversionEventsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListConversionEvents();
listConversionEventsStream(request, options)
listConversionEventsStream(request?: protos.google.analytics.admin.v1alpha.IListConversionEventsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
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 for more details and examples.
|
listCustomDimensions(request, options)
listCustomDimensions(request?: protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomDimension[],
protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest | null,
protos.google.analytics.admin.v1alpha.IListCustomDimensionsResponse
]>;
Lists CustomDimensions on a property.
listCustomDimensions(request, options, callback)
listCustomDimensions(request: protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, protos.google.analytics.admin.v1alpha.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1alpha.ICustomDimension>): void;
Returns |
---|
Type | Description |
void | |
listCustomDimensions(request, callback)
listCustomDimensions(request: protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, protos.google.analytics.admin.v1alpha.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1alpha.ICustomDimension>): void;
Returns |
---|
Type | Description |
void | |
listCustomDimensionsAsync(request, options)
listCustomDimensionsAsync(request?: protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.ICustomDimension>;
Equivalent to listCustomDimensions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.ICustomDimension> | {Object} An iterable Object that allows async iteration. 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 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListCustomDimensions() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listCustomDimensionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCustomDimensions();
listCustomDimensionsStream(request, options)
listCustomDimensionsStream(request?: protos.google.analytics.admin.v1alpha.IListCustomDimensionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
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 for more details and examples.
|
listCustomMetrics(request, options)
listCustomMetrics(request?: protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomMetric[],
protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest | null,
protos.google.analytics.admin.v1alpha.IListCustomMetricsResponse
]>;
Lists CustomMetrics on a property.
listCustomMetrics(request, options, callback)
listCustomMetrics(request: protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, protos.google.analytics.admin.v1alpha.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1alpha.ICustomMetric>): void;
Returns |
---|
Type | Description |
void | |
listCustomMetrics(request, callback)
listCustomMetrics(request: protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, protos.google.analytics.admin.v1alpha.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1alpha.ICustomMetric>): void;
Returns |
---|
Type | Description |
void | |
listCustomMetricsAsync(request, options)
listCustomMetricsAsync(request?: protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.ICustomMetric>;
Equivalent to listCustomMetrics
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.ICustomMetric> | {Object} An iterable Object that allows async iteration. 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 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListCustomMetrics() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listCustomMetricsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCustomMetrics();
listCustomMetricsStream(request, options)
listCustomMetricsStream(request?: protos.google.analytics.admin.v1alpha.IListCustomMetricsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
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 for more details and examples.
|
listDataStreams(request, options)
listDataStreams(request?: protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataStream[],
protos.google.analytics.admin.v1alpha.IListDataStreamsRequest | null,
protos.google.analytics.admin.v1alpha.IListDataStreamsResponse
]>;
Lists DataStreams on a property.
listDataStreams(request, options, callback)
listDataStreams(request: protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, protos.google.analytics.admin.v1alpha.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IDataStream>): void;
Returns |
---|
Type | Description |
void | |
listDataStreams(request, callback)
listDataStreams(request: protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, protos.google.analytics.admin.v1alpha.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IDataStream>): void;
Returns |
---|
Type | Description |
void | |
listDataStreamsAsync(request, options)
listDataStreamsAsync(request?: protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IDataStream>;
Equivalent to listDataStreams
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.IDataStream> | {Object} An iterable Object that allows async iteration. 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 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListDataStreams() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listDataStreamsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDataStreams();
listDataStreamsStream(request, options)
listDataStreamsStream(request?: protos.google.analytics.admin.v1alpha.IListDataStreamsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
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 for more details and examples.
|
listDisplayVideo360AdvertiserLinkProposals(request, options)
listDisplayVideo360AdvertiserLinkProposals(request?: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal[],
protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest | null,
protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsResponse
]>;
Lists DisplayVideo360AdvertiserLinkProposals on a property.
listDisplayVideo360AdvertiserLinkProposals(request, options, callback)
listDisplayVideo360AdvertiserLinkProposals(request: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal>): void;
Returns |
---|
Type | Description |
void | |
listDisplayVideo360AdvertiserLinkProposals(request, callback)
listDisplayVideo360AdvertiserLinkProposals(request: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal>): void;
Returns |
---|
Type | Description |
void | |
listDisplayVideo360AdvertiserLinkProposalsAsync(request, options)
listDisplayVideo360AdvertiserLinkProposalsAsync(request?: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLinkProposal>;
Equivalent to listDisplayVideo360AdvertiserLinkProposals
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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
* `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve
* the subsequent page.
* When paginating, all other parameters provided to
* `ListDisplayVideo360AdvertiserLinkProposals` must match the call that
* provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListDisplayVideo360AdvertiserLinkProposals() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listDisplayVideo360AdvertiserLinkProposalsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDisplayVideo360AdvertiserLinkProposals();
listDisplayVideo360AdvertiserLinkProposalsStream(request, options)
listDisplayVideo360AdvertiserLinkProposalsStream(request?: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinkProposalsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing DisplayVideo360AdvertiserLinkProposal 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 listDisplayVideo360AdvertiserLinkProposalsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listDisplayVideo360AdvertiserLinks(request, options)
listDisplayVideo360AdvertiserLinks(request?: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink[],
protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest | null,
protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksResponse
]>;
Lists all DisplayVideo360AdvertiserLinks on a property.
listDisplayVideo360AdvertiserLinks(request, options, callback)
listDisplayVideo360AdvertiserLinks(request: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink>): void;
Returns |
---|
Type | Description |
void | |
listDisplayVideo360AdvertiserLinks(request, callback)
listDisplayVideo360AdvertiserLinks(request: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink>): void;
Returns |
---|
Type | Description |
void | |
listDisplayVideo360AdvertiserLinksAsync(request, options)
listDisplayVideo360AdvertiserLinksAsync(request?: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink>;
Equivalent to listDisplayVideo360AdvertiserLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 `ListDisplayVideo360AdvertiserLinks`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListDisplayVideo360AdvertiserLinks` must match the call that provided the
* page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListDisplayVideo360AdvertiserLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listDisplayVideo360AdvertiserLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListDisplayVideo360AdvertiserLinks();
listDisplayVideo360AdvertiserLinksStream(request, options)
listDisplayVideo360AdvertiserLinksStream(request?: protos.google.analytics.admin.v1alpha.IListDisplayVideo360AdvertiserLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing DisplayVideo360AdvertiserLink 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 listDisplayVideo360AdvertiserLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listEventCreateRules(request, options)
listEventCreateRules(request?: protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IEventCreateRule[],
protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest | null,
protos.google.analytics.admin.v1alpha.IListEventCreateRulesResponse
]>;
Lists EventCreateRules on a web data stream.
listEventCreateRules(request, options, callback)
listEventCreateRules(request: protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, protos.google.analytics.admin.v1alpha.IListEventCreateRulesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IEventCreateRule>): void;
Returns |
---|
Type | Description |
void | |
listEventCreateRules(request, callback)
listEventCreateRules(request: protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, protos.google.analytics.admin.v1alpha.IListEventCreateRulesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IEventCreateRule>): void;
Returns |
---|
Type | Description |
void | |
listEventCreateRulesAsync(request, options)
listEventCreateRulesAsync(request?: protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IEventCreateRule>;
Equivalent to listEventCreateRules
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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/123/dataStreams/456
*/
// 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 `ListEventCreateRules` call. Provide
* this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListEventCreateRules`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListEventCreateRules() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listEventCreateRulesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEventCreateRules();
listEventCreateRulesStream(request, options)
listEventCreateRulesStream(request?: protos.google.analytics.admin.v1alpha.IListEventCreateRulesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing EventCreateRule 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 listEventCreateRulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listExpandedDataSets(request, options)
listExpandedDataSets(request?: protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IExpandedDataSet[],
protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest | null,
protos.google.analytics.admin.v1alpha.IListExpandedDataSetsResponse
]>;
Lists ExpandedDataSets on a property.
listExpandedDataSets(request, options, callback)
listExpandedDataSets(request: protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, protos.google.analytics.admin.v1alpha.IListExpandedDataSetsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IExpandedDataSet>): void;
Returns |
---|
Type | Description |
void | |
listExpandedDataSets(request, callback)
listExpandedDataSets(request: protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, protos.google.analytics.admin.v1alpha.IListExpandedDataSetsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IExpandedDataSet>): void;
Returns |
---|
Type | Description |
void | |
listExpandedDataSetsAsync(request, options)
listExpandedDataSetsAsync(request?: protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IExpandedDataSet>;
Equivalent to listExpandedDataSets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 `ListExpandedDataSets` call. Provide
* this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListExpandedDataSet`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListExpandedDataSets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listExpandedDataSetsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListExpandedDataSets();
listExpandedDataSetsStream(request, options)
listExpandedDataSetsStream(request?: protos.google.analytics.admin.v1alpha.IListExpandedDataSetsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing ExpandedDataSet 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 listExpandedDataSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listFirebaseLinks(request, options)
listFirebaseLinks(request?: protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IFirebaseLink[],
protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest | null,
protos.google.analytics.admin.v1alpha.IListFirebaseLinksResponse
]>;
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
listFirebaseLinks(request, options, callback)
listFirebaseLinks(request: protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, protos.google.analytics.admin.v1alpha.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IFirebaseLink>): void;
Returns |
---|
Type | Description |
void | |
listFirebaseLinks(request, callback)
listFirebaseLinks(request: protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, protos.google.analytics.admin.v1alpha.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IFirebaseLink>): void;
Returns |
---|
Type | Description |
void | |
listFirebaseLinksAsync(request, options)
listFirebaseLinksAsync(request?: protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IFirebaseLink>;
Equivalent to listFirebaseLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 `ListFirebaseLinks` must
* match the call that provided the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListFirebaseLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listFirebaseLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListFirebaseLinks();
listFirebaseLinksStream(request, options)
listFirebaseLinksStream(request?: protos.google.analytics.admin.v1alpha.IListFirebaseLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing FirebaseLink 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 for more details and examples.
|
listGoogleAdsLinks(request, options)
listGoogleAdsLinks(request?: protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IGoogleAdsLink[],
protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest | null,
protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksResponse
]>;
Lists GoogleAdsLinks on a property.
listGoogleAdsLinks(request, options, callback)
listGoogleAdsLinks(request: protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IGoogleAdsLink>): void;
Returns |
---|
Type | Description |
void | |
listGoogleAdsLinks(request, callback)
listGoogleAdsLinks(request: protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IGoogleAdsLink>): void;
Returns |
---|
Type | Description |
void | |
listGoogleAdsLinksAsync(request, options)
listGoogleAdsLinksAsync(request?: protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IGoogleAdsLink>;
Equivalent to listGoogleAdsLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListGoogleAdsLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listGoogleAdsLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListGoogleAdsLinks();
listGoogleAdsLinksStream(request, options)
listGoogleAdsLinksStream(request?: protos.google.analytics.admin.v1alpha.IListGoogleAdsLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing GoogleAdsLink 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 for more details and examples.
|
listMeasurementProtocolSecrets(request, options)
listMeasurementProtocolSecrets(request?: protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret[],
protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest | null,
protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsResponse
]>;
Returns child MeasurementProtocolSecrets under the specified parent Property.
listMeasurementProtocolSecrets(request, options, callback)
listMeasurementProtocolSecrets(request: protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret>): void;
Returns |
---|
Type | Description |
void | |
listMeasurementProtocolSecrets(request, callback)
listMeasurementProtocolSecrets(request: protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret>): void;
Returns |
---|
Type | Description |
void | |
listMeasurementProtocolSecretsAsync(request, options)
listMeasurementProtocolSecretsAsync(request?: protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret>;
Equivalent to listMeasurementProtocolSecrets
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListMeasurementProtocolSecrets() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listMeasurementProtocolSecretsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListMeasurementProtocolSecrets();
listMeasurementProtocolSecretsStream(request, options)
listMeasurementProtocolSecretsStream(request?: protos.google.analytics.admin.v1alpha.IListMeasurementProtocolSecretsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing MeasurementProtocolSecret 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 for more details and examples.
|
listProperties(request, options)
listProperties(request?: protos.google.analytics.admin.v1alpha.IListPropertiesRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IProperty[],
protos.google.analytics.admin.v1alpha.IListPropertiesRequest | null,
protos.google.analytics.admin.v1alpha.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.
listProperties(request, options, callback)
listProperties(request: protos.google.analytics.admin.v1alpha.IListPropertiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListPropertiesRequest, protos.google.analytics.admin.v1alpha.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IProperty>): void;
Returns |
---|
Type | Description |
void | |
listProperties(request, callback)
listProperties(request: protos.google.analytics.admin.v1alpha.IListPropertiesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListPropertiesRequest, protos.google.analytics.admin.v1alpha.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1alpha.IProperty>): void;
Returns |
---|
Type | Description |
void | |
listPropertiesAsync(request, options)
listPropertiesAsync(request?: protos.google.analytics.admin.v1alpha.IListPropertiesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IProperty>;
Equivalent to listProperties
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Returns |
---|
Type | Description |
AsyncIterable<protos.google.analytics.admin.v1alpha.IProperty> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Property. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListProperties() {
// Construct request
const request = {
filter,
};
// Run request
const iterable = adminClient.listPropertiesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProperties();
listPropertiesStream(request, options)
listPropertiesStream(request?: protos.google.analytics.admin.v1alpha.IListPropertiesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing Property 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 for more details and examples.
|
listRollupPropertySourceLinks(request, options)
listRollupPropertySourceLinks(request?: protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink[],
protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest | null,
protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksResponse
]>;
Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.
listRollupPropertySourceLinks(request, options, callback)
listRollupPropertySourceLinks(request: protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink>): void;
Returns |
---|
Type | Description |
void | |
listRollupPropertySourceLinks(request, callback)
listRollupPropertySourceLinks(request: protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink>): void;
Returns |
---|
Type | Description |
void | |
listRollupPropertySourceLinksAsync(request, options)
listRollupPropertySourceLinksAsync(request?: protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IRollupPropertySourceLink>;
Equivalent to listRollupPropertySourceLinks
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 roll-up property to list roll-up property source
* links under. Format: properties/{property_id} Example: properties/1234
*/
// const parent = 'abc123'
/**
* Optional. 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
/**
* Optional. A page token, received from a previous
* `ListRollupPropertySourceLinks` call. Provide this to retrieve the
* subsequent page. When paginating, all other parameters provided to
* `ListRollupPropertySourceLinks` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListRollupPropertySourceLinks() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listRollupPropertySourceLinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListRollupPropertySourceLinks();
listRollupPropertySourceLinksStream(request, options)
listRollupPropertySourceLinksStream(request?: protos.google.analytics.admin.v1alpha.IListRollupPropertySourceLinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing RollupPropertySourceLink 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 listRollupPropertySourceLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listSearchAds360Links(request, options)
listSearchAds360Links(request?: protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISearchAds360Link[],
protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest | null,
protos.google.analytics.admin.v1alpha.IListSearchAds360LinksResponse
]>;
Lists all SearchAds360Links on a property.
listSearchAds360Links(request, options, callback)
listSearchAds360Links(request: protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, protos.google.analytics.admin.v1alpha.IListSearchAds360LinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.ISearchAds360Link>): void;
Returns |
---|
Type | Description |
void | |
listSearchAds360Links(request, callback)
listSearchAds360Links(request: protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, protos.google.analytics.admin.v1alpha.IListSearchAds360LinksResponse | null | undefined, protos.google.analytics.admin.v1alpha.ISearchAds360Link>): void;
Returns |
---|
Type | Description |
void | |
listSearchAds360LinksAsync(request, options)
listSearchAds360LinksAsync(request?: protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.ISearchAds360Link>;
Equivalent to listSearchAds360Links
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 `ListSearchAds360Links`
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* `ListSearchAds360Links` must match the call that provided the
* page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListSearchAds360Links() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listSearchAds360LinksAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSearchAds360Links();
listSearchAds360LinksStream(request, options)
listSearchAds360LinksStream(request?: protos.google.analytics.admin.v1alpha.IListSearchAds360LinksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing SearchAds360Link 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 listSearchAds360LinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listSKAdNetworkConversionValueSchemas(request, options)
listSKAdNetworkConversionValueSchemas(request?: protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema[],
protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest | null,
protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasResponse
]>;
Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema.
listSKAdNetworkConversionValueSchemas(request, options, callback)
listSKAdNetworkConversionValueSchemas(request: protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasResponse | null | undefined, protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema>): void;
Returns |
---|
Type | Description |
void | |
listSKAdNetworkConversionValueSchemas(request, callback)
listSKAdNetworkConversionValueSchemas(request: protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasResponse | null | undefined, protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema>): void;
Returns |
---|
Type | Description |
void | |
listSKAdNetworkConversionValueSchemasAsync(request, options)
listSKAdNetworkConversionValueSchemasAsync(request?: protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema>;
Equivalent to listSKAdNetworkConversionValueSchemas
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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 DataStream resource to list schemas for.
* Format:
* properties/{property_id}/dataStreams/{dataStream}
* Example: properties/1234/dataStreams/5678
*/
// 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
* `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the
* subsequent page. When paginating, all other parameters provided to
* `ListSKAdNetworkConversionValueSchema` must match the call that provided
* the page token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListSKAdNetworkConversionValueSchemas() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listSKAdNetworkConversionValueSchemasAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSKAdNetworkConversionValueSchemas();
listSKAdNetworkConversionValueSchemasStream(request, options)
listSKAdNetworkConversionValueSchemasStream(request?: protos.google.analytics.admin.v1alpha.IListSKAdNetworkConversionValueSchemasRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing SKAdNetworkConversionValueSchema 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 listSKAdNetworkConversionValueSchemasAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
listSubpropertyEventFilters(request, options)
listSubpropertyEventFilters(request?: protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter[],
protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest | null,
protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersResponse
]>;
List all subproperty Event Filters on a property.
listSubpropertyEventFilters(request, options, callback)
listSubpropertyEventFilters(request: protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersResponse | null | undefined, protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter>): void;
Returns |
---|
Type | Description |
void | |
listSubpropertyEventFilters(request, callback)
listSubpropertyEventFilters(request: protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersResponse | null | undefined, protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter>): void;
Returns |
---|
Type | Description |
void | |
listSubpropertyEventFiltersAsync(request, options)
listSubpropertyEventFiltersAsync(request?: protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter>;
Equivalent to listSubpropertyEventFilters
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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. Resource name of the ordinary property.
* Format: properties/property_id
* Example: properties/123
*/
// const parent = 'abc123'
/**
* Optional. 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
/**
* Optional. A page token, received from a previous
* `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent
* page. When paginating, all other parameters provided to
* `ListSubpropertyEventFilters` must match the call that provided the page
* token.
*/
// const pageToken = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callListSubpropertyEventFilters() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = adminClient.listSubpropertyEventFiltersAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSubpropertyEventFilters();
listSubpropertyEventFiltersStream(request?: protos.google.analytics.admin.v1alpha.IListSubpropertyEventFiltersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing SubpropertyEventFilter 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 listSubpropertyEventFiltersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.
|
matchAccessBindingFromAccountAccessBindingName(accountAccessBindingName)
matchAccessBindingFromAccountAccessBindingName(accountAccessBindingName: string): string | number;
Parse the access_binding from AccountAccessBinding resource.
Parameter |
---|
Name | Description |
accountAccessBindingName |
string
A fully-qualified path representing account_access_binding resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the access_binding.
|
matchAccessBindingFromPropertyAccessBindingName(propertyAccessBindingName)
matchAccessBindingFromPropertyAccessBindingName(propertyAccessBindingName: string): string | number;
Parse the access_binding from PropertyAccessBinding resource.
Parameter |
---|
Name | Description |
propertyAccessBindingName |
string
A fully-qualified path representing property_access_binding resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the access_binding.
|
matchAccountFromAccountAccessBindingName(accountAccessBindingName)
matchAccountFromAccountAccessBindingName(accountAccessBindingName: string): string | number;
Parse the account from AccountAccessBinding resource.
Parameter |
---|
Name | Description |
accountAccessBindingName |
string
A fully-qualified path representing account_access_binding resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the account.
|
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.
|
matchAdsenseLinkFromAdSenseLinkName(adSenseLinkName)
matchAdsenseLinkFromAdSenseLinkName(adSenseLinkName: string): string | number;
Parse the adsense_link from AdSenseLink resource.
Parameter |
---|
Name | Description |
adSenseLinkName |
string
A fully-qualified path representing AdSenseLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the adsense_link.
|
matchAudienceFromAudienceName(audienceName)
matchAudienceFromAudienceName(audienceName: string): string | number;
Parse the audience from Audience resource.
Parameter |
---|
Name | Description |
audienceName |
string
A fully-qualified path representing Audience resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the audience.
|
matchBigqueryLinkFromBigQueryLinkName(bigQueryLinkName)
matchBigqueryLinkFromBigQueryLinkName(bigQueryLinkName: string): string | number;
Parse the bigquery_link from BigQueryLink resource.
Parameter |
---|
Name | Description |
bigQueryLinkName |
string
A fully-qualified path representing BigQueryLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the bigquery_link.
|
matchCalculatedMetricFromCalculatedMetricName(calculatedMetricName)
matchCalculatedMetricFromCalculatedMetricName(calculatedMetricName: string): string | number;
Parse the calculated_metric from CalculatedMetric resource.
Parameter |
---|
Name | Description |
calculatedMetricName |
string
A fully-qualified path representing CalculatedMetric resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the calculated_metric.
|
matchChannelGroupFromChannelGroupName(channelGroupName)
matchChannelGroupFromChannelGroupName(channelGroupName: string): string | number;
Parse the channel_group from ChannelGroup resource.
Parameter |
---|
Name | Description |
channelGroupName |
string
A fully-qualified path representing ChannelGroup resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the channel_group.
|
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.
|
matchDataStreamFromDataRedactionSettingsName(dataRedactionSettingsName)
matchDataStreamFromDataRedactionSettingsName(dataRedactionSettingsName: string): string | number;
Parse the data_stream from DataRedactionSettings resource.
Parameter |
---|
Name | Description |
dataRedactionSettingsName |
string
A fully-qualified path representing DataRedactionSettings resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the data_stream.
|
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.
|
matchDataStreamFromEnhancedMeasurementSettingsName(enhancedMeasurementSettingsName)
matchDataStreamFromEnhancedMeasurementSettingsName(enhancedMeasurementSettingsName: string): string | number;
Parse the data_stream from EnhancedMeasurementSettings resource.
Parameter |
---|
Name | Description |
enhancedMeasurementSettingsName |
string
A fully-qualified path representing EnhancedMeasurementSettings resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the data_stream.
|
matchDataStreamFromEventCreateRuleName(eventCreateRuleName)
matchDataStreamFromEventCreateRuleName(eventCreateRuleName: string): string | number;
Parse the data_stream from EventCreateRule resource.
Parameter |
---|
Name | Description |
eventCreateRuleName |
string
A fully-qualified path representing EventCreateRule resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the data_stream.
|
matchDataStreamFromGlobalSiteTagName(globalSiteTagName)
matchDataStreamFromGlobalSiteTagName(globalSiteTagName: string): string | number;
Parse the data_stream from GlobalSiteTag resource.
Parameter |
---|
Name | Description |
globalSiteTagName |
string
A fully-qualified path representing GlobalSiteTag 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.
|
matchDataStreamFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName)
matchDataStreamFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName: string): string | number;
Parse the data_stream from SKAdNetworkConversionValueSchema resource.
Parameter |
---|
Name | Description |
sKAdNetworkConversionValueSchemaName |
string
A fully-qualified path representing SKAdNetworkConversionValueSchema resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the data_stream.
|
matchEventCreateRuleFromEventCreateRuleName(eventCreateRuleName)
matchEventCreateRuleFromEventCreateRuleName(eventCreateRuleName: string): string | number;
Parse the event_create_rule from EventCreateRule resource.
Parameter |
---|
Name | Description |
eventCreateRuleName |
string
A fully-qualified path representing EventCreateRule resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the event_create_rule.
|
matchExpandedDataSetFromExpandedDataSetName(expandedDataSetName)
matchExpandedDataSetFromExpandedDataSetName(expandedDataSetName: string): string | number;
Parse the expanded_data_set from ExpandedDataSet resource.
Parameter |
---|
Name | Description |
expandedDataSetName |
string
A fully-qualified path representing ExpandedDataSet resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the expanded_data_set.
|
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.
|
matchPropertyFromAdSenseLinkName(adSenseLinkName)
matchPropertyFromAdSenseLinkName(adSenseLinkName: string): string | number;
Parse the property from AdSenseLink resource.
Parameter |
---|
Name | Description |
adSenseLinkName |
string
A fully-qualified path representing AdSenseLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromAttributionSettingsName(attributionSettingsName)
matchPropertyFromAttributionSettingsName(attributionSettingsName: string): string | number;
Parse the property from AttributionSettings resource.
Parameter |
---|
Name | Description |
attributionSettingsName |
string
A fully-qualified path representing AttributionSettings resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromAudienceName(audienceName)
matchPropertyFromAudienceName(audienceName: string): string | number;
Parse the property from Audience resource.
Parameter |
---|
Name | Description |
audienceName |
string
A fully-qualified path representing Audience resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromBigQueryLinkName(bigQueryLinkName)
matchPropertyFromBigQueryLinkName(bigQueryLinkName: string): string | number;
Parse the property from BigQueryLink resource.
Parameter |
---|
Name | Description |
bigQueryLinkName |
string
A fully-qualified path representing BigQueryLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromCalculatedMetricName(calculatedMetricName)
matchPropertyFromCalculatedMetricName(calculatedMetricName: string): string | number;
Parse the property from CalculatedMetric resource.
Parameter |
---|
Name | Description |
calculatedMetricName |
string
A fully-qualified path representing CalculatedMetric resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromChannelGroupName(channelGroupName)
matchPropertyFromChannelGroupName(channelGroupName: string): string | number;
Parse the property from ChannelGroup resource.
Parameter |
---|
Name | Description |
channelGroupName |
string
A fully-qualified path representing ChannelGroup resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
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.
|
matchPropertyFromDataRedactionSettingsName(dataRedactionSettingsName)
matchPropertyFromDataRedactionSettingsName(dataRedactionSettingsName: string): string | number;
Parse the property from DataRedactionSettings resource.
Parameter |
---|
Name | Description |
dataRedactionSettingsName |
string
A fully-qualified path representing DataRedactionSettings 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.
|
matchPropertyFromDisplayVideo360AdvertiserLinkName(displayVideo360AdvertiserLinkName)
matchPropertyFromDisplayVideo360AdvertiserLinkName(displayVideo360AdvertiserLinkName: string): string | number;
Parse the property from DisplayVideo360AdvertiserLink resource.
Parameter |
---|
Name | Description |
displayVideo360AdvertiserLinkName |
string
A fully-qualified path representing DisplayVideo360AdvertiserLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromDisplayVideo360AdvertiserLinkProposalName(displayVideo360AdvertiserLinkProposalName)
matchPropertyFromDisplayVideo360AdvertiserLinkProposalName(displayVideo360AdvertiserLinkProposalName: string): string | number;
Parse the property from DisplayVideo360AdvertiserLinkProposal resource.
Parameter |
---|
Name | Description |
displayVideo360AdvertiserLinkProposalName |
string
A fully-qualified path representing DisplayVideo360AdvertiserLinkProposal resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromEnhancedMeasurementSettingsName(enhancedMeasurementSettingsName)
matchPropertyFromEnhancedMeasurementSettingsName(enhancedMeasurementSettingsName: string): string | number;
Parse the property from EnhancedMeasurementSettings resource.
Parameter |
---|
Name | Description |
enhancedMeasurementSettingsName |
string
A fully-qualified path representing EnhancedMeasurementSettings resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromEventCreateRuleName(eventCreateRuleName)
matchPropertyFromEventCreateRuleName(eventCreateRuleName: string): string | number;
Parse the property from EventCreateRule resource.
Parameter |
---|
Name | Description |
eventCreateRuleName |
string
A fully-qualified path representing EventCreateRule resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromExpandedDataSetName(expandedDataSetName)
matchPropertyFromExpandedDataSetName(expandedDataSetName: string): string | number;
Parse the property from ExpandedDataSet resource.
Parameter |
---|
Name | Description |
expandedDataSetName |
string
A fully-qualified path representing ExpandedDataSet 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.
|
matchPropertyFromGlobalSiteTagName(globalSiteTagName)
matchPropertyFromGlobalSiteTagName(globalSiteTagName: string): string | number;
Parse the property from GlobalSiteTag resource.
Parameter |
---|
Name | Description |
globalSiteTagName |
string
A fully-qualified path representing GlobalSiteTag 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.
|
matchPropertyFromGoogleSignalsSettingsName(googleSignalsSettingsName)
matchPropertyFromGoogleSignalsSettingsName(googleSignalsSettingsName: string): string | number;
Parse the property from GoogleSignalsSettings resource.
Parameter |
---|
Name | Description |
googleSignalsSettingsName |
string
A fully-qualified path representing GoogleSignalsSettings 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.
|
matchPropertyFromPropertyAccessBindingName(propertyAccessBindingName)
matchPropertyFromPropertyAccessBindingName(propertyAccessBindingName: string): string | number;
Parse the property from PropertyAccessBinding resource.
Parameter |
---|
Name | Description |
propertyAccessBindingName |
string
A fully-qualified path representing property_access_binding 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.
|
matchPropertyFromRollupPropertySourceLinkName(rollupPropertySourceLinkName)
matchPropertyFromRollupPropertySourceLinkName(rollupPropertySourceLinkName: string): string | number;
Parse the property from RollupPropertySourceLink resource.
Parameter |
---|
Name | Description |
rollupPropertySourceLinkName |
string
A fully-qualified path representing RollupPropertySourceLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromSearchAds360LinkName(searchAds360LinkName)
matchPropertyFromSearchAds360LinkName(searchAds360LinkName: string): string | number;
Parse the property from SearchAds360Link resource.
Parameter |
---|
Name | Description |
searchAds360LinkName |
string
A fully-qualified path representing SearchAds360Link resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName)
matchPropertyFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName: string): string | number;
Parse the property from SKAdNetworkConversionValueSchema resource.
Parameter |
---|
Name | Description |
sKAdNetworkConversionValueSchemaName |
string
A fully-qualified path representing SKAdNetworkConversionValueSchema resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchPropertyFromSubpropertyEventFilterName(subpropertyEventFilterName)
matchPropertyFromSubpropertyEventFilterName(subpropertyEventFilterName: string): string | number;
Parse the property from SubpropertyEventFilter resource.
Parameter |
---|
Name | Description |
subpropertyEventFilterName |
string
A fully-qualified path representing SubpropertyEventFilter resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the property.
|
matchRollupPropertySourceLinkFromRollupPropertySourceLinkName(rollupPropertySourceLinkName)
matchRollupPropertySourceLinkFromRollupPropertySourceLinkName(rollupPropertySourceLinkName: string): string | number;
Parse the rollup_property_source_link from RollupPropertySourceLink resource.
Parameter |
---|
Name | Description |
rollupPropertySourceLinkName |
string
A fully-qualified path representing RollupPropertySourceLink resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the rollup_property_source_link.
|
matchSkadnetworkConversionValueSchemaFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName)
matchSkadnetworkConversionValueSchemaFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName: string): string | number;
Parse the skadnetwork_conversion_value_schema from SKAdNetworkConversionValueSchema resource.
Parameter |
---|
Name | Description |
sKAdNetworkConversionValueSchemaName |
string
A fully-qualified path representing SKAdNetworkConversionValueSchema resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the skadnetwork_conversion_value_schema.
|
matchSubPropertyEventFilterFromSubpropertyEventFilterName(subpropertyEventFilterName)
matchSubPropertyEventFilterFromSubpropertyEventFilterName(subpropertyEventFilterName: string): string | number;
Parse the sub_property_event_filter from SubpropertyEventFilter resource.
Parameter |
---|
Name | Description |
subpropertyEventFilterName |
string
A fully-qualified path representing SubpropertyEventFilter resource.
|
Returns |
---|
Type | Description |
string | number | {string} A string representing the sub_property_event_filter.
|
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.
|
propertyAccessBindingPath(property, accessBinding)
propertyAccessBindingPath(property: string, accessBinding: string): string;
Return a fully-qualified propertyAccessBinding resource name string.
Parameters |
---|
Name | Description |
property |
string
|
accessBinding |
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.v1alpha.IProvisionAccountTicketRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IProvisionAccountTicketResponse,
(protos.google.analytics.admin.v1alpha.IProvisionAccountTicketRequest | undefined),
{} | undefined
]>;
Requests a ticket for creating an account.
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 Cloud Console as a Redirect URI.
*/
// const redirectUri = 'abc123'
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// 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.v1alpha.IProvisionAccountTicketRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1alpha.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
provisionAccountTicket(request, callback)
provisionAccountTicket(request: protos.google.analytics.admin.v1alpha.IProvisionAccountTicketRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1alpha.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
rollupPropertySourceLinkPath(property, rollupPropertySourceLink)
rollupPropertySourceLinkPath(property: string, rollupPropertySourceLink: string): string;
Return a fully-qualified rollupPropertySourceLink resource name string.
Parameters |
---|
Name | Description |
property |
string
|
rollupPropertySourceLink |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
runAccessReport(request, options)
runAccessReport(request?: protos.google.analytics.admin.v1alpha.IRunAccessReportRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IRunAccessReportResponse,
protos.google.analytics.admin.v1alpha.IRunAccessReportRequest | undefined,
{} | undefined
]>;
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years.
Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators.
These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
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 Data Access Report supports requesting at the property level or account
* level. If requested at the account level, Data Access Reports include all
* access for all properties under that account.
* To request at the property level, entity should be for example
* 'properties/123' if "123" is your GA4 property ID. To request at the
* account level, entity should be for example 'accounts/1234' if "1234" is
* your GA4 Account ID.
*/
// const entity = 'abc123'
/**
* The dimensions requested and displayed in the response. Requests are
* allowed up to 9 dimensions.
*/
// const dimensions = [1,2,3,4]
/**
* The metrics requested and displayed in the response. Requests are allowed
* up to 10 metrics.
*/
// const metrics = [1,2,3,4]
/**
* Date ranges of access records to read. If multiple date ranges are
* requested, each response row will contain a zero based date range index. If
* two date ranges overlap, the access records for the overlapping days is
* included in the response rows for both date ranges. Requests are allowed up
* to 2 date ranges.
*/
// const dateRanges = [1,2,3,4]
/**
* Dimension filters let you restrict report response to specific
* dimension values which match the filter. For example, filtering on access
* records of a single user. To learn more, see Fundamentals of Dimension
* Filters (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
* for examples. Metrics cannot be used in this filter.
*/
// const dimensionFilter = {}
/**
* Metric filters allow you to restrict report response to specific metric
* values which match the filter. Metric filters are applied after aggregating
* the report's rows, similar to SQL having-clause. Dimensions cannot be used
* in this filter.
*/
// const metricFilter = {}
/**
* The row count of the start row. The first row is counted as row 0. If
* offset is unspecified, it is treated as 0. If offset is zero, then this
* method will return the first page of results with `limit` entries.
* To learn more about this pagination parameter, see
* Pagination (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*/
// const offset = 1234
/**
* The number of rows to return. If unspecified, 10,000 rows are returned. The
* API returns a maximum of 100,000 rows per request, no matter how many you
* ask for. `limit` must be positive.
* The API may return fewer rows than the requested `limit`, if there aren't
* as many remaining rows as the `limit`. For instance, there are fewer than
* 300 possible values for the dimension `country`, so when reporting on only
* `country`, you can't get more than 300 rows, even if you set `limit` to a
* higher value.
* To learn more about this pagination parameter, see
* Pagination (https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
*/
// const limit = 1234
/**
* This request's time zone if specified. If unspecified, the property's time
* zone is used. The request's time zone is used to interpret the start & end
* dates of the report.
* Formatted as strings from the IANA Time Zone database
* (https://www.iana.org/time-zones); for example "America/New_York" or
* "Asia/Tokyo".
*/
// const timeZone = 'abc123'
/**
* Specifies how rows are ordered in the response.
*/
// const orderBys = [1,2,3,4]
/**
* Toggles whether to return the current state of this Analytics Property's
* quota. Quota is returned in AccessQuota (#AccessQuota). For account-level
* requests, this field must be false.
*/
// const returnEntityQuota = true
/**
* Optional. Determines whether to include users who have never made an API
* call in the response. If true, all users with access to the specified
* property or account are included in the response, regardless of whether
* they have made an API call or not. If false, only the users who have made
* an API call will be included.
*/
// const includeAllUsers = true
/**
* Optional. Decides whether to return the users within user groups. This
* field works only when include_all_users is set to true. If true, it will
* return all users with access to the specified property or account.
* If false, only the users with direct access will be returned.
*/
// const expandGroups = true
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callRunAccessReport() {
// Construct request
const request = {
};
// Run request
const response = await adminClient.runAccessReport(request);
console.log(response);
}
callRunAccessReport();
runAccessReport(request, options, callback)
runAccessReport(request: protos.google.analytics.admin.v1alpha.IRunAccessReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IRunAccessReportResponse, protos.google.analytics.admin.v1alpha.IRunAccessReportRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
runAccessReport(request, callback)
runAccessReport(request: protos.google.analytics.admin.v1alpha.IRunAccessReportRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IRunAccessReportResponse, protos.google.analytics.admin.v1alpha.IRunAccessReportRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
searchAds360LinkPath(property)
searchAds360LinkPath(property: string): string;
Return a fully-qualified searchAds360Link resource name string.
Parameter |
---|
Name | Description |
property |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
searchChangeHistoryEvents(request, options)
searchChangeHistoryEvents(request?: protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IChangeHistoryEvent[],
protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest | null,
protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsResponse
]>;
Searches through all changes to an account or its children given the specified set of filters.
searchChangeHistoryEvents(request, options, callback)
searchChangeHistoryEvents(request: protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IChangeHistoryEvent>): void;
Returns |
---|
Type | Description |
void | |
searchChangeHistoryEvents(request, callback)
searchChangeHistoryEvents(request: protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1alpha.IChangeHistoryEvent>): void;
Returns |
---|
Type | Description |
void | |
searchChangeHistoryEventsAsync(request, options)
searchChangeHistoryEventsAsync(request?: protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1alpha.IChangeHistoryEvent>;
Equivalent to searchChangeHistoryEvents
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
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. Format: accounts/{account} Example: "accounts/100"
*/
// const account = 'abc123'
/**
* Optional. Resource name for a child property. If set, only return changes
* made to this property or its child resources.
* Format: properties/{propertyId}
* Example: "properties/100"
*/
// 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 = [1,2,3,4]
/**
* Optional. If set, only return changes that match one or more of these types
* of actions.
*/
// const action = [1,2,3,4]
/**
* Optional. If set, only return changes if they are made by a user in this
* list.
*/
// const actorEmail = ['abc','def']
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callSearchChangeHistoryEvents() {
// Construct request
const request = {
account,
};
// Run request
const iterable = adminClient.searchChangeHistoryEventsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callSearchChangeHistoryEvents();
searchChangeHistoryEventsStream(request, options)
searchChangeHistoryEventsStream(request?: protos.google.analytics.admin.v1alpha.ISearchChangeHistoryEventsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Returns |
---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing ChangeHistoryEvent 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 for more details and examples.
|
setAutomatedGa4ConfigurationOptOut(request, options)
setAutomatedGa4ConfigurationOptOut(request?: protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutResponse,
(protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutRequest | undefined),
{} | undefined
]>;
Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
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 UA property to set the opt out status. Note this request uses
* the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
* Format: properties/{internalWebPropertyId}
* Example: properties/1234
*/
// const property = 'abc123'
/**
* The status to set.
*/
// const optOut = true
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callSetAutomatedGa4ConfigurationOptOut() {
// Construct request
const request = {
property,
};
// Run request
const response = await adminClient.setAutomatedGa4ConfigurationOptOut(request);
console.log(response);
}
callSetAutomatedGa4ConfigurationOptOut();
setAutomatedGa4ConfigurationOptOut(request, options, callback)
setAutomatedGa4ConfigurationOptOut(request: protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutResponse, protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
setAutomatedGa4ConfigurationOptOut(request, callback)
setAutomatedGa4ConfigurationOptOut(request: protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutResponse, protos.google.analytics.admin.v1alpha.ISetAutomatedGa4ConfigurationOptOutRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
sKAdNetworkConversionValueSchemaPath(property, dataStream, skadnetworkConversionValueSchema)
sKAdNetworkConversionValueSchemaPath(property: string, dataStream: string, skadnetworkConversionValueSchema: string): string;
Return a fully-qualified sKAdNetworkConversionValueSchema resource name string.
Parameters |
---|
Name | Description |
property |
string
|
dataStream |
string
|
skadnetworkConversionValueSchema |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
subpropertyEventFilterPath(property, subPropertyEventFilter)
subpropertyEventFilterPath(property: string, subPropertyEventFilter: string): string;
Return a fully-qualified subpropertyEventFilter resource name string.
Parameters |
---|
Name | Description |
property |
string
|
subPropertyEventFilter |
string
|
Returns |
---|
Type | Description |
string | {string} Resource name string.
|
updateAccessBinding(request, options)
updateAccessBinding(request?: protos.google.analytics.admin.v1alpha.IUpdateAccessBindingRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccessBinding,
(protos.google.analytics.admin.v1alpha.IUpdateAccessBindingRequest | undefined),
{} | undefined
]>;
Updates an access binding on an account or property.
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 access binding to update.
*/
// const accessBinding = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateAccessBinding() {
// Construct request
const request = {
accessBinding,
};
// Run request
const response = await adminClient.updateAccessBinding(request);
console.log(response);
}
callUpdateAccessBinding();
updateAccessBinding(request, options, callback)
updateAccessBinding(request: protos.google.analytics.admin.v1alpha.IUpdateAccessBindingRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAccessBinding, protos.google.analytics.admin.v1alpha.IUpdateAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAccessBinding(request, callback)
updateAccessBinding(request: protos.google.analytics.admin.v1alpha.IUpdateAccessBindingRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAccessBinding, protos.google.analytics.admin.v1alpha.IUpdateAccessBindingRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAccount(request, options)
updateAccount(request?: protos.google.analytics.admin.v1alpha.IUpdateAccountRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAccount,
protos.google.analytics.admin.v1alpha.IUpdateAccountRequest | undefined,
{} | undefined
]>;
Parameters |
---|
Name | Description |
request |
IUpdateAccountRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
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 (for example, "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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdateAccountRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAccount, protos.google.analytics.admin.v1alpha.IUpdateAccountRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAccount(request, callback)
updateAccount(request: protos.google.analytics.admin.v1alpha.IUpdateAccountRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAccount, protos.google.analytics.admin.v1alpha.IUpdateAccountRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAttributionSettings(request, options)
updateAttributionSettings(request?: protos.google.analytics.admin.v1alpha.IUpdateAttributionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAttributionSettings,
(protos.google.analytics.admin.v1alpha.IUpdateAttributionSettingsRequest | undefined),
{} | undefined
]>;
Updates attribution settings on a property.
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 attribution settings to update.
* The `name` field is used to identify the settings to be updated.
*/
// const attributionSettings = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateAttributionSettings() {
// Construct request
const request = {
attributionSettings,
updateMask,
};
// Run request
const response = await adminClient.updateAttributionSettings(request);
console.log(response);
}
callUpdateAttributionSettings();
updateAttributionSettings(request, options, callback)
updateAttributionSettings(request: protos.google.analytics.admin.v1alpha.IUpdateAttributionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAttributionSettings, protos.google.analytics.admin.v1alpha.IUpdateAttributionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAttributionSettings(request, callback)
updateAttributionSettings(request: protos.google.analytics.admin.v1alpha.IUpdateAttributionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAttributionSettings, protos.google.analytics.admin.v1alpha.IUpdateAttributionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAudience(request, options)
updateAudience(request?: protos.google.analytics.admin.v1alpha.IUpdateAudienceRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IAudience,
protos.google.analytics.admin.v1alpha.IUpdateAudienceRequest | undefined,
{} | undefined
]>;
Updates an Audience on a property.
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 audience to update.
* The audience's `name` field is used to identify the audience to be updated.
*/
// const audience = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateAudience() {
// Construct request
const request = {
audience,
updateMask,
};
// Run request
const response = await adminClient.updateAudience(request);
console.log(response);
}
callUpdateAudience();
updateAudience(request, options, callback)
updateAudience(request: protos.google.analytics.admin.v1alpha.IUpdateAudienceRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IAudience, protos.google.analytics.admin.v1alpha.IUpdateAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateAudience(request, callback)
updateAudience(request: protos.google.analytics.admin.v1alpha.IUpdateAudienceRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IAudience, protos.google.analytics.admin.v1alpha.IUpdateAudienceRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateCalculatedMetric(request, options)
updateCalculatedMetric(request?: protos.google.analytics.admin.v1alpha.IUpdateCalculatedMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICalculatedMetric,
(protos.google.analytics.admin.v1alpha.IUpdateCalculatedMetricRequest | undefined),
{} | undefined
]>;
Updates a CalculatedMetric on a property.
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 CalculatedMetric to update
*/
// const calculatedMetric = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateCalculatedMetric() {
// Construct request
const request = {
calculatedMetric,
updateMask,
};
// Run request
const response = await adminClient.updateCalculatedMetric(request);
console.log(response);
}
callUpdateCalculatedMetric();
updateCalculatedMetric(request, options, callback)
updateCalculatedMetric(request: protos.google.analytics.admin.v1alpha.IUpdateCalculatedMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICalculatedMetric, protos.google.analytics.admin.v1alpha.IUpdateCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateCalculatedMetric(request, callback)
updateCalculatedMetric(request: protos.google.analytics.admin.v1alpha.IUpdateCalculatedMetricRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICalculatedMetric, protos.google.analytics.admin.v1alpha.IUpdateCalculatedMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateChannelGroup(request, options)
updateChannelGroup(request?: protos.google.analytics.admin.v1alpha.IUpdateChannelGroupRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IChannelGroup,
(protos.google.analytics.admin.v1alpha.IUpdateChannelGroupRequest | undefined),
{} | undefined
]>;
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 ChannelGroup to update.
* The resource's `name` field is used to identify the ChannelGroup to be
* updated.
*/
// const channelGroup = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateChannelGroup() {
// Construct request
const request = {
channelGroup,
updateMask,
};
// Run request
const response = await adminClient.updateChannelGroup(request);
console.log(response);
}
callUpdateChannelGroup();
updateChannelGroup(request, options, callback)
updateChannelGroup(request: protos.google.analytics.admin.v1alpha.IUpdateChannelGroupRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IChannelGroup, protos.google.analytics.admin.v1alpha.IUpdateChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateChannelGroup(request, callback)
updateChannelGroup(request: protos.google.analytics.admin.v1alpha.IUpdateChannelGroupRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IChannelGroup, protos.google.analytics.admin.v1alpha.IUpdateChannelGroupRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateConversionEvent(request, options)
updateConversionEvent(request?: protos.google.analytics.admin.v1alpha.IUpdateConversionEventRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IConversionEvent,
(protos.google.analytics.admin.v1alpha.IUpdateConversionEventRequest | undefined),
{} | undefined
]>;
Updates a conversion event with the specified attributes.
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 update.
* The `name` field is used to identify the settings to be updated.
*/
// const conversionEvent = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateConversionEvent() {
// Construct request
const request = {
conversionEvent,
updateMask,
};
// Run request
const response = await adminClient.updateConversionEvent(request);
console.log(response);
}
callUpdateConversionEvent();
updateConversionEvent(request, options, callback)
updateConversionEvent(request: protos.google.analytics.admin.v1alpha.IUpdateConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IConversionEvent, protos.google.analytics.admin.v1alpha.IUpdateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateConversionEvent(request, callback)
updateConversionEvent(request: protos.google.analytics.admin.v1alpha.IUpdateConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IConversionEvent, protos.google.analytics.admin.v1alpha.IUpdateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateCustomDimension(request, options)
updateCustomDimension(request?: protos.google.analytics.admin.v1alpha.IUpdateCustomDimensionRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomDimension,
(protos.google.analytics.admin.v1alpha.IUpdateCustomDimensionRequest | undefined),
{} | undefined
]>;
Updates a CustomDimension on a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdateCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomDimension, protos.google.analytics.admin.v1alpha.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateCustomDimension(request, callback)
updateCustomDimension(request: protos.google.analytics.admin.v1alpha.IUpdateCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomDimension, protos.google.analytics.admin.v1alpha.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateCustomMetric(request, options)
updateCustomMetric(request?: protos.google.analytics.admin.v1alpha.IUpdateCustomMetricRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ICustomMetric,
(protos.google.analytics.admin.v1alpha.IUpdateCustomMetricRequest | undefined),
{} | undefined
]>;
Updates a CustomMetric on a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdateCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomMetric, protos.google.analytics.admin.v1alpha.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateCustomMetric(request, callback)
updateCustomMetric(request: protos.google.analytics.admin.v1alpha.IUpdateCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ICustomMetric, protos.google.analytics.admin.v1alpha.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDataRedactionSettings(request, options)
updateDataRedactionSettings(request?: protos.google.analytics.admin.v1alpha.IUpdateDataRedactionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataRedactionSettings,
(protos.google.analytics.admin.v1alpha.IUpdateDataRedactionSettingsRequest | undefined),
{} | undefined
]>;
Updates a DataRedactionSettings on a property.
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 dataRedactionSettings = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateDataRedactionSettings() {
// Construct request
const request = {
dataRedactionSettings,
updateMask,
};
// Run request
const response = await adminClient.updateDataRedactionSettings(request);
console.log(response);
}
callUpdateDataRedactionSettings();
updateDataRedactionSettings(request, options, callback)
updateDataRedactionSettings(request: protos.google.analytics.admin.v1alpha.IUpdateDataRedactionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRedactionSettings, protos.google.analytics.admin.v1alpha.IUpdateDataRedactionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDataRedactionSettings(request, callback)
updateDataRedactionSettings(request: protos.google.analytics.admin.v1alpha.IUpdateDataRedactionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRedactionSettings, protos.google.analytics.admin.v1alpha.IUpdateDataRedactionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDataRetentionSettings(request, options)
updateDataRetentionSettings(request?: protos.google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataRetentionSettings,
(protos.google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest | undefined),
{} | undefined
]>;
Updates the singleton data retention settings for this property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdateDataRetentionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRetentionSettings, protos.google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDataRetentionSettings(request, callback)
updateDataRetentionSettings(request: protos.google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataRetentionSettings, protos.google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDataStream(request, options)
updateDataStream(request?: protos.google.analytics.admin.v1alpha.IUpdateDataStreamRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDataStream,
(protos.google.analytics.admin.v1alpha.IUpdateDataStreamRequest | undefined),
{} | undefined
]>;
Updates a DataStream on a property.
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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdateDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDataStream, protos.google.analytics.admin.v1alpha.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDataStream(request, callback)
updateDataStream(request: protos.google.analytics.admin.v1alpha.IUpdateDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDataStream, protos.google.analytics.admin.v1alpha.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDisplayVideo360AdvertiserLink(request, options)
updateDisplayVideo360AdvertiserLink(request?: protos.google.analytics.admin.v1alpha.IUpdateDisplayVideo360AdvertiserLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink,
(protos.google.analytics.admin.v1alpha.IUpdateDisplayVideo360AdvertiserLinkRequest | undefined),
{} | undefined
]>;
Updates a DisplayVideo360AdvertiserLink on a property.
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 DisplayVideo360AdvertiserLink to update
*/
// const displayVideo_360AdvertiserLink = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateDisplayVideo360AdvertiserLink() {
// Construct request
const request = {
updateMask,
};
// Run request
const response = await adminClient.updateDisplayVideo360AdvertiserLink(request);
console.log(response);
}
callUpdateDisplayVideo360AdvertiserLink();
updateDisplayVideo360AdvertiserLink(request, options, callback)
updateDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.IUpdateDisplayVideo360AdvertiserLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink, protos.google.analytics.admin.v1alpha.IUpdateDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateDisplayVideo360AdvertiserLink(request, callback)
updateDisplayVideo360AdvertiserLink(request: protos.google.analytics.admin.v1alpha.IUpdateDisplayVideo360AdvertiserLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IDisplayVideo360AdvertiserLink, protos.google.analytics.admin.v1alpha.IUpdateDisplayVideo360AdvertiserLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateEnhancedMeasurementSettings(request, options)
updateEnhancedMeasurementSettings(request?: protos.google.analytics.admin.v1alpha.IUpdateEnhancedMeasurementSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IEnhancedMeasurementSettings,
(protos.google.analytics.admin.v1alpha.IUpdateEnhancedMeasurementSettingsRequest | undefined),
{} | undefined
]>;
Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.
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 enhancedMeasurementSettings = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateEnhancedMeasurementSettings() {
// Construct request
const request = {
enhancedMeasurementSettings,
updateMask,
};
// Run request
const response = await adminClient.updateEnhancedMeasurementSettings(request);
console.log(response);
}
callUpdateEnhancedMeasurementSettings();
updateEnhancedMeasurementSettings(request, options, callback)
updateEnhancedMeasurementSettings(request: protos.google.analytics.admin.v1alpha.IUpdateEnhancedMeasurementSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IEnhancedMeasurementSettings, protos.google.analytics.admin.v1alpha.IUpdateEnhancedMeasurementSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateEnhancedMeasurementSettings(request, callback)
updateEnhancedMeasurementSettings(request: protos.google.analytics.admin.v1alpha.IUpdateEnhancedMeasurementSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IEnhancedMeasurementSettings, protos.google.analytics.admin.v1alpha.IUpdateEnhancedMeasurementSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateEventCreateRule(request, options)
updateEventCreateRule(request?: protos.google.analytics.admin.v1alpha.IUpdateEventCreateRuleRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IEventCreateRule,
(protos.google.analytics.admin.v1alpha.IUpdateEventCreateRuleRequest | undefined),
{} | undefined
]>;
Updates an EventCreateRule.
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 EventCreateRule to update.
* The resource's `name` field is used to identify the EventCreateRule to be
* updated.
*/
// const eventCreateRule = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateEventCreateRule() {
// Construct request
const request = {
eventCreateRule,
updateMask,
};
// Run request
const response = await adminClient.updateEventCreateRule(request);
console.log(response);
}
callUpdateEventCreateRule();
updateEventCreateRule(request, options, callback)
updateEventCreateRule(request: protos.google.analytics.admin.v1alpha.IUpdateEventCreateRuleRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IEventCreateRule, protos.google.analytics.admin.v1alpha.IUpdateEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateEventCreateRule(request, callback)
updateEventCreateRule(request: protos.google.analytics.admin.v1alpha.IUpdateEventCreateRuleRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IEventCreateRule, protos.google.analytics.admin.v1alpha.IUpdateEventCreateRuleRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateExpandedDataSet(request, options)
updateExpandedDataSet(request?: protos.google.analytics.admin.v1alpha.IUpdateExpandedDataSetRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IExpandedDataSet,
(protos.google.analytics.admin.v1alpha.IUpdateExpandedDataSetRequest | undefined),
{} | undefined
]>;
Updates a ExpandedDataSet on a property.
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 ExpandedDataSet to update.
* The resource's `name` field is used to identify the ExpandedDataSet to be
* updated.
*/
// const expandedDataSet = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateExpandedDataSet() {
// Construct request
const request = {
expandedDataSet,
updateMask,
};
// Run request
const response = await adminClient.updateExpandedDataSet(request);
console.log(response);
}
callUpdateExpandedDataSet();
updateExpandedDataSet(request, options, callback)
updateExpandedDataSet(request: protos.google.analytics.admin.v1alpha.IUpdateExpandedDataSetRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IExpandedDataSet, protos.google.analytics.admin.v1alpha.IUpdateExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateExpandedDataSet(request, callback)
updateExpandedDataSet(request: protos.google.analytics.admin.v1alpha.IUpdateExpandedDataSetRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IExpandedDataSet, protos.google.analytics.admin.v1alpha.IUpdateExpandedDataSetRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateGoogleAdsLink(request, options)
updateGoogleAdsLink(request?: protos.google.analytics.admin.v1alpha.IUpdateGoogleAdsLinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IGoogleAdsLink,
(protos.google.analytics.admin.v1alpha.IUpdateGoogleAdsLinkRequest | undefined),
{} | undefined
]>;
Updates a GoogleAdsLink on a property
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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdateGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleAdsLink, protos.google.analytics.admin.v1alpha.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateGoogleAdsLink(request, callback)
updateGoogleAdsLink(request: protos.google.analytics.admin.v1alpha.IUpdateGoogleAdsLinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleAdsLink, protos.google.analytics.admin.v1alpha.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateGoogleSignalsSettings(request, options)
updateGoogleSignalsSettings(request?: protos.google.analytics.admin.v1alpha.IUpdateGoogleSignalsSettingsRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IGoogleSignalsSettings,
(protos.google.analytics.admin.v1alpha.IUpdateGoogleSignalsSettingsRequest | undefined),
{} | undefined
]>;
Updates Google Signals settings for a property.
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 googleSignalsSettings = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateGoogleSignalsSettings() {
// Construct request
const request = {
googleSignalsSettings,
updateMask,
};
// Run request
const response = await adminClient.updateGoogleSignalsSettings(request);
console.log(response);
}
callUpdateGoogleSignalsSettings();
updateGoogleSignalsSettings(request, options, callback)
updateGoogleSignalsSettings(request: protos.google.analytics.admin.v1alpha.IUpdateGoogleSignalsSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleSignalsSettings, protos.google.analytics.admin.v1alpha.IUpdateGoogleSignalsSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateGoogleSignalsSettings(request, callback)
updateGoogleSignalsSettings(request: protos.google.analytics.admin.v1alpha.IUpdateGoogleSignalsSettingsRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IGoogleSignalsSettings, protos.google.analytics.admin.v1alpha.IUpdateGoogleSignalsSettingsRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateMeasurementProtocolSecret(request, options)
updateMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1alpha.IUpdateMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret,
(protos.google.analytics.admin.v1alpha.IUpdateMeasurementProtocolSecretRequest | undefined),
{} | undefined
]>;
Updates a measurement protocol secret.
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 = {}
/**
* Required. The list of fields to be updated. Omitted fields will not be
* updated.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateMeasurementProtocolSecret() {
// Construct request
const request = {
measurementProtocolSecret,
updateMask,
};
// Run request
const response = await adminClient.updateMeasurementProtocolSecret(request);
console.log(response);
}
callUpdateMeasurementProtocolSecret();
updateMeasurementProtocolSecret(request, options, callback)
updateMeasurementProtocolSecret(request: protos.google.analytics.admin.v1alpha.IUpdateMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret, protos.google.analytics.admin.v1alpha.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateMeasurementProtocolSecret(request, callback)
updateMeasurementProtocolSecret(request: protos.google.analytics.admin.v1alpha.IUpdateMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IMeasurementProtocolSecret, protos.google.analytics.admin.v1alpha.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateProperty(request, options)
updateProperty(request?: protos.google.analytics.admin.v1alpha.IUpdatePropertyRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.IProperty,
protos.google.analytics.admin.v1alpha.IUpdatePropertyRequest | undefined,
{} | undefined
]>;
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-analytics/admin').v1alpha;
// 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.v1alpha.IUpdatePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.IUpdatePropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateProperty(request, callback)
updateProperty(request: protos.google.analytics.admin.v1alpha.IUpdatePropertyRequest, callback: Callback<protos.google.analytics.admin.v1alpha.IProperty, protos.google.analytics.admin.v1alpha.IUpdatePropertyRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateSearchAds360Link(request, options)
updateSearchAds360Link(request?: protos.google.analytics.admin.v1alpha.IUpdateSearchAds360LinkRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISearchAds360Link,
(protos.google.analytics.admin.v1alpha.IUpdateSearchAds360LinkRequest | undefined),
{} | undefined
]>;
Updates a SearchAds360Link on a property.
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 SearchAds360Link to update
*/
// const searchAds_360Link = {}
/**
* 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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateSearchAds360Link() {
// Construct request
const request = {
updateMask,
};
// Run request
const response = await adminClient.updateSearchAds360Link(request);
console.log(response);
}
callUpdateSearchAds360Link();
updateSearchAds360Link(request, options, callback)
updateSearchAds360Link(request: protos.google.analytics.admin.v1alpha.IUpdateSearchAds360LinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISearchAds360Link, protos.google.analytics.admin.v1alpha.IUpdateSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateSearchAds360Link(request, callback)
updateSearchAds360Link(request: protos.google.analytics.admin.v1alpha.IUpdateSearchAds360LinkRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISearchAds360Link, protos.google.analytics.admin.v1alpha.IUpdateSearchAds360LinkRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateSKAdNetworkConversionValueSchema(request, options)
updateSKAdNetworkConversionValueSchema(request?: protos.google.analytics.admin.v1alpha.IUpdateSKAdNetworkConversionValueSchemaRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema,
(protos.google.analytics.admin.v1alpha.IUpdateSKAdNetworkConversionValueSchemaRequest | undefined),
{} | undefined
]>;
Updates a SKAdNetworkConversionValueSchema.
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. SKAdNetwork conversion value schema to update.
*/
// const skadnetworkConversionValueSchema = {}
/**
* Required. The list of fields to be updated. Omitted fields will not be
* updated.
*/
// const updateMask = {}
// Imports the Admin library
const {AnalyticsAdminServiceClient} = require('@google-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateSKAdNetworkConversionValueSchema() {
// Construct request
const request = {
skadnetworkConversionValueSchema,
updateMask,
};
// Run request
const response = await adminClient.updateSKAdNetworkConversionValueSchema(request);
console.log(response);
}
callUpdateSKAdNetworkConversionValueSchema();
updateSKAdNetworkConversionValueSchema(request, options, callback)
updateSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.IUpdateSKAdNetworkConversionValueSchemaRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema, protos.google.analytics.admin.v1alpha.IUpdateSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateSKAdNetworkConversionValueSchema(request, callback)
updateSKAdNetworkConversionValueSchema(request: protos.google.analytics.admin.v1alpha.IUpdateSKAdNetworkConversionValueSchemaRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISKAdNetworkConversionValueSchema, protos.google.analytics.admin.v1alpha.IUpdateSKAdNetworkConversionValueSchemaRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateSubpropertyEventFilter(request, options)
updateSubpropertyEventFilter(request?: protos.google.analytics.admin.v1alpha.IUpdateSubpropertyEventFilterRequest, options?: CallOptions): Promise<[
protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter,
(protos.google.analytics.admin.v1alpha.IUpdateSubpropertyEventFilterRequest | undefined),
{} | undefined
]>;
Updates a subproperty Event Filter.
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 subproperty event filter to update.
*/
// const subpropertyEventFilter = {}
/**
* Required. The list of fields to update. Field names must be in snake case
* (for example, "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-analytics/admin').v1alpha;
// Instantiates a client
const adminClient = new AnalyticsAdminServiceClient();
async function callUpdateSubpropertyEventFilter() {
// Construct request
const request = {
subpropertyEventFilter,
updateMask,
};
// Run request
const response = await adminClient.updateSubpropertyEventFilter(request);
console.log(response);
}
callUpdateSubpropertyEventFilter();
updateSubpropertyEventFilter(request, options, callback)
updateSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.IUpdateSubpropertyEventFilterRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter, protos.google.analytics.admin.v1alpha.IUpdateSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |
updateSubpropertyEventFilter(request, callback)
updateSubpropertyEventFilter(request: protos.google.analytics.admin.v1alpha.IUpdateSubpropertyEventFilterRequest, callback: Callback<protos.google.analytics.admin.v1alpha.ISubpropertyEventFilter, protos.google.analytics.admin.v1alpha.IUpdateSubpropertyEventFilterRequest | null | undefined, {} | null | undefined>): void;
Returns |
---|
Type | Description |
void | |