AnalyticsAdminServiceClient

Constructor

new AnalyticsAdminServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of AnalyticsAdminServiceClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

accountAccessBindingPath(account, access_binding) → {string}

Return a fully-qualified accountAccessBinding resource name string.

Parameters:

Name	Type	Description
`account`	string
`access_binding`	string

Returns:

Type	Description
string	Resource name string.

accountPath(account) → {string}

Return a fully-qualified account resource name string.

Parameters:

Name	Type	Description
`account`	string

Returns:

Type	Description
string	Resource name string.

accountSummaryPath(account_summary) → {string}

Return a fully-qualified accountSummary resource name string.

Parameters:

Name	Type	Description
`account_summary`	string

Returns:

Type	Description
string	Resource name string.

adSenseLinkPath(property, adsense_link) → {string}

Return a fully-qualified adSenseLink resource name string.

Parameters:

Name	Type	Description
`property`	string
`adsense_link`	string

Returns:

Type	Description
string	Resource name string.

attributionSettingsPath(property) → {string}

Return a fully-qualified attributionSettings resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

audiencePath(property, audience) → {string}

Return a fully-qualified audience resource name string.

Parameters:

Name	Type	Description
`property`	string
`audience`	string

Returns:

Type	Description
string	Resource name string.

bigQueryLinkPath(property, bigquery_link) → {string}

Return a fully-qualified bigQueryLink resource name string.

Parameters:

Name	Type	Description
`property`	string
`bigquery_link`	string

Returns:

Type	Description
string	Resource name string.

calculatedMetricPath(property, calculated_metric) → {string}

Return a fully-qualified calculatedMetric resource name string.

Parameters:

Name	Type	Description
`property`	string
`calculated_metric`	string

Returns:

Type	Description
string	Resource name string.

channelGroupPath(property, channel_group) → {string}

Return a fully-qualified channelGroup resource name string.

Parameters:

Name	Type	Description
`property`	string
`channel_group`	string

Returns:

Type	Description
string	Resource name string.

close() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

conversionEventPath(property, conversion_event) → {string}

Return a fully-qualified conversionEvent resource name string.

Parameters:

Name	Type	Description
`property`	string
`conversion_event`	string

Returns:

Type	Description
string	Resource name string.

customDimensionPath(property, custom_dimension) → {string}

Return a fully-qualified customDimension resource name string.

Parameters:

Name	Type	Description
`property`	string
`custom_dimension`	string

Returns:

Type	Description
string	Resource name string.

customMetricPath(property, custom_metric) → {string}

Return a fully-qualified customMetric resource name string.

Parameters:

Name	Type	Description
`property`	string
`custom_metric`	string

Returns:

Type	Description
string	Resource name string.

dataRedactionSettingsPath(property, data_stream) → {string}

Return a fully-qualified dataRedactionSettings resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string

Returns:

Type	Description
string	Resource name string.

dataRetentionSettingsPath(property) → {string}

Return a fully-qualified dataRetentionSettings resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

dataSharingSettingsPath(account) → {string}

Return a fully-qualified dataSharingSettings resource name string.

Parameters:

Name	Type	Description
`account`	string

Returns:

Type	Description
string	Resource name string.

dataStreamPath(property, data_stream) → {string}

Return a fully-qualified dataStream resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string

Returns:

Type	Description
string	Resource name string.

displayVideo360AdvertiserLinkPath(property) → {string}

Return a fully-qualified displayVideo360AdvertiserLink resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

displayVideo360AdvertiserLinkProposalPath(property) → {string}

Return a fully-qualified displayVideo360AdvertiserLinkProposal resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

enhancedMeasurementSettingsPath(property, data_stream) → {string}

Return a fully-qualified enhancedMeasurementSettings resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string

Returns:

Type	Description
string	Resource name string.

eventCreateRulePath(property, data_stream, event_create_rule) → {string}

Return a fully-qualified eventCreateRule resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string
`event_create_rule`	string

Returns:

Type	Description
string	Resource name string.

eventEditRulePath(property, data_stream, event_edit_rule) → {string}

Return a fully-qualified eventEditRule resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string
`event_edit_rule`	string

Returns:

Type	Description
string	Resource name string.

expandedDataSetPath(property, expanded_data_set) → {string}

Return a fully-qualified expandedDataSet resource name string.

Parameters:

Name	Type	Description
`property`	string
`expanded_data_set`	string

Returns:

Type	Description
string	Resource name string.

firebaseLinkPath(property, firebase_link) → {string}

Return a fully-qualified firebaseLink resource name string.

Parameters:

Name	Type	Description
`property`	string
`firebase_link`	string

Returns:

Type	Description
string	Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

globalSiteTagPath(property, data_stream) → {string}

Return a fully-qualified globalSiteTag resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string

Returns:

Type	Description
string	Resource name string.

googleAdsLinkPath(property, google_ads_link) → {string}

Return a fully-qualified googleAdsLink resource name string.

Parameters:

Name	Type	Description
`property`	string
`google_ads_link`	string

Returns:

Type	Description
string	Resource name string.

googleSignalsSettingsPath(property) → {string}

Return a fully-qualified googleSignalsSettings resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

keyEventPath(property, key_event) → {string}

Return a fully-qualified keyEvent resource name string.

Parameters:

Name	Type	Description
`property`	string
`key_event`	string

Returns:

Type	Description
string	Resource name string.

listAccessBindingsAsync(request, optionsopt) → {Object}

Equivalent to listAccessBindings, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Formats:

accounts/{account}
properties/{property}

pageSize

number

The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500.

pageToken

string

A page token, received from a previous ListAccessBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccessBindings must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AccessBinding. 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. Formats:
   *  - accounts/{account}
   *  - properties/{property}
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of access bindings to return.
   *  The service may return fewer than this value.
   *  If unspecified, at most 200 access bindings will be returned.
   *  The maximum value is 500; values above 500 will be coerced to 500.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListAccessBindings` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListAccessBindings` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListAccessBindings();

listAccessBindingsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Formats:

accounts/{account}
properties/{property}

pageSize

number

pageToken

string

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing AccessBinding on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAccessBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAccountSummariesAsync(request, optionsopt) → {Object}

Equivalent to listAccountSummaries, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`pageSize`	number	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)
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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-analytics/admin').v1alpha;

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

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

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

  callListAccountSummaries();

listAccountSummariesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`pageSize`	number	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)
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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.

listAccountsAsync(request, optionsopt) → {Object}

Equivalent to listAccounts, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`pageSize`	number	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)
`pageToken`	string	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.
`showDeleted`	boolean	Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Account. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The maximum number of resources to return. The service may return
   *  fewer than this value, even if there are additional pages.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200; (higher values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListAccounts` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListAccounts` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Whether to include soft-deleted (ie: "trashed") Accounts in the
   *  results. Accounts can be inspected to determine whether they are deleted or
   *  not.
   */
  // const showDeleted = true

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

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

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

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

  callListAccounts();

listAccountsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`pageSize`	number	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)
`pageToken`	string	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.
`showDeleted`	boolean	Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
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.

listAdSenseLinksAsync(request, optionsopt) → {Object}

Equivalent to listAdSenseLinks, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234

pageSize

number

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).

pageToken

string

A page token received from a previous ListAdSenseLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAdSenseLinks must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AdSenseLink. 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. Resource name of the parent property.
   *  Format: properties/{propertyId}
   *  Example: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token received from a previous `ListAdSenseLinks` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListAdSenseLinks` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListAdSenseLinks();

listAdSenseLinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234

pageSize

number

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).

pageToken

string

A page token received from a previous ListAdSenseLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAdSenseLinks must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing AdSenseLink on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listAdSenseLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listAudiencesAsync(request, optionsopt) → {Object}

Equivalent to listAudiences, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListAudiences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAudiences must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Audience. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListAudiences` call. Provide this
   *  to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListAudiences` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListAudiences();

listAudiencesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListAudiences call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAudiences must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Audience on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listAudiencesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBigQueryLinksAsync(request, optionsopt) → {Object}

Equivalent to listBigQueryLinks, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234
`pageSize`	number	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)
`pageToken`	string	A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

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

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

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

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

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

  callListBigQueryLinks();

listBigQueryLinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234
`pageSize`	number	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)
`pageToken`	string	A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing BigQueryLink on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBigQueryLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCalculatedMetricsAsync(request, optionsopt) → {Object}

Equivalent to listCalculatedMetrics, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

parent

string

Required. Example format: properties/1234

pageSize

number

Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

pageToken

string

Optional. A page token, received from a previous ListCalculatedMetrics call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCalculatedMetrics must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CalculatedMetric. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListCalculatedMetrics`
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListCalculatedMetrics`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListCalculatedMetrics();

listCalculatedMetricsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

parent

string

Required. Example format: properties/1234

pageSize

number

Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

pageToken

string

Optional. A page token, received from a previous ListCalculatedMetrics call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCalculatedMetrics must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing CalculatedMetric on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCalculatedMetricsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listChannelGroupsAsync(request, optionsopt) → {Object}

Equivalent to listChannelGroups, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The property for which to list ChannelGroups. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListChannelGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannelGroups must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ChannelGroup. 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 property for which to list ChannelGroups.
   *  Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListChannelGroups` call. Provide
   *  this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListChannelGroups`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListChannelGroups();

listChannelGroupsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. The property for which to list ChannelGroups. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListChannelGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannelGroups must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing ChannelGroup on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listChannelGroupsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listConversionEventsAsync(request, optionsopt) → {Object}

Equivalent to listConversionEvents, but returns an iterable object.

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

Deprecated: ListConversionEvents is deprecated and may be removed in a future version.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The resource name of the parent property. Example: 'properties/123'
`pageSize`	number	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)
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ConversionEvent. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the parent property.
   *  Example: 'properties/123'
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200; (higher values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListConversionEvents` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListConversionEvents`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListConversionEvents();

listConversionEventsStream(request, optionsopt) → {Stream}

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

Deprecated: ListConversionEvents is deprecated and may be removed in a future version.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The resource name of the parent property. Example: 'properties/123'
`pageSize`	number	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)
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing ConversionEvent 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.

listCustomDimensionsAsync(request, optionsopt) → {Object}

Equivalent to listCustomDimensions, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CustomDimension. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListCustomDimensions` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListCustomDimensions`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListCustomDimensions();

listCustomDimensionsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing CustomDimension 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.

listCustomMetricsAsync(request, optionsopt) → {Object}

Equivalent to listCustomMetrics, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CustomMetric. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListCustomMetrics` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListCustomMetrics` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListCustomMetrics();

listCustomMetricsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing CustomMetric 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.

listDataStreamsAsync(request, optionsopt) → {Object}

Equivalent to listDataStreams, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DataStream. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Example format: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListDataStreams` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListDataStreams` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListDataStreams();

listDataStreamsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing DataStream 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.

listDisplayVideo360AdvertiserLinkProposalsAsync(request, optionsopt) → {Object}

Equivalent to listDisplayVideo360AdvertiserLinkProposals, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListDisplayVideo360AdvertiserLinkProposals call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinkProposals must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

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

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

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

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

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

  callListDisplayVideo360AdvertiserLinkProposals();

listDisplayVideo360AdvertiserLinkProposalsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListDisplayVideo360AdvertiserLinkProposals call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinkProposals must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing DisplayVideo360AdvertiserLinkProposal on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDisplayVideo360AdvertiserLinkProposalsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listDisplayVideo360AdvertiserLinksAsync(request, optionsopt) → {Object}

Equivalent to listDisplayVideo360AdvertiserLinks, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListDisplayVideo360AdvertiserLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinks must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

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

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

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

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

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

  callListDisplayVideo360AdvertiserLinks();

listDisplayVideo360AdvertiserLinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListDisplayVideo360AdvertiserLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDisplayVideo360AdvertiserLinks must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing DisplayVideo360AdvertiserLink on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDisplayVideo360AdvertiserLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEventCreateRulesAsync(request, optionsopt) → {Object}

Equivalent to listEventCreateRules, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/123/dataStreams/456

pageSize

number

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).

pageToken

string

A page token, received from a previous ListEventCreateRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEventCreateRules must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing EventCreateRule. 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/123/dataStreams/456
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListEventCreateRules` call. Provide
   *  this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListEventCreateRules`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListEventCreateRules();

listEventCreateRulesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/123/dataStreams/456

pageSize

number

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).

pageToken

string

A page token, received from a previous ListEventCreateRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEventCreateRules must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing EventCreateRule on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listEventCreateRulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEventEditRulesAsync(request, optionsopt) → {Object}

Equivalent to listEventEditRules, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

parent

string

Required. Example format: properties/123/dataStreams/456

pageSize

number

Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

pageToken

string

Optional. A page token, received from a previous ListEventEditRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEventEditRules must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing EventEditRule. 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/123/dataStreams/456
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of resources to return.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListEventEditRules` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListEventEditRules`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListEventEditRules();

listEventEditRulesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Attributes Description

parent

string

Required. Example format: properties/123/dataStreams/456

pageSize

number

Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

pageToken

string

Optional. A page token, received from a previous ListEventEditRules call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListEventEditRules must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing EventEditRule 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 listEventEditRulesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listExpandedDataSetsAsync(request, optionsopt) → {Object}

Equivalent to listExpandedDataSets, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListExpandedDataSets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExpandedDataSet must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

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

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

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

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

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

  callListExpandedDataSets();

listExpandedDataSetsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListExpandedDataSets call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListExpandedDataSet must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing ExpandedDataSet on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listExpandedDataSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFirebaseLinksAsync(request, optionsopt) → {Object}

Equivalent to listFirebaseLinks, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Format: properties/{property_id}

Example: properties/1234

pageSize

number

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)

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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-analytics/admin').v1alpha;

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

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

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

  callListFirebaseLinks();

listFirebaseLinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Format: properties/{property_id}

Example: properties/1234

pageSize

number

pageToken

string

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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.

listGoogleAdsLinksAsync(request, optionsopt) → {Object}

Equivalent to listGoogleAdsLinks, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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-analytics/admin').v1alpha;

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

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

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

  callListGoogleAdsLinks();

listGoogleAdsLinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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.

listKeyEventsAsync(request, optionsopt) → {Object}

Equivalent to listKeyEvents, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The resource name of the parent property. Example: 'properties/123'
`pageSize`	number	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)
`pageToken`	string	A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

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

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

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

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

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

  callListKeyEvents();

listKeyEventsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The resource name of the parent property. Example: 'properties/123'
`pageSize`	number	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)
`pageToken`	string	A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing KeyEvent 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 `listKeyEventsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMeasurementProtocolSecretsAsync(request, optionsopt) → {Object}

Equivalent to listMeasurementProtocolSecrets, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
`pageSize`	number	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.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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-analytics/admin').v1alpha;

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

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

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

  callListMeasurementProtocolSecrets();

listMeasurementProtocolSecretsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
`pageSize`	number	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.
`pageToken`	string	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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.

listPropertiesAsync(request, optionsopt) → {Object}

Equivalent to listProperties, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`filter`	string	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. \|`
`pageSize`	number	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)
`pageToken`	string	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.
`showDeleted`	boolean	Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Property. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. An expression for filtering the results of the request.
   *  Fields eligible for filtering are:
   *  `parent:`(The resource name of the parent account/property) or
   *  `ancestor:`(The resource name of the parent account) or
   *  `firebase_project:`(The id or number of the linked firebase project).
   *  Some examples of filters:
   *  ```
   *  | Filter                      | Description                               |
   *  |-----------------------------|-------------------------------------------|
   *  | parent:accounts/123         | The account with account id: 123.       |
   *  | parent:properties/123       | The property with property id: 123.       |
   *  | ancestor:accounts/123       | The account with account id: 123.         |
   *  | firebase_project:project-id | The firebase project with id: project-id. |
   *  | firebase_project:123        | The firebase project with number: 123.    |
   *  ```
   */
  // const filter = 'abc123'
  /**
   *  The maximum number of resources to return. The service may return
   *  fewer than this value, even if there are additional pages.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200; (higher values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListProperties` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListProperties` must
   *  match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Whether to include soft-deleted (ie: "trashed") Properties in the
   *  results. Properties can be inspected to determine whether they are deleted
   *  or not.
   */
  // const showDeleted = true

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

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

  async function callListProperties() {
    // Construct request
    const request = {
      filter,
    };

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

  callListProperties();

listPropertiesStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`filter`	string	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. \|`
`pageSize`	number	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)
`pageToken`	string	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.
`showDeleted`	boolean	Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
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.

listRollupPropertySourceLinksAsync(request, optionsopt) → {Object}

Equivalent to listRollupPropertySourceLinks, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234
`pageSize`	number	<optional>	Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListRollupPropertySourceLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollupPropertySourceLinks` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing RollupPropertySourceLink. 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 name of the roll-up property to list roll-up property source
   *  links under. Format: properties/{property_id} Example: properties/1234
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of resources to return. The service may return
   *  fewer than this value, even if there are additional pages.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200; (higher values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListRollupPropertySourceLinks` call. Provide this to retrieve the
   *  subsequent page. When paginating, all other parameters provided to
   *  `ListRollupPropertySourceLinks` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListRollupPropertySourceLinks();

listRollupPropertySourceLinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234
`pageSize`	number	<optional>	Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListRollupPropertySourceLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollupPropertySourceLinks` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing RollupPropertySourceLink on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRollupPropertySourceLinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSKAdNetworkConversionValueSchemasAsync(request, optionsopt) → {Object}

Equivalent to listSKAdNetworkConversionValueSchemas, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678
`pageSize`	number	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)
`pageToken`	string	A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing SKAdNetworkConversionValueSchema. 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 DataStream resource to list schemas for.
   *  Format:
   *  properties/{property_id}/dataStreams/{dataStream}
   *  Example: properties/1234/dataStreams/5678
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of resources to return. The service may return
   *  fewer than this value, even if there are additional pages.
   *  If unspecified, at most 50 resources will be returned.
   *  The maximum value is 200; (higher values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous
   *  `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the
   *  subsequent page. When paginating, all other parameters provided to
   *  `ListSKAdNetworkConversionValueSchema` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListSKAdNetworkConversionValueSchemas();

listSKAdNetworkConversionValueSchemasStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678
`pageSize`	number	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)
`pageToken`	string	A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing SKAdNetworkConversionValueSchema on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSKAdNetworkConversionValueSchemasAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSearchAds360LinksAsync(request, optionsopt) → {Object}

Equivalent to listSearchAds360Links, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListSearchAds360Links call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSearchAds360Links must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

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

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

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

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

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

  callListSearchAds360Links();

listSearchAds360LinksStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name Type Description

parent

string

Required. Example format: properties/1234

pageSize

number

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).

pageToken

string

A page token, received from a previous ListSearchAds360Links call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSearchAds360Links must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing SearchAds360Link on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSearchAds360LinksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSubpropertyEventFiltersAsync(request, optionsopt) → {Object}

Equivalent to listSubpropertyEventFilters, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123
`pageSize`	number	<optional>	Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing SubpropertyEventFilter. 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. Resource name of the ordinary property.
   *  Format: properties/property_id
   *  Example: properties/123
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of resources to return. The service may return
   *  fewer than this value, even if there are additional pages. If unspecified,
   *  at most 50 resources will be returned. The maximum value is 200; (higher
   *  values will be coerced to the maximum)
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent
   *  page. When paginating, all other parameters provided to
   *  `ListSubpropertyEventFilters` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListSubpropertyEventFilters();

listSubpropertyEventFiltersStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123
`pageSize`	number	<optional>	Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
`pageToken`	string	<optional>	Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing SubpropertyEventFilter on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSubpropertyEventFiltersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAccessBindingFromAccountAccessBindingName(accountAccessBindingName) → {string}

Parse the access_binding from AccountAccessBinding resource.

Parameters:

Name	Type	Description
`accountAccessBindingName`	string	A fully-qualified path representing account_access_binding resource.

Returns:

Type	Description
string	A string representing the access_binding.

matchAccessBindingFromPropertyAccessBindingName(propertyAccessBindingName) → {string}

Parse the access_binding from PropertyAccessBinding resource.

Parameters:

Name	Type	Description
`propertyAccessBindingName`	string	A fully-qualified path representing property_access_binding resource.

Returns:

Type	Description
string	A string representing the access_binding.

matchAccountFromAccountAccessBindingName(accountAccessBindingName) → {string}

Parse the account from AccountAccessBinding resource.

Parameters:

Name	Type	Description
`accountAccessBindingName`	string	A fully-qualified path representing account_access_binding resource.

Returns:

Type	Description
string	A string representing the account.

matchAccountFromAccountName(accountName) → {string}

Parse the account from Account resource.

Parameters:

Name	Type	Description
`accountName`	string	A fully-qualified path representing Account resource.

Returns:

Type	Description
string	A string representing the account.

matchAccountFromDataSharingSettingsName(dataSharingSettingsName) → {string}

Parse the account from DataSharingSettings resource.

Parameters:

Name	Type	Description
`dataSharingSettingsName`	string	A fully-qualified path representing DataSharingSettings resource.

Returns:

Type	Description
string	A string representing the account.

matchAccountSummaryFromAccountSummaryName(accountSummaryName) → {string}

Parse the account_summary from AccountSummary resource.

Parameters:

Name	Type	Description
`accountSummaryName`	string	A fully-qualified path representing AccountSummary resource.

Returns:

Type	Description
string	A string representing the account_summary.

matchAdsenseLinkFromAdSenseLinkName(adSenseLinkName) → {string}

Parse the adsense_link from AdSenseLink resource.

Parameters:

Name	Type	Description
`adSenseLinkName`	string	A fully-qualified path representing AdSenseLink resource.

Returns:

Type	Description
string	A string representing the adsense_link.

matchAudienceFromAudienceName(audienceName) → {string}

Parse the audience from Audience resource.

Parameters:

Name	Type	Description
`audienceName`	string	A fully-qualified path representing Audience resource.

Returns:

Type	Description
string	A string representing the audience.

matchBigqueryLinkFromBigQueryLinkName(bigQueryLinkName) → {string}

Parse the bigquery_link from BigQueryLink resource.

Parameters:

Name	Type	Description
`bigQueryLinkName`	string	A fully-qualified path representing BigQueryLink resource.

Returns:

Type	Description
string	A string representing the bigquery_link.

matchCalculatedMetricFromCalculatedMetricName(calculatedMetricName) → {string}

Parse the calculated_metric from CalculatedMetric resource.

Parameters:

Name	Type	Description
`calculatedMetricName`	string	A fully-qualified path representing CalculatedMetric resource.

Returns:

Type	Description
string	A string representing the calculated_metric.

matchChannelGroupFromChannelGroupName(channelGroupName) → {string}

Parse the channel_group from ChannelGroup resource.

Parameters:

Name	Type	Description
`channelGroupName`	string	A fully-qualified path representing ChannelGroup resource.

Returns:

Type	Description
string	A string representing the channel_group.

matchConversionEventFromConversionEventName(conversionEventName) → {string}

Parse the conversion_event from ConversionEvent resource.

Parameters:

Name	Type	Description
`conversionEventName`	string	A fully-qualified path representing ConversionEvent resource.

Returns:

Type	Description
string	A string representing the conversion_event.

matchCustomDimensionFromCustomDimensionName(customDimensionName) → {string}

Parse the custom_dimension from CustomDimension resource.

Parameters:

Name	Type	Description
`customDimensionName`	string	A fully-qualified path representing CustomDimension resource.

Returns:

Type	Description
string	A string representing the custom_dimension.

matchCustomMetricFromCustomMetricName(customMetricName) → {string}

Parse the custom_metric from CustomMetric resource.

Parameters:

Name	Type	Description
`customMetricName`	string	A fully-qualified path representing CustomMetric resource.

Returns:

Type	Description
string	A string representing the custom_metric.

matchDataStreamFromDataRedactionSettingsName(dataRedactionSettingsName) → {string}

Parse the data_stream from DataRedactionSettings resource.

Parameters:

Name	Type	Description
`dataRedactionSettingsName`	string	A fully-qualified path representing DataRedactionSettings resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromDataStreamName(dataStreamName) → {string}

Parse the data_stream from DataStream resource.

Parameters:

Name	Type	Description
`dataStreamName`	string	A fully-qualified path representing DataStream resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromEnhancedMeasurementSettingsName(enhancedMeasurementSettingsName) → {string}

Parse the data_stream from EnhancedMeasurementSettings resource.

Parameters:

Name	Type	Description
`enhancedMeasurementSettingsName`	string	A fully-qualified path representing EnhancedMeasurementSettings resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromEventCreateRuleName(eventCreateRuleName) → {string}

Parse the data_stream from EventCreateRule resource.

Parameters:

Name	Type	Description
`eventCreateRuleName`	string	A fully-qualified path representing EventCreateRule resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromEventEditRuleName(eventEditRuleName) → {string}

Parse the data_stream from EventEditRule resource.

Parameters:

Name	Type	Description
`eventEditRuleName`	string	A fully-qualified path representing EventEditRule resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromGlobalSiteTagName(globalSiteTagName) → {string}

Parse the data_stream from GlobalSiteTag resource.

Parameters:

Name	Type	Description
`globalSiteTagName`	string	A fully-qualified path representing GlobalSiteTag resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromMeasurementProtocolSecretName(measurementProtocolSecretName) → {string}

Parse the data_stream from MeasurementProtocolSecret resource.

Parameters:

Name	Type	Description
`measurementProtocolSecretName`	string	A fully-qualified path representing MeasurementProtocolSecret resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchDataStreamFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName) → {string}

Parse the data_stream from SKAdNetworkConversionValueSchema resource.

Parameters:

Name	Type	Description
`sKAdNetworkConversionValueSchemaName`	string	A fully-qualified path representing SKAdNetworkConversionValueSchema resource.

Returns:

Type	Description
string	A string representing the data_stream.

matchEventCreateRuleFromEventCreateRuleName(eventCreateRuleName) → {string}

Parse the event_create_rule from EventCreateRule resource.

Parameters:

Name	Type	Description
`eventCreateRuleName`	string	A fully-qualified path representing EventCreateRule resource.

Returns:

Type	Description
string	A string representing the event_create_rule.

matchEventEditRuleFromEventEditRuleName(eventEditRuleName) → {string}

Parse the event_edit_rule from EventEditRule resource.

Parameters:

Name	Type	Description
`eventEditRuleName`	string	A fully-qualified path representing EventEditRule resource.

Returns:

Type	Description
string	A string representing the event_edit_rule.

matchExpandedDataSetFromExpandedDataSetName(expandedDataSetName) → {string}

Parse the expanded_data_set from ExpandedDataSet resource.

Parameters:

Name	Type	Description
`expandedDataSetName`	string	A fully-qualified path representing ExpandedDataSet resource.

Returns:

Type	Description
string	A string representing the expanded_data_set.

matchFirebaseLinkFromFirebaseLinkName(firebaseLinkName) → {string}

Parse the firebase_link from FirebaseLink resource.

Parameters:

Name	Type	Description
`firebaseLinkName`	string	A fully-qualified path representing FirebaseLink resource.

Returns:

Type	Description
string	A string representing the firebase_link.

matchGoogleAdsLinkFromGoogleAdsLinkName(googleAdsLinkName) → {string}

Parse the google_ads_link from GoogleAdsLink resource.

Parameters:

Name	Type	Description
`googleAdsLinkName`	string	A fully-qualified path representing GoogleAdsLink resource.

Returns:

Type	Description
string	A string representing the google_ads_link.

matchKeyEventFromKeyEventName(keyEventName) → {string}

Parse the key_event from KeyEvent resource.

Parameters:

Name	Type	Description
`keyEventName`	string	A fully-qualified path representing KeyEvent resource.

Returns:

Type	Description
string	A string representing the key_event.

matchMeasurementProtocolSecretFromMeasurementProtocolSecretName(measurementProtocolSecretName) → {string}

Parse the measurement_protocol_secret from MeasurementProtocolSecret resource.

Parameters:

Name	Type	Description
`measurementProtocolSecretName`	string	A fully-qualified path representing MeasurementProtocolSecret resource.

Returns:

Type	Description
string	A string representing the measurement_protocol_secret.

matchPropertyFromAdSenseLinkName(adSenseLinkName) → {string}

Parse the property from AdSenseLink resource.

Parameters:

Name	Type	Description
`adSenseLinkName`	string	A fully-qualified path representing AdSenseLink resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromAttributionSettingsName(attributionSettingsName) → {string}

Parse the property from AttributionSettings resource.

Parameters:

Name	Type	Description
`attributionSettingsName`	string	A fully-qualified path representing AttributionSettings resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromAudienceName(audienceName) → {string}

Parse the property from Audience resource.

Parameters:

Name	Type	Description
`audienceName`	string	A fully-qualified path representing Audience resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromBigQueryLinkName(bigQueryLinkName) → {string}

Parse the property from BigQueryLink resource.

Parameters:

Name	Type	Description
`bigQueryLinkName`	string	A fully-qualified path representing BigQueryLink resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromCalculatedMetricName(calculatedMetricName) → {string}

Parse the property from CalculatedMetric resource.

Parameters:

Name	Type	Description
`calculatedMetricName`	string	A fully-qualified path representing CalculatedMetric resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromChannelGroupName(channelGroupName) → {string}

Parse the property from ChannelGroup resource.

Parameters:

Name	Type	Description
`channelGroupName`	string	A fully-qualified path representing ChannelGroup resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromConversionEventName(conversionEventName) → {string}

Parse the property from ConversionEvent resource.

Parameters:

Name	Type	Description
`conversionEventName`	string	A fully-qualified path representing ConversionEvent resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromCustomDimensionName(customDimensionName) → {string}

Parse the property from CustomDimension resource.

Parameters:

Name	Type	Description
`customDimensionName`	string	A fully-qualified path representing CustomDimension resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromCustomMetricName(customMetricName) → {string}

Parse the property from CustomMetric resource.

Parameters:

Name	Type	Description
`customMetricName`	string	A fully-qualified path representing CustomMetric resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromDataRedactionSettingsName(dataRedactionSettingsName) → {string}

Parse the property from DataRedactionSettings resource.

Parameters:

Name	Type	Description
`dataRedactionSettingsName`	string	A fully-qualified path representing DataRedactionSettings resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromDataRetentionSettingsName(dataRetentionSettingsName) → {string}

Parse the property from DataRetentionSettings resource.

Parameters:

Name	Type	Description
`dataRetentionSettingsName`	string	A fully-qualified path representing DataRetentionSettings resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromDataStreamName(dataStreamName) → {string}

Parse the property from DataStream resource.

Parameters:

Name	Type	Description
`dataStreamName`	string	A fully-qualified path representing DataStream resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromDisplayVideo360AdvertiserLinkName(displayVideo360AdvertiserLinkName) → {string}

Parse the property from DisplayVideo360AdvertiserLink resource.

Parameters:

Name	Type	Description
`displayVideo360AdvertiserLinkName`	string	A fully-qualified path representing DisplayVideo360AdvertiserLink resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromDisplayVideo360AdvertiserLinkProposalName(displayVideo360AdvertiserLinkProposalName) → {string}

Parse the property from DisplayVideo360AdvertiserLinkProposal resource.

Parameters:

Name	Type	Description
`displayVideo360AdvertiserLinkProposalName`	string	A fully-qualified path representing DisplayVideo360AdvertiserLinkProposal resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromEnhancedMeasurementSettingsName(enhancedMeasurementSettingsName) → {string}

Parse the property from EnhancedMeasurementSettings resource.

Parameters:

Name	Type	Description
`enhancedMeasurementSettingsName`	string	A fully-qualified path representing EnhancedMeasurementSettings resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromEventCreateRuleName(eventCreateRuleName) → {string}

Parse the property from EventCreateRule resource.

Parameters:

Name	Type	Description
`eventCreateRuleName`	string	A fully-qualified path representing EventCreateRule resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromEventEditRuleName(eventEditRuleName) → {string}

Parse the property from EventEditRule resource.

Parameters:

Name	Type	Description
`eventEditRuleName`	string	A fully-qualified path representing EventEditRule resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromExpandedDataSetName(expandedDataSetName) → {string}

Parse the property from ExpandedDataSet resource.

Parameters:

Name	Type	Description
`expandedDataSetName`	string	A fully-qualified path representing ExpandedDataSet resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromFirebaseLinkName(firebaseLinkName) → {string}

Parse the property from FirebaseLink resource.

Parameters:

Name	Type	Description
`firebaseLinkName`	string	A fully-qualified path representing FirebaseLink resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromGlobalSiteTagName(globalSiteTagName) → {string}

Parse the property from GlobalSiteTag resource.

Parameters:

Name	Type	Description
`globalSiteTagName`	string	A fully-qualified path representing GlobalSiteTag resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromGoogleAdsLinkName(googleAdsLinkName) → {string}

Parse the property from GoogleAdsLink resource.

Parameters:

Name	Type	Description
`googleAdsLinkName`	string	A fully-qualified path representing GoogleAdsLink resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromGoogleSignalsSettingsName(googleSignalsSettingsName) → {string}

Parse the property from GoogleSignalsSettings resource.

Parameters:

Name	Type	Description
`googleSignalsSettingsName`	string	A fully-qualified path representing GoogleSignalsSettings resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromKeyEventName(keyEventName) → {string}

Parse the property from KeyEvent resource.

Parameters:

Name	Type	Description
`keyEventName`	string	A fully-qualified path representing KeyEvent resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromMeasurementProtocolSecretName(measurementProtocolSecretName) → {string}

Parse the property from MeasurementProtocolSecret resource.

Parameters:

Name	Type	Description
`measurementProtocolSecretName`	string	A fully-qualified path representing MeasurementProtocolSecret resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromPropertyAccessBindingName(propertyAccessBindingName) → {string}

Parse the property from PropertyAccessBinding resource.

Parameters:

Name	Type	Description
`propertyAccessBindingName`	string	A fully-qualified path representing property_access_binding resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromPropertyName(propertyName) → {string}

Parse the property from Property resource.

Parameters:

Name	Type	Description
`propertyName`	string	A fully-qualified path representing Property resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromRollupPropertySourceLinkName(rollupPropertySourceLinkName) → {string}

Parse the property from RollupPropertySourceLink resource.

Parameters:

Name	Type	Description
`rollupPropertySourceLinkName`	string	A fully-qualified path representing RollupPropertySourceLink resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName) → {string}

Parse the property from SKAdNetworkConversionValueSchema resource.

Parameters:

Name	Type	Description
`sKAdNetworkConversionValueSchemaName`	string	A fully-qualified path representing SKAdNetworkConversionValueSchema resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromSearchAds360LinkName(searchAds360LinkName) → {string}

Parse the property from SearchAds360Link resource.

Parameters:

Name	Type	Description
`searchAds360LinkName`	string	A fully-qualified path representing SearchAds360Link resource.

Returns:

Type	Description
string	A string representing the property.

matchPropertyFromSubpropertyEventFilterName(subpropertyEventFilterName) → {string}

Parse the property from SubpropertyEventFilter resource.

Parameters:

Name	Type	Description
`subpropertyEventFilterName`	string	A fully-qualified path representing SubpropertyEventFilter resource.

Returns:

Type	Description
string	A string representing the property.

matchRollupPropertySourceLinkFromRollupPropertySourceLinkName(rollupPropertySourceLinkName) → {string}

Parse the rollup_property_source_link from RollupPropertySourceLink resource.

Parameters:

Name	Type	Description
`rollupPropertySourceLinkName`	string	A fully-qualified path representing RollupPropertySourceLink resource.

Returns:

Type	Description
string	A string representing the rollup_property_source_link.

matchSkadnetworkConversionValueSchemaFromSKAdNetworkConversionValueSchemaName(sKAdNetworkConversionValueSchemaName) → {string}

Parse the skadnetwork_conversion_value_schema from SKAdNetworkConversionValueSchema resource.

Parameters:

Name	Type	Description
`sKAdNetworkConversionValueSchemaName`	string	A fully-qualified path representing SKAdNetworkConversionValueSchema resource.

Returns:

Type	Description
string	A string representing the skadnetwork_conversion_value_schema.

matchSubPropertyEventFilterFromSubpropertyEventFilterName(subpropertyEventFilterName) → {string}

Parse the sub_property_event_filter from SubpropertyEventFilter resource.

Parameters:

Name	Type	Description
`subpropertyEventFilterName`	string	A fully-qualified path representing SubpropertyEventFilter resource.

Returns:

Type	Description
string	A string representing the sub_property_event_filter.

measurementProtocolSecretPath(property, data_stream, measurement_protocol_secret) → {string}

Return a fully-qualified measurementProtocolSecret resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string
`measurement_protocol_secret`	string

Returns:

Type	Description
string	Resource name string.

propertyAccessBindingPath(property, access_binding) → {string}

Return a fully-qualified propertyAccessBinding resource name string.

Parameters:

Name	Type	Description
`property`	string
`access_binding`	string

Returns:

Type	Description
string	Resource name string.

propertyPath(property) → {string}

Return a fully-qualified property resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

rollupPropertySourceLinkPath(property, rollup_property_source_link) → {string}

Return a fully-qualified rollupPropertySourceLink resource name string.

Parameters:

Name	Type	Description
`property`	string
`rollup_property_source_link`	string

Returns:

Type	Description
string	Resource name string.

sKAdNetworkConversionValueSchemaPath(property, data_stream, skadnetwork_conversion_value_schema) → {string}

Return a fully-qualified sKAdNetworkConversionValueSchema resource name string.

Parameters:

Name	Type	Description
`property`	string
`data_stream`	string
`skadnetwork_conversion_value_schema`	string

Returns:

Type	Description
string	Resource name string.

searchAds360LinkPath(property) → {string}

Return a fully-qualified searchAds360Link resource name string.

Parameters:

Name	Type	Description
`property`	string

Returns:

Type	Description
string	Resource name string.

searchChangeHistoryEventsAsync(request, optionsopt) → {Object}

Equivalent to searchChangeHistoryEvents, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`account`	string		Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`
`property`	string	<optional>	Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`
`resourceType`	Array.<number>	<optional>	Optional. If set, only return changes if they are for a resource that matches at least one of these types.
`action`	Array.<number>	<optional>	Optional. If set, only return changes that match one or more of these types of actions.
`actorEmail`	Array.<string>	<optional>	Optional. If set, only return changes if they are made by a user in this list.
`earliestChangeTime`	google.protobuf.Timestamp	<optional>	Optional. If set, only return changes made after this time (inclusive).
`latestChangeTime`	google.protobuf.Timestamp	<optional>	Optional. If set, only return changes made before this time (inclusive).
`pageSize`	number	<optional>	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).
`pageToken`	string	<optional>	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing 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. Format: accounts/{account}
   *  Example: `accounts/100`
   */
  // const account = 'abc123'
  /**
   *  Optional. Resource name for a child property. If set, only return changes
   *  made to this property or its child resources.
   *  Format: properties/{propertyId}
   *  Example: `properties/100`
   */
  // const property = 'abc123'
  /**
   *  Optional. If set, only return changes if they are for a resource that
   *  matches at least one of these types.
   */
  // const resourceType = [1,2,3,4]
  /**
   *  Optional. If set, only return changes that match one or more of these types
   *  of actions.
   */
  // const action = [1,2,3,4]
  /**
   *  Optional. If set, only return changes if they are made by a user in this
   *  list.
   */
  // const actorEmail = ['abc','def']
  /**
   *  Optional. If set, only return changes made after this time (inclusive).
   */
  // const earliestChangeTime = {}
  /**
   *  Optional. If set, only return changes made before this time (inclusive).
   */
  // const latestChangeTime = {}
  /**
   *  Optional. The maximum number of ChangeHistoryEvent items to return.
   *  The service may return fewer than this value, even if there are additional
   *  pages. If unspecified, at most 50 items will be returned.
   *  The maximum value is 200 (higher values will be coerced to the maximum).
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent
   *  page. When paginating, all other parameters provided to
   *  `SearchChangeHistoryEvents` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callSearchChangeHistoryEvents();

searchChangeHistoryEventsStream(request, optionsopt) → {Stream}

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`account`	string		Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`
`property`	string	<optional>	Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`
`resourceType`	Array.<number>	<optional>	Optional. If set, only return changes if they are for a resource that matches at least one of these types.
`action`	Array.<number>	<optional>	Optional. If set, only return changes that match one or more of these types of actions.
`actorEmail`	Array.<string>	<optional>	Optional. If set, only return changes if they are made by a user in this list.
`earliestChangeTime`	google.protobuf.Timestamp	<optional>	Optional. If set, only return changes made after this time (inclusive).
`latestChangeTime`	google.protobuf.Timestamp	<optional>	Optional. If set, only return changes made before this time (inclusive).
`pageSize`	number	<optional>	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).
`pageToken`	string	<optional>	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.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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.

subpropertyEventFilterPath(property, sub_property_event_filter) → {string}

Return a fully-qualified subpropertyEventFilter resource name string.

Parameters:

Name	Type	Description
`property`	string
`sub_property_event_filter`	string

Returns:

Type	Description
string	Resource name string.