analytics_service.export_analytics_metrics.js

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **



'use strict';

function main(catalog, outputConfig) {
  // [START retail_v2alpha_generated_AnalyticsService_ExportAnalyticsMetrics_async]
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It 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. Full resource name of the parent catalog.
   *  Expected format: `projects/* /locations/* /catalogs/*`
   */
  // const catalog = 'abc123'
  /**
   *  Required. The output location of the data.
   */
  // const outputConfig = {}
  /**
   *  A filtering expression to specify restrictions on returned metrics.
   *  The expression is a sequence of terms. Each term applies a restriction to
   *  the returned metrics. Use this expression to restrict results to a
   *  specific time range.
   *    Currently we expect only one types of fields:
   *     * `timestamp`: This can be specified twice, once with a
   *       less than operator and once with a greater than operator. The
   *       `timestamp` restriction should result in one, contiguous, valid,
   *       `timestamp` range.
   *    Some examples of valid filters expressions:
   *    * Example 1: `timestamp > "2012-04-23T18:25:43.511Z"
   *              timestamp < "2012-04-23T18:30:43.511Z"`
   *    * Example 2: `timestamp > "2012-04-23T18:25:43.511Z"`
   */
  // const filter = 'abc123'

  // Imports the Retail library
  const {AnalyticsServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new AnalyticsServiceClient();

  async function callExportAnalyticsMetrics() {
    // Construct request
    const request = {
      catalog,
      outputConfig,
    };

    // Run request
    const [operation] = await retailClient.exportAnalyticsMetrics(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportAnalyticsMetrics();
  // [END retail_v2alpha_generated_AnalyticsService_ExportAnalyticsMetrics_async]
}

process.on('unhandledRejection', err => {
  console.error(err.message);
  process.exitCode = 1;
});
main(...process.argv.slice(2));