Class v1beta.AnalyticsAdminServiceClient (7.3.0)

Service Interface for the Analytics Admin API (GA4). v1beta

Package

@google-analytics/admin

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of AnalyticsAdminServiceClient.

Parameters
NameDescription
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

auth: gax.GoogleAuth;

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

accountPath(account)

accountPath(account: string): string;

Return a fully-qualified account resource name string.

Parameter
NameDescription
account string
Returns
TypeDescription
string

{string} Resource name string.

accountSummaryPath(accountSummary)

accountSummaryPath(accountSummary: string): string;

Return a fully-qualified accountSummary resource name string.

Parameter
NameDescription
accountSummary string
Returns
TypeDescription
string

{string} Resource name string.

acknowledgeUserDataCollection(request, options)

acknowledgeUserDataCollection(request?: protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse,
        (protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | undefined),
        {} | undefined
    ]>;

Acknowledges the terms of user data collection for the specified property.

This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

Parameters
NameDescription
request IAcknowledgeUserDataCollectionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, (protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing AcknowledgeUserDataCollectionResponse. 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 property for which to acknowledge user data collection.
   */
  // const property = 'abc123'
  /**
   *  Required. An acknowledgement that the caller of this method understands the
   *  terms of user data collection.
   *  This field must contain the exact value:
   *  "I acknowledge that I have the necessary privacy disclosures and rights
   *  from my end users for the collection and processing of their data,
   *  including the association of such data with the visitation information
   *  Google Analytics collects from my site and/or app property."
   */
  // const acknowledgement = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callAcknowledgeUserDataCollection() {
    // Construct request
    const request = {
      property,
      acknowledgement,
    };

    // Run request
    const response = await adminClient.acknowledgeUserDataCollection(request);
    console.log(response);
  }

  callAcknowledgeUserDataCollection();

acknowledgeUserDataCollection(request, options, callback)

acknowledgeUserDataCollection(request: protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IAcknowledgeUserDataCollectionRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

acknowledgeUserDataCollection(request, callback)

acknowledgeUserDataCollection(request: protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest, callback: Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IAcknowledgeUserDataCollectionRequest
callback Callback<protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionResponse, protos.google.analytics.admin.v1beta.IAcknowledgeUserDataCollectionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

archiveCustomDimension(request, options)

archiveCustomDimension(request?: protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | undefined),
        {} | undefined
    ]>;

Archives a CustomDimension on a property.

Parameters
NameDescription
request IArchiveCustomDimensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 name of the CustomDimension to archive.
   *  Example format: properties/1234/customDimensions/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callArchiveCustomDimension() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.archiveCustomDimension(request);
    console.log(response);
  }

  callArchiveCustomDimension();

archiveCustomDimension(request, options, callback)

archiveCustomDimension(request: protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IArchiveCustomDimensionRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

archiveCustomDimension(request, callback)

archiveCustomDimension(request: protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IArchiveCustomDimensionRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

archiveCustomMetric(request, options)

archiveCustomMetric(request?: protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | undefined),
        {} | undefined
    ]>;

Archives a CustomMetric on a property.

Parameters
NameDescription
request IArchiveCustomMetricRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 name of the CustomMetric to archive.
   *  Example format: properties/1234/customMetrics/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callArchiveCustomMetric() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.archiveCustomMetric(request);
    console.log(response);
  }

  callArchiveCustomMetric();

archiveCustomMetric(request, options, callback)

archiveCustomMetric(request: protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IArchiveCustomMetricRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

archiveCustomMetric(request, callback)

archiveCustomMetric(request: protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IArchiveCustomMetricRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IArchiveCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
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
NameDescription
property string
conversionEvent string
Returns
TypeDescription
string

{string} Resource name string.

createConversionEvent(request, options)

createConversionEvent(request?: protos.google.analytics.admin.v1beta.ICreateConversionEventRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IConversionEvent,
        (protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | undefined),
        {} | undefined
    ]>;

Creates a conversion event with the specified attributes.

Parameters
NameDescription
request ICreateConversionEventRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IConversionEvent, (protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The conversion event to create.
   */
  // const conversionEvent = {}
  /**
   *  Required. The resource name of the parent property where this conversion
   *  event will be created. Format: properties/123
   */
  // const parent = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateConversionEvent() {
    // Construct request
    const request = {
      conversionEvent,
      parent,
    };

    // Run request
    const response = await adminClient.createConversionEvent(request);
    console.log(response);
  }

  callCreateConversionEvent();

createConversionEvent(request, options, callback)

createConversionEvent(request: protos.google.analytics.admin.v1beta.ICreateConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateConversionEventRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createConversionEvent(request, callback)

createConversionEvent(request: protos.google.analytics.admin.v1beta.ICreateConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateConversionEventRequest
callback Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.ICreateConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCustomDimension(request, options)

createCustomDimension(request?: protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomDimension,
        (protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | undefined),
        {} | undefined
    ]>;

Creates a CustomDimension.

Parameters
NameDescription
request ICreateCustomDimensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomDimension, (protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The CustomDimension to create.
   */
  // const customDimension = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateCustomDimension() {
    // Construct request
    const request = {
      parent,
      customDimension,
    };

    // Run request
    const response = await adminClient.createCustomDimension(request);
    console.log(response);
  }

  callCreateCustomDimension();

createCustomDimension(request, options, callback)

createCustomDimension(request: protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateCustomDimensionRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCustomDimension(request, callback)

createCustomDimension(request: protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateCustomDimensionRequest
callback Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.ICreateCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCustomMetric(request, options)

createCustomMetric(request?: protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomMetric,
        (protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | undefined),
        {} | undefined
    ]>;

Creates a CustomMetric.

Parameters
NameDescription
request ICreateCustomMetricRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomMetric, (protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The CustomMetric to create.
   */
  // const customMetric = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateCustomMetric() {
    // Construct request
    const request = {
      parent,
      customMetric,
    };

    // Run request
    const response = await adminClient.createCustomMetric(request);
    console.log(response);
  }

  callCreateCustomMetric();

createCustomMetric(request, options, callback)

createCustomMetric(request: protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateCustomMetricRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createCustomMetric(request, callback)

createCustomMetric(request: protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateCustomMetricRequest
callback Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.ICreateCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDataStream(request, options)

createDataStream(request?: protos.google.analytics.admin.v1beta.ICreateDataStreamRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataStream,
        protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | undefined,
        {} | undefined
    ]>;

Creates a DataStream.

Parameters
NameDescription
request ICreateDataStreamRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The DataStream to create.
   */
  // const dataStream = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateDataStream() {
    // Construct request
    const request = {
      parent,
      dataStream,
    };

    // Run request
    const response = await adminClient.createDataStream(request);
    console.log(response);
  }

  callCreateDataStream();

createDataStream(request, options, callback)

createDataStream(request: protos.google.analytics.admin.v1beta.ICreateDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateDataStreamRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createDataStream(request, callback)

createDataStream(request: protos.google.analytics.admin.v1beta.ICreateDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateDataStreamRequest
callback Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.ICreateDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
createFirebaseLink(request?: protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IFirebaseLink,
        (protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | undefined),
        {} | undefined
    ]>;

Creates a FirebaseLink.

Properties can have at most one FirebaseLink.

Parameters
NameDescription
request ICreateFirebaseLinkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IFirebaseLink, (protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing FirebaseLink. 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. Format: properties/{property_id}
   *  Example: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  Required. The Firebase link to create.
   */
  // const firebaseLink = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateFirebaseLink() {
    // Construct request
    const request = {
      parent,
      firebaseLink,
    };

    // Run request
    const response = await adminClient.createFirebaseLink(request);
    console.log(response);
  }

  callCreateFirebaseLink();

createFirebaseLink(request: protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateFirebaseLinkRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
createFirebaseLink(request: protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest, callback: Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateFirebaseLinkRequest
callback Callback<protos.google.analytics.admin.v1beta.IFirebaseLink, protos.google.analytics.admin.v1beta.ICreateFirebaseLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
createGoogleAdsLink(request?: protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IGoogleAdsLink,
        (protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | undefined),
        {} | undefined
    ]>;

Creates a GoogleAdsLink.

Parameters
NameDescription
request ICreateGoogleAdsLinkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IGoogleAdsLink, (protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing GoogleAdsLink. 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'
  /**
   *  Required. The GoogleAdsLink to create.
   */
  // const googleAdsLink = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateGoogleAdsLink() {
    // Construct request
    const request = {
      parent,
      googleAdsLink,
    };

    // Run request
    const response = await adminClient.createGoogleAdsLink(request);
    console.log(response);
  }

  callCreateGoogleAdsLink();

createGoogleAdsLink(request: protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateGoogleAdsLinkRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
createGoogleAdsLink(request: protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateGoogleAdsLinkRequest
callback Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.ICreateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMeasurementProtocolSecret(request, options)

createMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
        (protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | undefined),
        {} | undefined
    ]>;

Creates a measurement protocol secret.

Parameters
NameDescription
request ICreateMeasurementProtocolSecretRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, (protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing MeasurementProtocolSecret. 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 parent resource where this secret will be created.
   *  Format: properties/{property}/dataStreams/{dataStream}
   */
  // const parent = 'abc123'
  /**
   *  Required. The measurement protocol secret to create.
   */
  // const measurementProtocolSecret = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateMeasurementProtocolSecret() {
    // Construct request
    const request = {
      parent,
      measurementProtocolSecret,
    };

    // Run request
    const response = await adminClient.createMeasurementProtocolSecret(request);
    console.log(response);
  }

  callCreateMeasurementProtocolSecret();

createMeasurementProtocolSecret(request, options, callback)

createMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateMeasurementProtocolSecretRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createMeasurementProtocolSecret(request, callback)

createMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateMeasurementProtocolSecretRequest
callback Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.ICreateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createProperty(request, options)

createProperty(request?: protos.google.analytics.admin.v1beta.ICreatePropertyRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IProperty,
        protos.google.analytics.admin.v1beta.ICreatePropertyRequest | undefined,
        {} | undefined
    ]>;

Creates an "GA4" property with the specified location and attributes.

Parameters
NameDescription
request ICreatePropertyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Property. 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 property to create.
   *  Note: the supplied property must specify its parent.
   */
  // const property = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callCreateProperty() {
    // Construct request
    const request = {
      property,
    };

    // Run request
    const response = await adminClient.createProperty(request);
    console.log(response);
  }

  callCreateProperty();

createProperty(request, options, callback)

createProperty(request: protos.google.analytics.admin.v1beta.ICreatePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreatePropertyRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createProperty(request, callback)

createProperty(request: protos.google.analytics.admin.v1beta.ICreatePropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreatePropertyRequest
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.ICreatePropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

customDimensionPath(property, customDimension)

customDimensionPath(property: string, customDimension: string): string;

Return a fully-qualified customDimension resource name string.

Parameters
NameDescription
property string
customDimension string
Returns
TypeDescription
string

{string} Resource name string.

customMetricPath(property, customMetric)

customMetricPath(property: string, customMetric: string): string;

Return a fully-qualified customMetric resource name string.

Parameters
NameDescription
property string
customMetric string
Returns
TypeDescription
string

{string} Resource name string.

dataRetentionSettingsPath(property)

dataRetentionSettingsPath(property: string): string;

Return a fully-qualified dataRetentionSettings resource name string.

Parameter
NameDescription
property string
Returns
TypeDescription
string

{string} Resource name string.

dataSharingSettingsPath(account)

dataSharingSettingsPath(account: string): string;

Return a fully-qualified dataSharingSettings resource name string.

Parameter
NameDescription
account string
Returns
TypeDescription
string

{string} Resource name string.

dataStreamPath(property, dataStream)

dataStreamPath(property: string, dataStream: string): string;

Return a fully-qualified dataStream resource name string.

Parameters
NameDescription
property string
dataStream string
Returns
TypeDescription
string

{string} Resource name string.

deleteAccount(request, options)

deleteAccount(request?: protos.google.analytics.admin.v1beta.IDeleteAccountRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.analytics.admin.v1beta.IDeleteAccountRequest | undefined,
        {} | undefined
    ]>;

Marks target Account as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.

If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found.

Parameters
NameDescription
request IDeleteAccountRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 name of the Account to soft-delete.
   *  Format: accounts/{account}
   *  Example: "accounts/100"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteAccount() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteAccount(request);
    console.log(response);
  }

  callDeleteAccount();

deleteAccount(request, options, callback)

deleteAccount(request: protos.google.analytics.admin.v1beta.IDeleteAccountRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteAccountRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAccount(request, callback)

deleteAccount(request: protos.google.analytics.admin.v1beta.IDeleteAccountRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteAccountRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteAccountRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteConversionEvent(request, options)

deleteConversionEvent(request?: protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | undefined),
        {} | undefined
    ]>;

Deletes a conversion event in a property.

Parameters
NameDescription
request IDeleteConversionEventRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 conversion event to delete.
   *  Format: properties/{property}/conversionEvents/{conversion_event}
   *  Example: "properties/123/conversionEvents/456"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteConversionEvent() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteConversionEvent(request);
    console.log(response);
  }

  callDeleteConversionEvent();

deleteConversionEvent(request, options, callback)

deleteConversionEvent(request: protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteConversionEventRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteConversionEvent(request, callback)

deleteConversionEvent(request: protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteConversionEventRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDataStream(request, options)

deleteDataStream(request?: protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | undefined,
        {} | undefined
    ]>;

Deletes a DataStream on a property.

Parameters
NameDescription
request IDeleteDataStreamRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 name of the DataStream to delete.
   *  Example format: properties/1234/dataStreams/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteDataStream() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteDataStream(request);
    console.log(response);
  }

  callDeleteDataStream();

deleteDataStream(request, options, callback)

deleteDataStream(request: protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteDataStreamRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteDataStream(request, callback)

deleteDataStream(request: protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteDataStreamRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
deleteFirebaseLink(request?: protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | undefined),
        {} | undefined
    ]>;

Deletes a FirebaseLink on a property

Parameters
NameDescription
request IDeleteFirebaseLinkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}
   *  Example: properties/1234/firebaseLinks/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteFirebaseLink() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteFirebaseLink(request);
    console.log(response);
  }

  callDeleteFirebaseLink();

deleteFirebaseLink(request: protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteFirebaseLinkRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
deleteFirebaseLink(request: protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteFirebaseLinkRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteFirebaseLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
deleteGoogleAdsLink(request?: protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | undefined),
        {} | undefined
    ]>;

Deletes a GoogleAdsLink on a property

Parameters
NameDescription
request IDeleteGoogleAdsLinkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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/googleAdsLinks/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteGoogleAdsLink() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteGoogleAdsLink(request);
    console.log(response);
  }

  callDeleteGoogleAdsLink();

deleteGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteGoogleAdsLinkRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
deleteGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteGoogleAdsLinkRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteMeasurementProtocolSecret(request, options)

deleteMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | undefined),
        {} | undefined
    ]>;

Deletes target MeasurementProtocolSecret.

Parameters
NameDescription
request IDeleteMeasurementProtocolSecretRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty. 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 name of the MeasurementProtocolSecret to delete.
   *  Format:
   *  properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteMeasurementProtocolSecret() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteMeasurementProtocolSecret(request);
    console.log(response);
  }

  callDeleteMeasurementProtocolSecret();

deleteMeasurementProtocolSecret(request, options, callback)

deleteMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteMeasurementProtocolSecretRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteMeasurementProtocolSecret(request, callback)

deleteMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteMeasurementProtocolSecretRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.analytics.admin.v1beta.IDeleteMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteProperty(request, options)

deleteProperty(request?: protos.google.analytics.admin.v1beta.IDeletePropertyRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IProperty,
        protos.google.analytics.admin.v1beta.IDeletePropertyRequest | undefined,
        {} | undefined
    ]>;

Marks target Property as soft-deleted (ie: "trashed") and returns it.

This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.

If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772

Returns an error if the target is not found, or is not a GA4 Property.

Parameters
NameDescription
request IDeletePropertyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Property. 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 name of the Property to soft-delete.
   *  Format: properties/{property_id}
   *  Example: "properties/1000"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callDeleteProperty() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.deleteProperty(request);
    console.log(response);
  }

  callDeleteProperty();

deleteProperty(request, options, callback)

deleteProperty(request: protos.google.analytics.admin.v1beta.IDeletePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeletePropertyRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteProperty(request, callback)

deleteProperty(request: protos.google.analytics.admin.v1beta.IDeletePropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeletePropertyRequest
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IDeletePropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

firebaseLinkPath(property, firebaseLink)

firebaseLinkPath(property: string, firebaseLink: string): string;

Return a fully-qualified firebaseLink resource name string.

Parameters
NameDescription
property string
firebaseLink string
Returns
TypeDescription
string

{string} Resource name string.

getAccount(request, options)

getAccount(request?: protos.google.analytics.admin.v1beta.IGetAccountRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IAccount,
        protos.google.analytics.admin.v1beta.IGetAccountRequest | undefined,
        {} | undefined
    ]>;

Lookup for a single Account.

Parameters
NameDescription
request IGetAccountRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Account. 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 name of the account to lookup.
   *  Format: accounts/{account}
   *  Example: "accounts/100"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetAccount() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getAccount(request);
    console.log(response);
  }

  callGetAccount();

getAccount(request, options, callback)

getAccount(request: protos.google.analytics.admin.v1beta.IGetAccountRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetAccountRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAccount(request, callback)

getAccount(request: protos.google.analytics.admin.v1beta.IGetAccountRequest, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetAccountRequest
callback Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IGetAccountRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getConversionEvent(request, options)

getConversionEvent(request?: protos.google.analytics.admin.v1beta.IGetConversionEventRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IConversionEvent,
        (protos.google.analytics.admin.v1beta.IGetConversionEventRequest | undefined),
        {} | undefined
    ]>;

Retrieve a single conversion event.

Parameters
NameDescription
request IGetConversionEventRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IConversionEvent, (protos.google.analytics.admin.v1beta.IGetConversionEventRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the conversion event to retrieve.
   *  Format: properties/{property}/conversionEvents/{conversion_event}
   *  Example: "properties/123/conversionEvents/456"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetConversionEvent() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getConversionEvent(request);
    console.log(response);
  }

  callGetConversionEvent();

getConversionEvent(request, options, callback)

getConversionEvent(request: protos.google.analytics.admin.v1beta.IGetConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetConversionEventRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getConversionEvent(request, callback)

getConversionEvent(request: protos.google.analytics.admin.v1beta.IGetConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetConversionEventRequest
callback Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IGetConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCustomDimension(request, options)

getCustomDimension(request?: protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomDimension,
        (protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | undefined),
        {} | undefined
    ]>;

Lookup for a single CustomDimension.

Parameters
NameDescription
request IGetCustomDimensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomDimension, (protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the CustomDimension to get.
   *  Example format: properties/1234/customDimensions/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetCustomDimension() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getCustomDimension(request);
    console.log(response);
  }

  callGetCustomDimension();

getCustomDimension(request, options, callback)

getCustomDimension(request: protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetCustomDimensionRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCustomDimension(request, callback)

getCustomDimension(request: protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetCustomDimensionRequest
callback Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IGetCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCustomMetric(request, options)

getCustomMetric(request?: protos.google.analytics.admin.v1beta.IGetCustomMetricRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomMetric,
        protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | undefined,
        {} | undefined
    ]>;

Lookup for a single CustomMetric.

Parameters
NameDescription
request IGetCustomMetricRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the CustomMetric to get.
   *  Example format: properties/1234/customMetrics/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetCustomMetric() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getCustomMetric(request);
    console.log(response);
  }

  callGetCustomMetric();

getCustomMetric(request, options, callback)

getCustomMetric(request: protos.google.analytics.admin.v1beta.IGetCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetCustomMetricRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getCustomMetric(request, callback)

getCustomMetric(request: protos.google.analytics.admin.v1beta.IGetCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetCustomMetricRequest
callback Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IGetCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataRetentionSettings(request, options)

getDataRetentionSettings(request?: protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataRetentionSettings,
        (protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | undefined),
        {} | undefined
    ]>;

Returns the singleton data retention settings for this property.

Parameters
NameDescription
request IGetDataRetentionSettingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataRetentionSettings, (protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the settings to lookup.
   *  Format:
   *  properties/{property}/dataRetentionSettings
   *  Example: "properties/1000/dataRetentionSettings"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetDataRetentionSettings() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getDataRetentionSettings(request);
    console.log(response);
  }

  callGetDataRetentionSettings();

getDataRetentionSettings(request, options, callback)

getDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetDataRetentionSettingsRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataRetentionSettings(request, callback)

getDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetDataRetentionSettingsRequest
callback Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IGetDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataSharingSettings(request, options)

getDataSharingSettings(request?: protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataSharingSettings,
        (protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | undefined),
        {} | undefined
    ]>;

Get data sharing settings on an account. Data sharing settings are singletons.

Parameters
NameDescription
request IGetDataSharingSettingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataSharingSettings, (protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DataSharingSettings. 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 name of the settings to lookup.
   *  Format: accounts/{account}/dataSharingSettings
   *  Example: "accounts/1000/dataSharingSettings"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetDataSharingSettings() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getDataSharingSettings(request);
    console.log(response);
  }

  callGetDataSharingSettings();

getDataSharingSettings(request, options, callback)

getDataSharingSettings(request: protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetDataSharingSettingsRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataSharingSettings(request, callback)

getDataSharingSettings(request: protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetDataSharingSettingsRequest
callback Callback<protos.google.analytics.admin.v1beta.IDataSharingSettings, protos.google.analytics.admin.v1beta.IGetDataSharingSettingsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataStream(request, options)

getDataStream(request?: protos.google.analytics.admin.v1beta.IGetDataStreamRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataStream,
        protos.google.analytics.admin.v1beta.IGetDataStreamRequest | undefined,
        {} | undefined
    ]>;

Lookup for a single DataStream.

Parameters
NameDescription
request IGetDataStreamRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the DataStream to get.
   *  Example format: properties/1234/dataStreams/5678
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetDataStream() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getDataStream(request);
    console.log(response);
  }

  callGetDataStream();

getDataStream(request, options, callback)

getDataStream(request: protos.google.analytics.admin.v1beta.IGetDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetDataStreamRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getDataStream(request, callback)

getDataStream(request: protos.google.analytics.admin.v1beta.IGetDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetDataStreamRequest
callback Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IGetDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getMeasurementProtocolSecret(request, options)

getMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
        (protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | undefined),
        {} | undefined
    ]>;

Lookup for a single "GA4" MeasurementProtocolSecret.

Parameters
NameDescription
request IGetMeasurementProtocolSecretRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, (protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing MeasurementProtocolSecret. 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 name of the measurement protocol secret to lookup.
   *  Format:
   *  properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetMeasurementProtocolSecret() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getMeasurementProtocolSecret(request);
    console.log(response);
  }

  callGetMeasurementProtocolSecret();

getMeasurementProtocolSecret(request, options, callback)

getMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetMeasurementProtocolSecretRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getMeasurementProtocolSecret(request, callback)

getMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetMeasurementProtocolSecretRequest
callback Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IGetMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getProperty(request, options)

getProperty(request?: protos.google.analytics.admin.v1beta.IGetPropertyRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IProperty,
        protos.google.analytics.admin.v1beta.IGetPropertyRequest | undefined,
        {} | undefined
    ]>;

Lookup for a single "GA4" Property.

Parameters
NameDescription
request IGetPropertyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Property. 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 name of the property to lookup.
   *  Format: properties/{property_id}
   *  Example: "properties/1000"
   */
  // const name = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callGetProperty() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await adminClient.getProperty(request);
    console.log(response);
  }

  callGetProperty();

getProperty(request, options, callback)

getProperty(request: protos.google.analytics.admin.v1beta.IGetPropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetPropertyRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProperty(request, callback)

getProperty(request: protos.google.analytics.admin.v1beta.IGetPropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetPropertyRequest
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IGetPropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

googleAdsLinkPath(property, googleAdsLink)

googleAdsLinkPath(property: string, googleAdsLink: string): string;

Return a fully-qualified googleAdsLink resource name string.

Parameters
NameDescription
property string
googleAdsLink string
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listAccounts(request, options)

listAccounts(request?: protos.google.analytics.admin.v1beta.IListAccountsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IAccount[],
        protos.google.analytics.admin.v1beta.IListAccountsRequest | null,
        protos.google.analytics.admin.v1beta.IListAccountsResponse
    ]>;

Returns all accounts accessible by the caller.

Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Parameters
NameDescription
request IListAccountsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IAccount[], protos.google.analytics.admin.v1beta.IListAccountsRequest | null, protos.google.analytics.admin.v1beta.IListAccountsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Account. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAccountsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAccounts(request, options, callback)

listAccounts(request: protos.google.analytics.admin.v1beta.IListAccountsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>): void;
Parameters
NameDescription
request IListAccountsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>
Returns
TypeDescription
void

listAccounts(request, callback)

listAccounts(request: protos.google.analytics.admin.v1beta.IListAccountsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>): void;
Parameters
NameDescription
request IListAccountsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountsRequest, protos.google.analytics.admin.v1beta.IListAccountsResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccount>
Returns
TypeDescription
void

listAccountsAsync(request, options)

listAccountsAsync(request?: protos.google.analytics.admin.v1beta.IListAccountsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IAccount>;

Equivalent to listAccounts, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListAccountsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.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-cloud/admin').v1beta;

  // 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.v1beta.IListAccountsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListAccountsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1beta.IListAccountSummariesRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IAccountSummary[],
        protos.google.analytics.admin.v1beta.IListAccountSummariesRequest | null,
        protos.google.analytics.admin.v1beta.IListAccountSummariesResponse
    ]>;

Returns summaries of all accounts accessible by the caller.

Parameters
NameDescription
request IListAccountSummariesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IAccountSummary[], protos.google.analytics.admin.v1beta.IListAccountSummariesRequest | null, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of AccountSummary. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listAccountSummariesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAccountSummaries(request, options, callback)

listAccountSummaries(request: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>): void;
Parameters
NameDescription
request IListAccountSummariesRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>
Returns
TypeDescription
void

listAccountSummaries(request, callback)

listAccountSummaries(request: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>): void;
Parameters
NameDescription
request IListAccountSummariesRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, protos.google.analytics.admin.v1beta.IListAccountSummariesResponse | null | undefined, protos.google.analytics.admin.v1beta.IAccountSummary>
Returns
TypeDescription
void

listAccountSummariesAsync(request, options)

listAccountSummariesAsync(request?: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IAccountSummary>;

Equivalent to listAccountSummaries, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListAccountSummariesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.IAccountSummary>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AccountSummary. 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 AccountSummary resources to return. The service may
   *  return fewer than this value, even if there are additional pages.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200; (higher values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListAccountSummaries` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListAccountSummaries`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callListAccountSummaries() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = adminClient.listAccountSummariesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListAccountSummaries();

listAccountSummariesStream(request, options)

listAccountSummariesStream(request?: protos.google.analytics.admin.v1beta.IListAccountSummariesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListAccountSummariesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

listConversionEvents(request, options)

listConversionEvents(request?: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IConversionEvent[],
        protos.google.analytics.admin.v1beta.IListConversionEventsRequest | null,
        protos.google.analytics.admin.v1beta.IListConversionEventsResponse
    ]>;

Returns a list of conversion events in the specified parent property.

Returns an empty list if no conversion events are found.

Parameters
NameDescription
request IListConversionEventsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IConversionEvent[], protos.google.analytics.admin.v1beta.IListConversionEventsRequest | null, protos.google.analytics.admin.v1beta.IListConversionEventsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listConversionEventsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listConversionEvents(request, options, callback)

listConversionEvents(request: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>): void;
Parameters
NameDescription
request IListConversionEventsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>
Returns
TypeDescription
void

listConversionEvents(request, callback)

listConversionEvents(request: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>): void;
Parameters
NameDescription
request IListConversionEventsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListConversionEventsRequest, protos.google.analytics.admin.v1beta.IListConversionEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IConversionEvent>
Returns
TypeDescription
void

listConversionEventsAsync(request, options)

listConversionEventsAsync(request?: protos.google.analytics.admin.v1beta.IListConversionEventsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IConversionEvent>;

Equivalent to listConversionEvents, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListConversionEventsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.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-cloud/admin').v1beta;

  // 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.v1beta.IListConversionEventsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListConversionEventsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1beta.IListCustomDimensionsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomDimension[],
        protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest | null,
        protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse
    ]>;

Lists CustomDimensions on a property.

Parameters
NameDescription
request IListCustomDimensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomDimension[], protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest | null, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCustomDimensionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCustomDimensions(request, options, callback)

listCustomDimensions(request: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>): void;
Parameters
NameDescription
request IListCustomDimensionsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>
Returns
TypeDescription
void

listCustomDimensions(request, callback)

listCustomDimensions(request: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>): void;
Parameters
NameDescription
request IListCustomDimensionsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, protos.google.analytics.admin.v1beta.IListCustomDimensionsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomDimension>
Returns
TypeDescription
void

listCustomDimensionsAsync(request, options)

listCustomDimensionsAsync(request?: protos.google.analytics.admin.v1beta.IListCustomDimensionsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.ICustomDimension>;

Equivalent to listCustomDimensions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListCustomDimensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.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-cloud/admin').v1beta;

  // 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.v1beta.IListCustomDimensionsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListCustomDimensionsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1beta.IListCustomMetricsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomMetric[],
        protos.google.analytics.admin.v1beta.IListCustomMetricsRequest | null,
        protos.google.analytics.admin.v1beta.IListCustomMetricsResponse
    ]>;

Lists CustomMetrics on a property.

Parameters
NameDescription
request IListCustomMetricsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomMetric[], protos.google.analytics.admin.v1beta.IListCustomMetricsRequest | null, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCustomMetricsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCustomMetrics(request, options, callback)

listCustomMetrics(request: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>): void;
Parameters
NameDescription
request IListCustomMetricsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>
Returns
TypeDescription
void

listCustomMetrics(request, callback)

listCustomMetrics(request: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>): void;
Parameters
NameDescription
request IListCustomMetricsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, protos.google.analytics.admin.v1beta.IListCustomMetricsResponse | null | undefined, protos.google.analytics.admin.v1beta.ICustomMetric>
Returns
TypeDescription
void

listCustomMetricsAsync(request, options)

listCustomMetricsAsync(request?: protos.google.analytics.admin.v1beta.IListCustomMetricsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.ICustomMetric>;

Equivalent to listCustomMetrics, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListCustomMetricsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.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-cloud/admin').v1beta;

  // 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.v1beta.IListCustomMetricsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListCustomMetricsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1beta.IListDataStreamsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataStream[],
        protos.google.analytics.admin.v1beta.IListDataStreamsRequest | null,
        protos.google.analytics.admin.v1beta.IListDataStreamsResponse
    ]>;

Lists DataStreams on a property.

Parameters
NameDescription
request IListDataStreamsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataStream[], protos.google.analytics.admin.v1beta.IListDataStreamsRequest | null, protos.google.analytics.admin.v1beta.IListDataStreamsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDataStreamsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDataStreams(request, options, callback)

listDataStreams(request: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>): void;
Parameters
NameDescription
request IListDataStreamsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>
Returns
TypeDescription
void

listDataStreams(request, callback)

listDataStreams(request: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>): void;
Parameters
NameDescription
request IListDataStreamsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListDataStreamsRequest, protos.google.analytics.admin.v1beta.IListDataStreamsResponse | null | undefined, protos.google.analytics.admin.v1beta.IDataStream>
Returns
TypeDescription
void

listDataStreamsAsync(request, options)

listDataStreamsAsync(request?: protos.google.analytics.admin.v1beta.IListDataStreamsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IDataStream>;

Equivalent to listDataStreams, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListDataStreamsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.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-cloud/admin').v1beta;

  // 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.v1beta.IListDataStreamsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListDataStreamsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

listFirebaseLinks(request?: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IFirebaseLink[],
        protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest | null,
        protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse
    ]>;

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.

Parameters
NameDescription
request IListFirebaseLinksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IFirebaseLink[], protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest | null, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of FirebaseLink. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listFirebaseLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFirebaseLinks(request: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>): void;
Parameters
NameDescription
request IListFirebaseLinksRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>
Returns
TypeDescription
void
listFirebaseLinks(request: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>): void;
Parameters
NameDescription
request IListFirebaseLinksRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, protos.google.analytics.admin.v1beta.IListFirebaseLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IFirebaseLink>
Returns
TypeDescription
void

listFirebaseLinksAsync(request, options)

listFirebaseLinksAsync(request?: protos.google.analytics.admin.v1beta.IListFirebaseLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IFirebaseLink>;

Equivalent to listFirebaseLinks, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListFirebaseLinksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.IFirebaseLink>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing FirebaseLink. 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. 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-cloud/admin').v1beta;

  // 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.v1beta.IListFirebaseLinksRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListFirebaseLinksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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?: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IGoogleAdsLink[],
        protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest | null,
        protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse
    ]>;

Lists GoogleAdsLinks on a property.

Parameters
NameDescription
request IListGoogleAdsLinksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IGoogleAdsLink[], protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest | null, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of GoogleAdsLink. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listGoogleAdsLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listGoogleAdsLinks(request: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>): void;
Parameters
NameDescription
request IListGoogleAdsLinksRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>
Returns
TypeDescription
void
listGoogleAdsLinks(request: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>): void;
Parameters
NameDescription
request IListGoogleAdsLinksRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, protos.google.analytics.admin.v1beta.IListGoogleAdsLinksResponse | null | undefined, protos.google.analytics.admin.v1beta.IGoogleAdsLink>
Returns
TypeDescription
void

listGoogleAdsLinksAsync(request, options)

listGoogleAdsLinksAsync(request?: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IGoogleAdsLink>;

Equivalent to listGoogleAdsLinks, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListGoogleAdsLinksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.IGoogleAdsLink>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing GoogleAdsLink. 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 `ListGoogleAdsLinks` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListGoogleAdsLinks` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callListGoogleAdsLinks() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = adminClient.listGoogleAdsLinksAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListGoogleAdsLinks();

listGoogleAdsLinksStream(request, options)

listGoogleAdsLinksStream(request?: protos.google.analytics.admin.v1beta.IListGoogleAdsLinksRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListGoogleAdsLinksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1beta.IListMeasurementProtocolSecretsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret[],
        protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest | null,
        protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse
    ]>;

Returns child MeasurementProtocolSecrets under the specified parent Property.

Parameters
NameDescription
request IListMeasurementProtocolSecretsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret[], protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest | null, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of MeasurementProtocolSecret. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listMeasurementProtocolSecretsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMeasurementProtocolSecrets(request, options, callback)

listMeasurementProtocolSecrets(request: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>): void;
Parameters
NameDescription
request IListMeasurementProtocolSecretsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>
Returns
TypeDescription
void

listMeasurementProtocolSecrets(request, callback)

listMeasurementProtocolSecrets(request: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>): void;
Parameters
NameDescription
request IListMeasurementProtocolSecretsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsResponse | null | undefined, protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>
Returns
TypeDescription
void

listMeasurementProtocolSecretsAsync(request, options)

listMeasurementProtocolSecretsAsync(request?: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>;

Equivalent to listMeasurementProtocolSecrets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListMeasurementProtocolSecretsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing MeasurementProtocolSecret. 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 stream.
   *  Format:
   *  properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 10 resources will be returned.
   *  The maximum value is 10. Higher values will be coerced to the maximum.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListMeasurementProtocolSecrets`
   *  call. Provide this to retrieve the subsequent page. When paginating, all
   *  other parameters provided to `ListMeasurementProtocolSecrets` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callListMeasurementProtocolSecrets() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = adminClient.listMeasurementProtocolSecretsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListMeasurementProtocolSecrets();

listMeasurementProtocolSecretsStream(request, options)

listMeasurementProtocolSecretsStream(request?: protos.google.analytics.admin.v1beta.IListMeasurementProtocolSecretsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListMeasurementProtocolSecretsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.v1beta.IListPropertiesRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IProperty[],
        protos.google.analytics.admin.v1beta.IListPropertiesRequest | null,
        protos.google.analytics.admin.v1beta.IListPropertiesResponse
    ]>;

Returns child Properties under the specified parent Account.

Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

Parameters
NameDescription
request IListPropertiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IProperty[], protos.google.analytics.admin.v1beta.IListPropertiesRequest | null, protos.google.analytics.admin.v1beta.IListPropertiesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Property. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listPropertiesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listProperties(request, options, callback)

listProperties(request: protos.google.analytics.admin.v1beta.IListPropertiesRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>): void;
Parameters
NameDescription
request IListPropertiesRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>
Returns
TypeDescription
void

listProperties(request, callback)

listProperties(request: protos.google.analytics.admin.v1beta.IListPropertiesRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>): void;
Parameters
NameDescription
request IListPropertiesRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.IListPropertiesRequest, protos.google.analytics.admin.v1beta.IListPropertiesResponse | null | undefined, protos.google.analytics.admin.v1beta.IProperty>
Returns
TypeDescription
void

listPropertiesAsync(request, options)

listPropertiesAsync(request?: protos.google.analytics.admin.v1beta.IListPropertiesRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IProperty>;

Equivalent to listProperties, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListPropertiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.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-cloud/admin').v1beta;

    // 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.v1beta.IListPropertiesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request IListPropertiesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

matchAccountFromAccountName(accountName)

matchAccountFromAccountName(accountName: string): string | number;

Parse the account from Account resource.

Parameter
NameDescription
accountName string

A fully-qualified path representing Account resource.

Returns
TypeDescription
string | number

{string} A string representing the account.

matchAccountFromDataSharingSettingsName(dataSharingSettingsName)

matchAccountFromDataSharingSettingsName(dataSharingSettingsName: string): string | number;

Parse the account from DataSharingSettings resource.

Parameter
NameDescription
dataSharingSettingsName string

A fully-qualified path representing DataSharingSettings resource.

Returns
TypeDescription
string | number

{string} A string representing the account.

matchAccountSummaryFromAccountSummaryName(accountSummaryName)

matchAccountSummaryFromAccountSummaryName(accountSummaryName: string): string | number;

Parse the account_summary from AccountSummary resource.

Parameter
NameDescription
accountSummaryName string

A fully-qualified path representing AccountSummary resource.

Returns
TypeDescription
string | number

{string} A string representing the account_summary.

matchConversionEventFromConversionEventName(conversionEventName)

matchConversionEventFromConversionEventName(conversionEventName: string): string | number;

Parse the conversion_event from ConversionEvent resource.

Parameter
NameDescription
conversionEventName string

A fully-qualified path representing ConversionEvent resource.

Returns
TypeDescription
string | number

{string} A string representing the conversion_event.

matchCustomDimensionFromCustomDimensionName(customDimensionName)

matchCustomDimensionFromCustomDimensionName(customDimensionName: string): string | number;

Parse the custom_dimension from CustomDimension resource.

Parameter
NameDescription
customDimensionName string

A fully-qualified path representing CustomDimension resource.

Returns
TypeDescription
string | number

{string} A string representing the custom_dimension.

matchCustomMetricFromCustomMetricName(customMetricName)

matchCustomMetricFromCustomMetricName(customMetricName: string): string | number;

Parse the custom_metric from CustomMetric resource.

Parameter
NameDescription
customMetricName string

A fully-qualified path representing CustomMetric resource.

Returns
TypeDescription
string | number

{string} A string representing the custom_metric.

matchDataStreamFromDataStreamName(dataStreamName)

matchDataStreamFromDataStreamName(dataStreamName: string): string | number;

Parse the data_stream from DataStream resource.

Parameter
NameDescription
dataStreamName string

A fully-qualified path representing DataStream resource.

Returns
TypeDescription
string | number

{string} A string representing the data_stream.

matchDataStreamFromMeasurementProtocolSecretName(measurementProtocolSecretName)

matchDataStreamFromMeasurementProtocolSecretName(measurementProtocolSecretName: string): string | number;

Parse the data_stream from MeasurementProtocolSecret resource.

Parameter
NameDescription
measurementProtocolSecretName string

A fully-qualified path representing MeasurementProtocolSecret resource.

Returns
TypeDescription
string | number

{string} A string representing the data_stream.

matchFirebaseLinkFromFirebaseLinkName(firebaseLinkName)

matchFirebaseLinkFromFirebaseLinkName(firebaseLinkName: string): string | number;

Parse the firebase_link from FirebaseLink resource.

Parameter
NameDescription
firebaseLinkName string

A fully-qualified path representing FirebaseLink resource.

Returns
TypeDescription
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
NameDescription
googleAdsLinkName string

A fully-qualified path representing GoogleAdsLink resource.

Returns
TypeDescription
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
NameDescription
measurementProtocolSecretName string

A fully-qualified path representing MeasurementProtocolSecret resource.

Returns
TypeDescription
string | number

{string} A string representing the measurement_protocol_secret.

matchPropertyFromConversionEventName(conversionEventName)

matchPropertyFromConversionEventName(conversionEventName: string): string | number;

Parse the property from ConversionEvent resource.

Parameter
NameDescription
conversionEventName string

A fully-qualified path representing ConversionEvent resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromCustomDimensionName(customDimensionName)

matchPropertyFromCustomDimensionName(customDimensionName: string): string | number;

Parse the property from CustomDimension resource.

Parameter
NameDescription
customDimensionName string

A fully-qualified path representing CustomDimension resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromCustomMetricName(customMetricName)

matchPropertyFromCustomMetricName(customMetricName: string): string | number;

Parse the property from CustomMetric resource.

Parameter
NameDescription
customMetricName string

A fully-qualified path representing CustomMetric resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromDataRetentionSettingsName(dataRetentionSettingsName)

matchPropertyFromDataRetentionSettingsName(dataRetentionSettingsName: string): string | number;

Parse the property from DataRetentionSettings resource.

Parameter
NameDescription
dataRetentionSettingsName string

A fully-qualified path representing DataRetentionSettings resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromDataStreamName(dataStreamName)

matchPropertyFromDataStreamName(dataStreamName: string): string | number;

Parse the property from DataStream resource.

Parameter
NameDescription
dataStreamName string

A fully-qualified path representing DataStream resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromFirebaseLinkName(firebaseLinkName)

matchPropertyFromFirebaseLinkName(firebaseLinkName: string): string | number;

Parse the property from FirebaseLink resource.

Parameter
NameDescription
firebaseLinkName string

A fully-qualified path representing FirebaseLink resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromGoogleAdsLinkName(googleAdsLinkName)

matchPropertyFromGoogleAdsLinkName(googleAdsLinkName: string): string | number;

Parse the property from GoogleAdsLink resource.

Parameter
NameDescription
googleAdsLinkName string

A fully-qualified path representing GoogleAdsLink resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromMeasurementProtocolSecretName(measurementProtocolSecretName)

matchPropertyFromMeasurementProtocolSecretName(measurementProtocolSecretName: string): string | number;

Parse the property from MeasurementProtocolSecret resource.

Parameter
NameDescription
measurementProtocolSecretName string

A fully-qualified path representing MeasurementProtocolSecret resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

matchPropertyFromPropertyName(propertyName)

matchPropertyFromPropertyName(propertyName: string): string | number;

Parse the property from Property resource.

Parameter
NameDescription
propertyName string

A fully-qualified path representing Property resource.

Returns
TypeDescription
string | number

{string} A string representing the property.

measurementProtocolSecretPath(property, dataStream, measurementProtocolSecret)

measurementProtocolSecretPath(property: string, dataStream: string, measurementProtocolSecret: string): string;

Return a fully-qualified measurementProtocolSecret resource name string.

Parameters
NameDescription
property string
dataStream string
measurementProtocolSecret string
Returns
TypeDescription
string

{string} Resource name string.

propertyPath(property)

propertyPath(property: string): string;

Return a fully-qualified property resource name string.

Parameter
NameDescription
property string
Returns
TypeDescription
string

{string} Resource name string.

provisionAccountTicket(request, options)

provisionAccountTicket(request?: protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse,
        (protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | undefined),
        {} | undefined
    ]>;

Requests a ticket for creating an account.

Parameters
NameDescription
request IProvisionAccountTicketRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, (protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ProvisionAccountTicketResponse. 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 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-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callProvisionAccountTicket() {
    // Construct request
    const request = {
    };

    // Run request
    const response = await adminClient.provisionAccountTicket(request);
    console.log(response);
  }

  callProvisionAccountTicket();

provisionAccountTicket(request, options, callback)

provisionAccountTicket(request: protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IProvisionAccountTicketRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

provisionAccountTicket(request, callback)

provisionAccountTicket(request: protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IProvisionAccountTicketRequest
callback Callback<protos.google.analytics.admin.v1beta.IProvisionAccountTicketResponse, protos.google.analytics.admin.v1beta.IProvisionAccountTicketRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

runAccessReport(request, options)

runAccessReport(request?: protos.google.analytics.admin.v1beta.IRunAccessReportRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IRunAccessReportResponse,
        protos.google.analytics.admin.v1beta.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. The property must be in Google Analytics 360. 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).

Parameters
NameDescription
request IRunAccessReportRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IRunAccessReportResponse, protos.google.analytics.admin.v1beta.IRunAccessReportRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing RunAccessReportResponse. 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 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

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // 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.v1beta.IRunAccessReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IRunAccessReportResponse, protos.google.analytics.admin.v1beta.IRunAccessReportRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IRunAccessReportRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IRunAccessReportResponse, protos.google.analytics.admin.v1beta.IRunAccessReportRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

runAccessReport(request, callback)

runAccessReport(request: protos.google.analytics.admin.v1beta.IRunAccessReportRequest, callback: Callback<protos.google.analytics.admin.v1beta.IRunAccessReportResponse, protos.google.analytics.admin.v1beta.IRunAccessReportRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IRunAccessReportRequest
callback Callback<protos.google.analytics.admin.v1beta.IRunAccessReportResponse, protos.google.analytics.admin.v1beta.IRunAccessReportRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchChangeHistoryEvents(request, options)

searchChangeHistoryEvents(request?: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IChangeHistoryEvent[],
        protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest | null,
        protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse
    ]>;

Searches through all changes to an account or its children given the specified set of filters.

Parameters
NameDescription
request ISearchChangeHistoryEventsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IChangeHistoryEvent[], protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest | null, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of ChangeHistoryEvent. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using searchChangeHistoryEventsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

searchChangeHistoryEvents(request, options, callback)

searchChangeHistoryEvents(request: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>): void;
Parameters
NameDescription
request ISearchChangeHistoryEventsRequest
options CallOptions
callback PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>
Returns
TypeDescription
void

searchChangeHistoryEvents(request, callback)

searchChangeHistoryEvents(request: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, callback: PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>): void;
Parameters
NameDescription
request ISearchChangeHistoryEventsRequest
callback PaginationCallback<protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsResponse | null | undefined, protos.google.analytics.admin.v1beta.IChangeHistoryEvent>
Returns
TypeDescription
void

searchChangeHistoryEventsAsync(request, options)

searchChangeHistoryEventsAsync(request?: protos.google.analytics.admin.v1beta.ISearchChangeHistoryEventsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.admin.v1beta.IChangeHistoryEvent>;

Equivalent to searchChangeHistoryEvents, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request ISearchChangeHistoryEventsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.analytics.admin.v1beta.IChangeHistoryEvent>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ChangeHistoryEvent. 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 account resource for which to return change history
   *  resources.
   */
  // const account = 'abc123'
  /**
   *  Optional. Resource name for a child property. If set, only return changes
   *  made to this property or its child resources.
   */
  // const property = 'abc123'
  /**
   *  Optional. If set, only return changes if they are for a resource that
   *  matches at least one of these types.
   */
  // const resourceType = [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-cloud/admin').v1beta;

  // 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.v1beta.ISearchChangeHistoryEventsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request ISearchChangeHistoryEventsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

updateAccount(request, options)

updateAccount(request?: protos.google.analytics.admin.v1beta.IUpdateAccountRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IAccount,
        protos.google.analytics.admin.v1beta.IUpdateAccountRequest | undefined,
        {} | undefined
    ]>;

Updates an account.

Parameters
NameDescription
request IUpdateAccountRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Account. 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 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-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateAccount() {
    // Construct request
    const request = {
      account,
      updateMask,
    };

    // Run request
    const response = await adminClient.updateAccount(request);
    console.log(response);
  }

  callUpdateAccount();

updateAccount(request, options, callback)

updateAccount(request: protos.google.analytics.admin.v1beta.IUpdateAccountRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateAccountRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateAccount(request, callback)

updateAccount(request: protos.google.analytics.admin.v1beta.IUpdateAccountRequest, callback: Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateAccountRequest
callback Callback<protos.google.analytics.admin.v1beta.IAccount, protos.google.analytics.admin.v1beta.IUpdateAccountRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateConversionEvent(request, options)

updateConversionEvent(request?: protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IConversionEvent,
        (protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest | undefined),
        {} | undefined
    ]>;

Updates a conversion event with the specified attributes.

Parameters
NameDescription
request IUpdateConversionEventRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IConversionEvent, (protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 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-cloud/admin').v1beta;

  // 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.v1beta.IUpdateConversionEventRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateConversionEventRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateConversionEvent(request, callback)

updateConversionEvent(request: protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest, callback: Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateConversionEventRequest
callback Callback<protos.google.analytics.admin.v1beta.IConversionEvent, protos.google.analytics.admin.v1beta.IUpdateConversionEventRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCustomDimension(request, options)

updateCustomDimension(request?: protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomDimension,
        (protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | undefined),
        {} | undefined
    ]>;

Updates a CustomDimension on a property.

Parameters
NameDescription
request IUpdateCustomDimensionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomDimension, (protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The CustomDimension to update
   */
  // const customDimension = {}
  /**
   *  Required. The list of fields to be updated. Omitted fields will not be
   *  updated. To replace the entire entity, use one path with the string "*" to
   *  match all fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateCustomDimension() {
    // Construct request
    const request = {
      updateMask,
    };

    // Run request
    const response = await adminClient.updateCustomDimension(request);
    console.log(response);
  }

  callUpdateCustomDimension();

updateCustomDimension(request, options, callback)

updateCustomDimension(request: protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateCustomDimensionRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCustomDimension(request, callback)

updateCustomDimension(request: protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateCustomDimensionRequest
callback Callback<protos.google.analytics.admin.v1beta.ICustomDimension, protos.google.analytics.admin.v1beta.IUpdateCustomDimensionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCustomMetric(request, options)

updateCustomMetric(request?: protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.ICustomMetric,
        (protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | undefined),
        {} | undefined
    ]>;

Updates a CustomMetric on a property.

Parameters
NameDescription
request IUpdateCustomMetricRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.ICustomMetric, (protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The CustomMetric to update
   */
  // const customMetric = {}
  /**
   *  Required. The list of fields to be updated. Omitted fields will not be
   *  updated. To replace the entire entity, use one path with the string "*" to
   *  match all fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateCustomMetric() {
    // Construct request
    const request = {
      updateMask,
    };

    // Run request
    const response = await adminClient.updateCustomMetric(request);
    console.log(response);
  }

  callUpdateCustomMetric();

updateCustomMetric(request, options, callback)

updateCustomMetric(request: protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateCustomMetricRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateCustomMetric(request, callback)

updateCustomMetric(request: protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest, callback: Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateCustomMetricRequest
callback Callback<protos.google.analytics.admin.v1beta.ICustomMetric, protos.google.analytics.admin.v1beta.IUpdateCustomMetricRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDataRetentionSettings(request, options)

updateDataRetentionSettings(request?: protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataRetentionSettings,
        (protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | undefined),
        {} | undefined
    ]>;

Updates the singleton data retention settings for this property.

Parameters
NameDescription
request IUpdateDataRetentionSettingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataRetentionSettings, (protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The settings to update.
   *  The `name` field is used to identify the settings to be updated.
   */
  // const dataRetentionSettings = {}
  /**
   *  Required. The list of fields to be updated. Field names must be in snake
   *  case (e.g., "field_to_update"). Omitted fields will not be updated. To
   *  replace the entire entity, use one path with the string "*" to match all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateDataRetentionSettings() {
    // Construct request
    const request = {
      dataRetentionSettings,
      updateMask,
    };

    // Run request
    const response = await adminClient.updateDataRetentionSettings(request);
    console.log(response);
  }

  callUpdateDataRetentionSettings();

updateDataRetentionSettings(request, options, callback)

updateDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateDataRetentionSettingsRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDataRetentionSettings(request, callback)

updateDataRetentionSettings(request: protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateDataRetentionSettingsRequest
callback Callback<protos.google.analytics.admin.v1beta.IDataRetentionSettings, protos.google.analytics.admin.v1beta.IUpdateDataRetentionSettingsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDataStream(request, options)

updateDataStream(request?: protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IDataStream,
        protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | undefined,
        {} | undefined
    ]>;

Updates a DataStream on a property.

Parameters
NameDescription
request IUpdateDataStreamRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The DataStream to update
   */
  // const dataStream = {}
  /**
   *  Required. The list of fields to be updated. Omitted fields will not be
   *  updated. To replace the entire entity, use one path with the string "*" to
   *  match all fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateDataStream() {
    // Construct request
    const request = {
      updateMask,
    };

    // Run request
    const response = await adminClient.updateDataStream(request);
    console.log(response);
  }

  callUpdateDataStream();

updateDataStream(request, options, callback)

updateDataStream(request: protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateDataStreamRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateDataStream(request, callback)

updateDataStream(request: protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest, callback: Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateDataStreamRequest
callback Callback<protos.google.analytics.admin.v1beta.IDataStream, protos.google.analytics.admin.v1beta.IUpdateDataStreamRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
updateGoogleAdsLink(request?: protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IGoogleAdsLink,
        (protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | undefined),
        {} | undefined
    ]>;

Updates a GoogleAdsLink on a property

Parameters
NameDescription
request IUpdateGoogleAdsLinkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IGoogleAdsLink, (protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing GoogleAdsLink. 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 GoogleAdsLink to update
   */
  // const googleAdsLink = {}
  /**
   *  Required. The list of fields to be updated. Field names must be in snake
   *  case (e.g., "field_to_update"). Omitted fields will not be updated. To
   *  replace the entire entity, use one path with the string "*" to match all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateGoogleAdsLink() {
    // Construct request
    const request = {
      updateMask,
    };

    // Run request
    const response = await adminClient.updateGoogleAdsLink(request);
    console.log(response);
  }

  callUpdateGoogleAdsLink();

updateGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateGoogleAdsLinkRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void
updateGoogleAdsLink(request: protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest, callback: Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateGoogleAdsLinkRequest
callback Callback<protos.google.analytics.admin.v1beta.IGoogleAdsLink, protos.google.analytics.admin.v1beta.IUpdateGoogleAdsLinkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateMeasurementProtocolSecret(request, options)

updateMeasurementProtocolSecret(request?: protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret,
        (protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | undefined),
        {} | undefined
    ]>;

Updates a measurement protocol secret.

Parameters
NameDescription
request IUpdateMeasurementProtocolSecretRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, (protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing MeasurementProtocolSecret. 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 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-cloud/admin').v1beta;

  // 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.v1beta.IUpdateMeasurementProtocolSecretRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateMeasurementProtocolSecretRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateMeasurementProtocolSecret(request, callback)

updateMeasurementProtocolSecret(request: protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest, callback: Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateMeasurementProtocolSecretRequest
callback Callback<protos.google.analytics.admin.v1beta.IMeasurementProtocolSecret, protos.google.analytics.admin.v1beta.IUpdateMeasurementProtocolSecretRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateProperty(request, options)

updateProperty(request?: protos.google.analytics.admin.v1beta.IUpdatePropertyRequest, options?: CallOptions): Promise<[
        protos.google.analytics.admin.v1beta.IProperty,
        protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | undefined,
        {} | undefined
    ]>;

Updates a property.

Parameters
NameDescription
request IUpdatePropertyRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Property. 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 property to update.
   *  The property's `name` field is used to identify the property to be
   *  updated.
   */
  // const property = {}
  /**
   *  Required. The list of fields to be updated. Field names must be in snake
   *  case (e.g., "field_to_update"). Omitted fields will not be updated. To
   *  replace the entire entity, use one path with the string "*" to match all
   *  fields.
   */
  // const updateMask = {}

  // Imports the Admin library
  const {AnalyticsAdminServiceClient} = require('@google-cloud/admin').v1beta;

  // Instantiates a client
  const adminClient = new AnalyticsAdminServiceClient();

  async function callUpdateProperty() {
    // Construct request
    const request = {
      property,
      updateMask,
    };

    // Run request
    const response = await adminClient.updateProperty(request);
    console.log(response);
  }

  callUpdateProperty();

updateProperty(request, options, callback)

updateProperty(request: protos.google.analytics.admin.v1beta.IUpdatePropertyRequest, options: CallOptions, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdatePropertyRequest
options CallOptions
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateProperty(request, callback)

updateProperty(request: protos.google.analytics.admin.v1beta.IUpdatePropertyRequest, callback: Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdatePropertyRequest
callback Callback<protos.google.analytics.admin.v1beta.IProperty, protos.google.analytics.admin.v1beta.IUpdatePropertyRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void