@google-shopping/reviews 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/LICENSE +202 -0
- package/README.md +193 -0
- package/build/protos/google/shopping/merchant/reviews/v1beta/merchantreviews.proto +200 -0
- package/build/protos/google/shopping/merchant/reviews/v1beta/merchantreviews_common.proto +187 -0
- package/build/protos/google/shopping/merchant/reviews/v1beta/productreviews.proto +181 -0
- package/build/protos/google/shopping/merchant/reviews/v1beta/productreviews_common.proto +264 -0
- package/build/protos/google/shopping/type/types.proto +193 -0
- package/build/protos/protos.d.ts +10124 -0
- package/build/protos/protos.js +27852 -0
- package/build/protos/protos.json +3235 -0
- package/build/src/index.d.ts +14 -0
- package/build/src/index.js +34 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1beta/index.d.ts +2 -0
- package/build/src/v1beta/index.js +25 -0
- package/build/src/v1beta/index.js.map +1 -0
- package/build/src/v1beta/merchant_reviews_service_client.d.ts +368 -0
- package/build/src/v1beta/merchant_reviews_service_client.js +562 -0
- package/build/src/v1beta/merchant_reviews_service_client.js.map +1 -0
- package/build/src/v1beta/merchant_reviews_service_client_config.json +58 -0
- package/build/src/v1beta/product_reviews_service_client.d.ts +359 -0
- package/build/src/v1beta/product_reviews_service_client.js +558 -0
- package/build/src/v1beta/product_reviews_service_client.js.map +1 -0
- package/build/src/v1beta/product_reviews_service_client_config.json +58 -0
- package/package.json +70 -0
@@ -0,0 +1,14 @@
|
|
1
|
+
import * as v1beta from './v1beta';
|
2
|
+
declare const MerchantReviewsServiceClient: typeof v1beta.MerchantReviewsServiceClient;
|
3
|
+
type MerchantReviewsServiceClient = v1beta.MerchantReviewsServiceClient;
|
4
|
+
declare const ProductReviewsServiceClient: typeof v1beta.ProductReviewsServiceClient;
|
5
|
+
type ProductReviewsServiceClient = v1beta.ProductReviewsServiceClient;
|
6
|
+
export { v1beta, MerchantReviewsServiceClient, ProductReviewsServiceClient };
|
7
|
+
declare const _default: {
|
8
|
+
v1beta: typeof v1beta;
|
9
|
+
MerchantReviewsServiceClient: typeof v1beta.MerchantReviewsServiceClient;
|
10
|
+
ProductReviewsServiceClient: typeof v1beta.ProductReviewsServiceClient;
|
11
|
+
};
|
12
|
+
export default _default;
|
13
|
+
import * as protos from '../protos/protos';
|
14
|
+
export { protos };
|
@@ -0,0 +1,34 @@
|
|
1
|
+
"use strict";
|
2
|
+
// Copyright 2025 Google LLC
|
3
|
+
//
|
4
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
// you may not use this file except in compliance with the License.
|
6
|
+
// You may obtain a copy of the License at
|
7
|
+
//
|
8
|
+
// https://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
//
|
10
|
+
// Unless required by applicable law or agreed to in writing, software
|
11
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
// See the License for the specific language governing permissions and
|
14
|
+
// limitations under the License.
|
15
|
+
//
|
16
|
+
// ** This file is automatically generated by synthtool. **
|
17
|
+
// ** https://github.com/googleapis/synthtool **
|
18
|
+
// ** All changes to this file may be overwritten. **
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
20
|
+
exports.protos = exports.ProductReviewsServiceClient = exports.MerchantReviewsServiceClient = exports.v1beta = void 0;
|
21
|
+
const v1beta = require("./v1beta");
|
22
|
+
exports.v1beta = v1beta;
|
23
|
+
const MerchantReviewsServiceClient = v1beta.MerchantReviewsServiceClient;
|
24
|
+
exports.MerchantReviewsServiceClient = MerchantReviewsServiceClient;
|
25
|
+
const ProductReviewsServiceClient = v1beta.ProductReviewsServiceClient;
|
26
|
+
exports.ProductReviewsServiceClient = ProductReviewsServiceClient;
|
27
|
+
exports.default = {
|
28
|
+
v1beta,
|
29
|
+
MerchantReviewsServiceClient,
|
30
|
+
ProductReviewsServiceClient,
|
31
|
+
};
|
32
|
+
const protos = require("../protos/protos");
|
33
|
+
exports.protos = protos;
|
34
|
+
//# sourceMappingURL=index.js.map
|
@@ -0,0 +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;AAO3B,wBAAM;AALd,MAAM,4BAA4B,GAAG,MAAM,CAAC,4BAA4B,CAAC;AAKzD,oEAA4B;AAH5C,MAAM,2BAA2B,GAAG,MAAM,CAAC,2BAA2B,CAAC;AAGzB,kEAA2B;AACzE,kBAAe;IACb,MAAM;IACN,4BAA4B;IAC5B,2BAA2B;CAC5B,CAAC;AACF,2CAA2C;AACnC,wBAAM"}
|
@@ -0,0 +1,25 @@
|
|
1
|
+
"use strict";
|
2
|
+
// Copyright 2025 Google LLC
|
3
|
+
//
|
4
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
// you may not use this file except in compliance with the License.
|
6
|
+
// You may obtain a copy of the License at
|
7
|
+
//
|
8
|
+
// https://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
//
|
10
|
+
// Unless required by applicable law or agreed to in writing, software
|
11
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
// See the License for the specific language governing permissions and
|
14
|
+
// limitations under the License.
|
15
|
+
//
|
16
|
+
// ** This file is automatically generated by gapic-generator-typescript. **
|
17
|
+
// ** https://github.com/googleapis/gapic-generator-typescript **
|
18
|
+
// ** All changes to this file may be overwritten. **
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
20
|
+
exports.ProductReviewsServiceClient = exports.MerchantReviewsServiceClient = void 0;
|
21
|
+
var merchant_reviews_service_client_1 = require("./merchant_reviews_service_client");
|
22
|
+
Object.defineProperty(exports, "MerchantReviewsServiceClient", { enumerable: true, get: function () { return merchant_reviews_service_client_1.MerchantReviewsServiceClient; } });
|
23
|
+
var product_reviews_service_client_1 = require("./product_reviews_service_client");
|
24
|
+
Object.defineProperty(exports, "ProductReviewsServiceClient", { enumerable: true, get: function () { return product_reviews_service_client_1.ProductReviewsServiceClient; } });
|
25
|
+
//# sourceMappingURL=index.js.map
|
@@ -0,0 +1 @@
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v1beta/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,qFAA+E;AAAvE,+IAAA,4BAA4B,OAAA;AACpC,mFAA6E;AAArE,6IAAA,2BAA2B,OAAA"}
|
@@ -0,0 +1,368 @@
|
|
1
|
+
import type * as gax from 'google-gax';
|
2
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
|
3
|
+
import { Transform } from 'stream';
|
4
|
+
import * as protos from '../../protos/protos';
|
5
|
+
/**
|
6
|
+
* Service to manage merchant reviews.
|
7
|
+
* @class
|
8
|
+
* @memberof v1beta
|
9
|
+
*/
|
10
|
+
export declare class MerchantReviewsServiceClient {
|
11
|
+
private _terminated;
|
12
|
+
private _opts;
|
13
|
+
private _providedCustomServicePath;
|
14
|
+
private _gaxModule;
|
15
|
+
private _gaxGrpc;
|
16
|
+
private _protos;
|
17
|
+
private _defaults;
|
18
|
+
private _universeDomain;
|
19
|
+
private _servicePath;
|
20
|
+
auth: gax.GoogleAuth;
|
21
|
+
descriptors: Descriptors;
|
22
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
23
|
+
innerApiCalls: {
|
24
|
+
[name: string]: Function;
|
25
|
+
};
|
26
|
+
pathTemplates: {
|
27
|
+
[name: string]: gax.PathTemplate;
|
28
|
+
};
|
29
|
+
merchantReviewsServiceStub?: Promise<{
|
30
|
+
[name: string]: Function;
|
31
|
+
}>;
|
32
|
+
/**
|
33
|
+
* Construct an instance of MerchantReviewsServiceClient.
|
34
|
+
*
|
35
|
+
* @param {object} [options] - The configuration object.
|
36
|
+
* The options accepted by the constructor are described in detail
|
37
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
38
|
+
* The common options are:
|
39
|
+
* @param {object} [options.credentials] - Credentials object.
|
40
|
+
* @param {string} [options.credentials.client_email]
|
41
|
+
* @param {string} [options.credentials.private_key]
|
42
|
+
* @param {string} [options.email] - Account email address. Required when
|
43
|
+
* using a .pem or .p12 keyFilename.
|
44
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
45
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
46
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
47
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
48
|
+
* @param {number} [options.port] - The port on which to connect to
|
49
|
+
* the remote host.
|
50
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
51
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
52
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
53
|
+
* app is running in an environment which supports
|
54
|
+
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
55
|
+
* your project ID will be detected automatically.
|
56
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
57
|
+
* API remote host.
|
58
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
59
|
+
* Follows the structure of {@link gapicConfig}.
|
60
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
61
|
+
* For more information, please check the
|
62
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
63
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
64
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
65
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
66
|
+
* ```
|
67
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
68
|
+
* const client = new MerchantReviewsServiceClient({fallback: true}, gax);
|
69
|
+
* ```
|
70
|
+
*/
|
71
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
72
|
+
/**
|
73
|
+
* Initialize the client.
|
74
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
75
|
+
* This function will be called automatically when any class method is called for the
|
76
|
+
* first time, but if you need to initialize it before calling an actual method,
|
77
|
+
* feel free to call initialize() directly.
|
78
|
+
*
|
79
|
+
* You can await on this method if you want to make sure the client is initialized.
|
80
|
+
*
|
81
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
82
|
+
*/
|
83
|
+
initialize(): Promise<{
|
84
|
+
[name: string]: Function;
|
85
|
+
}>;
|
86
|
+
/**
|
87
|
+
* The DNS address for this API service.
|
88
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
89
|
+
* @returns {string} The DNS address for this service.
|
90
|
+
*/
|
91
|
+
static get servicePath(): string;
|
92
|
+
/**
|
93
|
+
* The DNS address for this API service - same as servicePath.
|
94
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
95
|
+
* @returns {string} The DNS address for this service.
|
96
|
+
*/
|
97
|
+
static get apiEndpoint(): string;
|
98
|
+
/**
|
99
|
+
* The DNS address for this API service.
|
100
|
+
* @returns {string} The DNS address for this service.
|
101
|
+
*/
|
102
|
+
get apiEndpoint(): string;
|
103
|
+
get universeDomain(): string;
|
104
|
+
/**
|
105
|
+
* The port for this API service.
|
106
|
+
* @returns {number} The default port for this service.
|
107
|
+
*/
|
108
|
+
static get port(): number;
|
109
|
+
/**
|
110
|
+
* The scopes needed to make gRPC calls for every method defined
|
111
|
+
* in this service.
|
112
|
+
* @returns {string[]} List of default scopes.
|
113
|
+
*/
|
114
|
+
static get scopes(): string[];
|
115
|
+
getProjectId(): Promise<string>;
|
116
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
117
|
+
/**
|
118
|
+
* Gets a merchant review.
|
119
|
+
*
|
120
|
+
* @param {Object} request
|
121
|
+
* The request object that will be sent.
|
122
|
+
* @param {string} request.name
|
123
|
+
* Required. The ID of the merchant review.
|
124
|
+
* Format: accounts/{account}/merchantReviews/{merchantReview}
|
125
|
+
* @param {object} [options]
|
126
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
127
|
+
* @returns {Promise} - The promise which resolves to an array.
|
128
|
+
* The first element of the array is an object representing {@link protos.google.shopping.merchant.reviews.v1beta.MerchantReview|MerchantReview}.
|
129
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
130
|
+
* for more details and examples.
|
131
|
+
* @example <caption>include:samples/generated/v1beta/merchant_reviews_service.get_merchant_review.js</caption>
|
132
|
+
* region_tag:merchantapi_v1beta_generated_MerchantReviewsService_GetMerchantReview_async
|
133
|
+
*/
|
134
|
+
getMerchantReview(request?: protos.google.shopping.merchant.reviews.v1beta.IGetMerchantReviewRequest, options?: CallOptions): Promise<[
|
135
|
+
protos.google.shopping.merchant.reviews.v1beta.IMerchantReview,
|
136
|
+
(protos.google.shopping.merchant.reviews.v1beta.IGetMerchantReviewRequest | undefined),
|
137
|
+
{} | undefined
|
138
|
+
]>;
|
139
|
+
getMerchantReview(request: protos.google.shopping.merchant.reviews.v1beta.IGetMerchantReviewRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.reviews.v1beta.IMerchantReview, protos.google.shopping.merchant.reviews.v1beta.IGetMerchantReviewRequest | null | undefined, {} | null | undefined>): void;
|
140
|
+
getMerchantReview(request: protos.google.shopping.merchant.reviews.v1beta.IGetMerchantReviewRequest, callback: Callback<protos.google.shopping.merchant.reviews.v1beta.IMerchantReview, protos.google.shopping.merchant.reviews.v1beta.IGetMerchantReviewRequest | null | undefined, {} | null | undefined>): void;
|
141
|
+
/**
|
142
|
+
* Inserts a review for your Merchant Center account. If the review
|
143
|
+
* already exists, then the review is replaced with the new instance.
|
144
|
+
*
|
145
|
+
* @param {Object} request
|
146
|
+
* The request object that will be sent.
|
147
|
+
* @param {string} request.parent
|
148
|
+
* Required. The account where the merchant review will be inserted.
|
149
|
+
* Format: accounts/{account}
|
150
|
+
* @param {google.shopping.merchant.reviews.v1beta.MerchantReview} request.merchantReview
|
151
|
+
* Required. The merchant review to insert.
|
152
|
+
* @param {string} request.dataSource
|
153
|
+
* Required. The data source of the
|
154
|
+
* [merchantreview](https://support.google.com/merchants/answer/7045996?sjid=5253581244217581976-EU)
|
155
|
+
* Format:
|
156
|
+
* `accounts/{account}/dataSources/{datasource}`.
|
157
|
+
* @param {object} [options]
|
158
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
159
|
+
* @returns {Promise} - The promise which resolves to an array.
|
160
|
+
* The first element of the array is an object representing {@link protos.google.shopping.merchant.reviews.v1beta.MerchantReview|MerchantReview}.
|
161
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
162
|
+
* for more details and examples.
|
163
|
+
* @example <caption>include:samples/generated/v1beta/merchant_reviews_service.insert_merchant_review.js</caption>
|
164
|
+
* region_tag:merchantapi_v1beta_generated_MerchantReviewsService_InsertMerchantReview_async
|
165
|
+
*/
|
166
|
+
insertMerchantReview(request?: protos.google.shopping.merchant.reviews.v1beta.IInsertMerchantReviewRequest, options?: CallOptions): Promise<[
|
167
|
+
protos.google.shopping.merchant.reviews.v1beta.IMerchantReview,
|
168
|
+
(protos.google.shopping.merchant.reviews.v1beta.IInsertMerchantReviewRequest | undefined),
|
169
|
+
{} | undefined
|
170
|
+
]>;
|
171
|
+
insertMerchantReview(request: protos.google.shopping.merchant.reviews.v1beta.IInsertMerchantReviewRequest, options: CallOptions, callback: Callback<protos.google.shopping.merchant.reviews.v1beta.IMerchantReview, protos.google.shopping.merchant.reviews.v1beta.IInsertMerchantReviewRequest | null | undefined, {} | null | undefined>): void;
|
172
|
+
insertMerchantReview(request: protos.google.shopping.merchant.reviews.v1beta.IInsertMerchantReviewRequest, callback: Callback<protos.google.shopping.merchant.reviews.v1beta.IMerchantReview, protos.google.shopping.merchant.reviews.v1beta.IInsertMerchantReviewRequest | null | undefined, {} | null | undefined>): void;
|
173
|
+
/**
|
174
|
+
* Deletes merchant review.
|
175
|
+
*
|
176
|
+
* @param {Object} request
|
177
|
+
* The request object that will be sent.
|
178
|
+
* @param {string} request.name
|
179
|
+
* Required. The ID of the merchant review.
|
180
|
+
* Format: accounts/{account}/merchantReviews/{merchantReview}
|
181
|
+
* @param {object} [options]
|
182
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
183
|
+
* @returns {Promise} - The promise which resolves to an array.
|
184
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
185
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
186
|
+
* for more details and examples.
|
187
|
+
* @example <caption>include:samples/generated/v1beta/merchant_reviews_service.delete_merchant_review.js</caption>
|
188
|
+
* region_tag:merchantapi_v1beta_generated_MerchantReviewsService_DeleteMerchantReview_async
|
189
|
+
*/
|
190
|
+
deleteMerchantReview(request?: protos.google.shopping.merchant.reviews.v1beta.IDeleteMerchantReviewRequest, options?: CallOptions): Promise<[
|
191
|
+
protos.google.protobuf.IEmpty,
|
192
|
+
(protos.google.shopping.merchant.reviews.v1beta.IDeleteMerchantReviewRequest | undefined),
|
193
|
+
{} | undefined
|
194
|
+
]>;
|
195
|
+
deleteMerchantReview(request: protos.google.shopping.merchant.reviews.v1beta.IDeleteMerchantReviewRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.reviews.v1beta.IDeleteMerchantReviewRequest | null | undefined, {} | null | undefined>): void;
|
196
|
+
deleteMerchantReview(request: protos.google.shopping.merchant.reviews.v1beta.IDeleteMerchantReviewRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.shopping.merchant.reviews.v1beta.IDeleteMerchantReviewRequest | null | undefined, {} | null | undefined>): void;
|
197
|
+
/**
|
198
|
+
* Lists merchant reviews.
|
199
|
+
*
|
200
|
+
* @param {Object} request
|
201
|
+
* The request object that will be sent.
|
202
|
+
* @param {string} request.parent
|
203
|
+
* Required. The account to list merchant reviews for.
|
204
|
+
* Format: accounts/{account}
|
205
|
+
* @param {number} [request.pageSize]
|
206
|
+
* Optional. The maximum number of merchant reviews to return. The service can
|
207
|
+
* return fewer than this value. The maximum value is 1000; values above 1000
|
208
|
+
* are coerced to 1000. If unspecified, the maximum number of reviews is
|
209
|
+
* returned.
|
210
|
+
* @param {string} [request.pageToken]
|
211
|
+
* Optional. A page token, received from a previous `ListMerchantReviews`
|
212
|
+
* call. Provide this to retrieve the subsequent page.
|
213
|
+
*
|
214
|
+
* When paginating, all other parameters provided to `ListMerchantReviews`
|
215
|
+
* must match the call that provided the page token.
|
216
|
+
* @param {object} [options]
|
217
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
218
|
+
* @returns {Promise} - The promise which resolves to an array.
|
219
|
+
* The first element of the array is Array of {@link protos.google.shopping.merchant.reviews.v1beta.MerchantReview|MerchantReview}.
|
220
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
221
|
+
* times as needed and will merge results from all the pages into this array.
|
222
|
+
* Note that it can affect your quota.
|
223
|
+
* We recommend using `listMerchantReviewsAsync()`
|
224
|
+
* method described below for async iteration which you can stop as needed.
|
225
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
226
|
+
* for more details and examples.
|
227
|
+
*/
|
228
|
+
listMerchantReviews(request?: protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, options?: CallOptions): Promise<[
|
229
|
+
protos.google.shopping.merchant.reviews.v1beta.IMerchantReview[],
|
230
|
+
protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest | null,
|
231
|
+
protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsResponse
|
232
|
+
]>;
|
233
|
+
listMerchantReviews(request: protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, options: CallOptions, callback: PaginationCallback<protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsResponse | null | undefined, protos.google.shopping.merchant.reviews.v1beta.IMerchantReview>): void;
|
234
|
+
listMerchantReviews(request: protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, callback: PaginationCallback<protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsResponse | null | undefined, protos.google.shopping.merchant.reviews.v1beta.IMerchantReview>): void;
|
235
|
+
/**
|
236
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
237
|
+
* @param {Object} request
|
238
|
+
* The request object that will be sent.
|
239
|
+
* @param {string} request.parent
|
240
|
+
* Required. The account to list merchant reviews for.
|
241
|
+
* Format: accounts/{account}
|
242
|
+
* @param {number} [request.pageSize]
|
243
|
+
* Optional. The maximum number of merchant reviews to return. The service can
|
244
|
+
* return fewer than this value. The maximum value is 1000; values above 1000
|
245
|
+
* are coerced to 1000. If unspecified, the maximum number of reviews is
|
246
|
+
* returned.
|
247
|
+
* @param {string} [request.pageToken]
|
248
|
+
* Optional. A page token, received from a previous `ListMerchantReviews`
|
249
|
+
* call. Provide this to retrieve the subsequent page.
|
250
|
+
*
|
251
|
+
* When paginating, all other parameters provided to `ListMerchantReviews`
|
252
|
+
* must match the call that provided the page token.
|
253
|
+
* @param {object} [options]
|
254
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
255
|
+
* @returns {Stream}
|
256
|
+
* An object stream which emits an object representing {@link protos.google.shopping.merchant.reviews.v1beta.MerchantReview|MerchantReview} on 'data' event.
|
257
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
258
|
+
* times as needed. Note that it can affect your quota.
|
259
|
+
* We recommend using `listMerchantReviewsAsync()`
|
260
|
+
* method described below for async iteration which you can stop as needed.
|
261
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
262
|
+
* for more details and examples.
|
263
|
+
*/
|
264
|
+
listMerchantReviewsStream(request?: protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, options?: CallOptions): Transform;
|
265
|
+
/**
|
266
|
+
* Equivalent to `listMerchantReviews`, but returns an iterable object.
|
267
|
+
*
|
268
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
269
|
+
* @param {Object} request
|
270
|
+
* The request object that will be sent.
|
271
|
+
* @param {string} request.parent
|
272
|
+
* Required. The account to list merchant reviews for.
|
273
|
+
* Format: accounts/{account}
|
274
|
+
* @param {number} [request.pageSize]
|
275
|
+
* Optional. The maximum number of merchant reviews to return. The service can
|
276
|
+
* return fewer than this value. The maximum value is 1000; values above 1000
|
277
|
+
* are coerced to 1000. If unspecified, the maximum number of reviews is
|
278
|
+
* returned.
|
279
|
+
* @param {string} [request.pageToken]
|
280
|
+
* Optional. A page token, received from a previous `ListMerchantReviews`
|
281
|
+
* call. Provide this to retrieve the subsequent page.
|
282
|
+
*
|
283
|
+
* When paginating, all other parameters provided to `ListMerchantReviews`
|
284
|
+
* must match the call that provided the page token.
|
285
|
+
* @param {object} [options]
|
286
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
287
|
+
* @returns {Object}
|
288
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
289
|
+
* When you iterate the returned iterable, each element will be an object representing
|
290
|
+
* {@link protos.google.shopping.merchant.reviews.v1beta.MerchantReview|MerchantReview}. The API will be called under the hood as needed, once per the page,
|
291
|
+
* so you can stop the iteration when you don't need more results.
|
292
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
293
|
+
* for more details and examples.
|
294
|
+
* @example <caption>include:samples/generated/v1beta/merchant_reviews_service.list_merchant_reviews.js</caption>
|
295
|
+
* region_tag:merchantapi_v1beta_generated_MerchantReviewsService_ListMerchantReviews_async
|
296
|
+
*/
|
297
|
+
listMerchantReviewsAsync(request?: protos.google.shopping.merchant.reviews.v1beta.IListMerchantReviewsRequest, options?: CallOptions): AsyncIterable<protos.google.shopping.merchant.reviews.v1beta.IMerchantReview>;
|
298
|
+
/**
|
299
|
+
* Return a fully-qualified account resource name string.
|
300
|
+
*
|
301
|
+
* @param {string} account
|
302
|
+
* @returns {string} Resource name string.
|
303
|
+
*/
|
304
|
+
accountPath(account: string): string;
|
305
|
+
/**
|
306
|
+
* Parse the account from Account resource.
|
307
|
+
*
|
308
|
+
* @param {string} accountName
|
309
|
+
* A fully-qualified path representing Account resource.
|
310
|
+
* @returns {string} A string representing the account.
|
311
|
+
*/
|
312
|
+
matchAccountFromAccountName(accountName: string): string | number;
|
313
|
+
/**
|
314
|
+
* Return a fully-qualified merchantReview resource name string.
|
315
|
+
*
|
316
|
+
* @param {string} account
|
317
|
+
* @param {string} name
|
318
|
+
* @returns {string} Resource name string.
|
319
|
+
*/
|
320
|
+
merchantReviewPath(account: string, name: string): string;
|
321
|
+
/**
|
322
|
+
* Parse the account from MerchantReview resource.
|
323
|
+
*
|
324
|
+
* @param {string} merchantReviewName
|
325
|
+
* A fully-qualified path representing MerchantReview resource.
|
326
|
+
* @returns {string} A string representing the account.
|
327
|
+
*/
|
328
|
+
matchAccountFromMerchantReviewName(merchantReviewName: string): string | number;
|
329
|
+
/**
|
330
|
+
* Parse the name from MerchantReview resource.
|
331
|
+
*
|
332
|
+
* @param {string} merchantReviewName
|
333
|
+
* A fully-qualified path representing MerchantReview resource.
|
334
|
+
* @returns {string} A string representing the name.
|
335
|
+
*/
|
336
|
+
matchNameFromMerchantReviewName(merchantReviewName: string): string | number;
|
337
|
+
/**
|
338
|
+
* Return a fully-qualified productReview resource name string.
|
339
|
+
*
|
340
|
+
* @param {string} account
|
341
|
+
* @param {string} productreview
|
342
|
+
* @returns {string} Resource name string.
|
343
|
+
*/
|
344
|
+
productReviewPath(account: string, productreview: string): string;
|
345
|
+
/**
|
346
|
+
* Parse the account from ProductReview resource.
|
347
|
+
*
|
348
|
+
* @param {string} productReviewName
|
349
|
+
* A fully-qualified path representing ProductReview resource.
|
350
|
+
* @returns {string} A string representing the account.
|
351
|
+
*/
|
352
|
+
matchAccountFromProductReviewName(productReviewName: string): string | number;
|
353
|
+
/**
|
354
|
+
* Parse the productreview from ProductReview resource.
|
355
|
+
*
|
356
|
+
* @param {string} productReviewName
|
357
|
+
* A fully-qualified path representing ProductReview resource.
|
358
|
+
* @returns {string} A string representing the productreview.
|
359
|
+
*/
|
360
|
+
matchProductreviewFromProductReviewName(productReviewName: string): string | number;
|
361
|
+
/**
|
362
|
+
* Terminate the gRPC channel and close the client.
|
363
|
+
*
|
364
|
+
* The client will no longer be usable and all future behavior is undefined.
|
365
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
366
|
+
*/
|
367
|
+
close(): Promise<void>;
|
368
|
+
}
|