@google-shopping/reports 0.8.1 → 0.10.0

package/build/src/index.d.ts

@@ -1,8 +1,10 @@
+import * as v1alpha from './v1alpha';
 import * as v1beta from './v1beta';
 declare const ReportServiceClient: typeof v1beta.ReportServiceClient;
 type ReportServiceClient = v1beta.ReportServiceClient;
-export { v1beta, ReportServiceClient };
+export { v1alpha, v1beta, ReportServiceClient };
 declare const _default: {
+    v1alpha: typeof v1alpha;
     v1beta: typeof v1beta;
     ReportServiceClient: typeof v1beta.ReportServiceClient;
 };

package/build/src/index.js

@@ -17,12 +17,14 @@
 // ** https://github.com/googleapis/synthtool **
 // ** All changes to this file may be overwritten. **
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.protos = exports.ReportServiceClient = exports.v1beta = void 0;
+exports.protos = exports.ReportServiceClient = exports.v1beta = exports.v1alpha = void 0;
+const v1alpha = require("./v1alpha");
+exports.v1alpha = v1alpha;
 const v1beta = require("./v1beta");
 exports.v1beta = v1beta;
 const ReportServiceClient = v1beta.ReportServiceClient;
 exports.ReportServiceClient = ReportServiceClient;
-exports.default = { v1beta, ReportServiceClient };
+exports.default = { v1alpha, v1beta, ReportServiceClient };
 const protos = require("../protos/protos");
 exports.protos = protos;
 //# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,mCAAmC;AAK3B,wBAAM;AAHd,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AAGvC,kDAAmB;AACnC,kBAAe,EAAC,MAAM,EAAE,mBAAmB,EAAC,CAAC;AAC7C,2CAA2C;AACnC,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,2DAA2D;AAC3D,gDAAgD;AAChD,qDAAqD;;;AAErD,qCAAqC;AAM7B,0BAAO;AALf,mCAAmC;AAKlB,wBAAM;AAHvB,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AAG9B,kDAAmB;AAC5C,kBAAe,EAAC,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAC,CAAC;AACtD,2CAA2C;AACnC,wBAAM"}

package/build/src/v1alpha/gapic_metadata.json

@@ -0,0 +1,37 @@
+{
+    "schema": "1.0",
+    "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
+    "language": "typescript",
+    "protoPackage": "google.shopping.merchant.reports.v1alpha",
+    "libraryPackage": "@google-shopping/reports",
+    "services": {
+        "ReportService": {
+            "clients": {
+                "grpc": {
+                    "libraryClient": "ReportServiceClient",
+                    "rpcs": {
+                        "Search": {
+                            "methods": [
+                                "search",
+                                "searchStream",
+                                "searchAsync"
+                            ]
+                        }
+                    }
+                },
+                "grpc-fallback": {
+                    "libraryClient": "ReportServiceClient",
+                    "rpcs": {
+                        "Search": {
+                            "methods": [
+                                "search",
+                                "searchStream",
+                                "searchAsync"
+                            ]
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/build/src/v1alpha/index.d.ts

@@ -0,0 +1 @@
+export { ReportServiceClient } from './report_service_client';

package/build/src/v1alpha/index.js

@@ -0,0 +1,23 @@
+"use strict";
+// Copyright 2025 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. **
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportServiceClient = void 0;
+var report_service_client_1 = require("./report_service_client");
+Object.defineProperty(exports, "ReportServiceClient", { enumerable: true, get: function () { return report_service_client_1.ReportServiceClient; } });
+//# sourceMappingURL=index.js.map

package/build/src/v1alpha/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1alpha/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,4EAA4E;AAC5E,iEAAiE;AACjE,qDAAqD;;;AAErD,iEAA4D;AAApD,4HAAA,mBAAmB,OAAA"}

package/build/src/v1alpha/report_service_client.d.ts

@@ -0,0 +1,235 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
+import { Transform } from 'stream';
+import * as protos from '../../protos/protos';
+/**
+ *  Service for retrieving reports and insights about your products, their
+ *  performance, and their competitive environment on Google.
+ * @class
+ * @memberof v1alpha
+ */
+export declare class ReportServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    private _log;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    reportServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of ReportServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - 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.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - 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
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: 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 ReportServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * 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 {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): string[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+    * Retrieves a report defined by a search query. The response might contain
+    * fewer rows than specified by `page_size`. Rely on `next_page_token` to
+    * determine if there are more rows to be requested.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. Id of the account making the call. Must be a standalone account
+    *   or an MCA subaccount. Format: accounts/{account}
+    * @param {string} request.query
+    *   Required. Query that defines a report to be retrieved.
+    *
+    *   For details on how to construct your query, see the Query Language
+    *   guide. For the full list of available tables and fields, see the Available
+    *   fields.
+    * @param {number} [request.pageSize]
+    *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
+    *   1000. Values above 5000 are coerced to 5000.
+    * @param {string} [request.pageToken]
+    *   Optional. Token of the page to retrieve. If not specified, the first page
+    *   of results is returned. In order to request the next page of results, the
+    *   value obtained from `next_page_token` in the previous response should be
+    *   used.
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.shopping.merchant.reports.v1alpha.ReportRow|ReportRow}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `searchAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
+    search(request?: protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, options?: CallOptions): Promise<[
+        protos.google.shopping.merchant.reports.v1alpha.IReportRow[],
+        protos.google.shopping.merchant.reports.v1alpha.ISearchRequest | null,
+        protos.google.shopping.merchant.reports.v1alpha.ISearchResponse
+    ]>;
+    search(request: protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, protos.google.shopping.merchant.reports.v1alpha.ISearchResponse | null | undefined, protos.google.shopping.merchant.reports.v1alpha.IReportRow>): void;
+    search(request: protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, callback: PaginationCallback<protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, protos.google.shopping.merchant.reports.v1alpha.ISearchResponse | null | undefined, protos.google.shopping.merchant.reports.v1alpha.IReportRow>): void;
+    /**
+     * Equivalent to `search`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Id of the account making the call. Must be a standalone account
+     *   or an MCA subaccount. Format: accounts/{account}
+     * @param {string} request.query
+     *   Required. Query that defines a report to be retrieved.
+     *
+     *   For details on how to construct your query, see the Query Language
+     *   guide. For the full list of available tables and fields, see the Available
+     *   fields.
+     * @param {number} [request.pageSize]
+     *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
+     *   1000. Values above 5000 are coerced to 5000.
+     * @param {string} [request.pageToken]
+     *   Optional. Token of the page to retrieve. If not specified, the first page
+     *   of results is returned. In order to request the next page of results, the
+     *   value obtained from `next_page_token` in the previous response should be
+     *   used.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.shopping.merchant.reports.v1alpha.ReportRow|ReportRow} 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 `searchAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    searchStream(request?: protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `search`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Id of the account making the call. Must be a standalone account
+     *   or an MCA subaccount. Format: accounts/{account}
+     * @param {string} request.query
+     *   Required. Query that defines a report to be retrieved.
+     *
+     *   For details on how to construct your query, see the Query Language
+     *   guide. For the full list of available tables and fields, see the Available
+     *   fields.
+     * @param {number} [request.pageSize]
+     *   Optional. Number of `ReportRows` to retrieve in a single page. Defaults to
+     *   1000. Values above 5000 are coerced to 5000.
+     * @param {string} [request.pageToken]
+     *   Optional. Token of the page to retrieve. If not specified, the first page
+     *   of results is returned. In order to request the next page of results, the
+     *   value obtained from `next_page_token` in the previous response should be
+     *   used.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.shopping.merchant.reports.v1alpha.ReportRow|ReportRow}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/report_service.search.js</caption>
+     * region_tag:merchantapi_v1alpha_generated_ReportService_Search_async
+     */
+    searchAsync(request?: protos.google.shopping.merchant.reports.v1alpha.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.reports.v1alpha.IReportRow>;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}