1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="merchantapi_reviews_v1beta.html">Merchant API</a> . <a href="merchantapi_reviews_v1beta.accounts.html">accounts</a> . <a href="merchantapi_reviews_v1beta.accounts.productReviews.html">productReviews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a product review.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a product review.</p>
<p class="toc_element">
<code><a href="#insert">insert(parent, body=None, dataSource=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a product review.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists product reviews.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a product review.
Args:
name: string, Required. The ID of the Product review. Format: accounts/{account}/productReviews/{productReview} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a product review.
Args:
name: string, Required. The ID of the merchant review. Format: accounts/{account}/productReviews/{productReview} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
"customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
{ # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
"groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute.
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
},
],
"dataSource": "A String", # Output only. The primary data source of the product review.
"name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
"productReviewAttributes": { # Attributes. # Optional. A list of product review attributes.
"aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
"asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
"A String",
],
"brands": [ # Optional. Contains brand names associated with a product.
"A String",
],
"collectionMethod": "A String", # Optional. The method used to collect the review.
"cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
"A String",
],
"content": "A String", # Optional. The content of the review. If empty, the content might still get populated from pros and cons.
"gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
"A String",
],
"isIncentivizedReview": True or False, # Optional. Indicates whether the review is incentivized.
"isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
"isVerifiedPurchase": True or False, # Optional. Indicates whether the reviewer's purchase is verified.
"maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
"minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
"mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
"A String",
],
"productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
"A String",
],
"productNames": [ # Optional. Descriptive name of a product.
"A String",
],
"pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
"A String",
],
"publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
"publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
"rating": 3.14, # Optional. The reviewer's overall rating of the product.
"reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
"reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
"reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
"link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
"type": "A String", # Optional. Type of the review URI.
},
"reviewTime": "A String", # Required. The timestamp indicating when the review was written.
"reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
"reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
"A String",
],
"reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
"reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
"skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
"A String",
],
"subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
"title": "A String", # Optional. The title of the review.
"transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
},
"productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
"productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
"createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # Output only. The intended destinations for the product review.
{ # The destination status of the product review status.
"reportingContext": "A String", # Output only. The name of the reporting context.
},
],
"itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
{ # The ItemLevelIssue of the product review status.
"attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
"code": "A String", # Output only. The error code of the issue.
"description": "A String", # Output only. A short issue description in English.
"detail": "A String", # Output only. A detailed issue description in English.
"documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
"reportingContext": "A String", # Output only. The reporting context the issue applies to.
"resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
"severity": "A String", # Output only. How this issue affects serving of the product review.
},
],
"lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(parent, body=None, dataSource=None, x__xgafv=None)</code>
<pre>Inserts a product review.
Args:
parent: string, Required. The account where the product review will be inserted. Format: accounts/{account} (required)
body: object, The request body.
The object takes the form of:
{ # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
"customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
{ # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
"groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute.
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
},
],
"dataSource": "A String", # Output only. The primary data source of the product review.
"name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
"productReviewAttributes": { # Attributes. # Optional. A list of product review attributes.
"aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
"asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
"A String",
],
"brands": [ # Optional. Contains brand names associated with a product.
"A String",
],
"collectionMethod": "A String", # Optional. The method used to collect the review.
"cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
"A String",
],
"content": "A String", # Optional. The content of the review. If empty, the content might still get populated from pros and cons.
"gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
"A String",
],
"isIncentivizedReview": True or False, # Optional. Indicates whether the review is incentivized.
"isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
"isVerifiedPurchase": True or False, # Optional. Indicates whether the reviewer's purchase is verified.
"maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
"minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
"mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
"A String",
],
"productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
"A String",
],
"productNames": [ # Optional. Descriptive name of a product.
"A String",
],
"pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
"A String",
],
"publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
"publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
"rating": 3.14, # Optional. The reviewer's overall rating of the product.
"reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
"reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
"reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
"link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
"type": "A String", # Optional. Type of the review URI.
},
"reviewTime": "A String", # Required. The timestamp indicating when the review was written.
"reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
"reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
"A String",
],
"reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
"reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
"skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
"A String",
],
"subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
"title": "A String", # Optional. The title of the review.
"transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
},
"productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
"productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
"createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # Output only. The intended destinations for the product review.
{ # The destination status of the product review status.
"reportingContext": "A String", # Output only. The name of the reporting context.
},
],
"itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
{ # The ItemLevelIssue of the product review status.
"attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
"code": "A String", # Output only. The error code of the issue.
"description": "A String", # Output only. A short issue description in English.
"detail": "A String", # Output only. A detailed issue description in English.
"documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
"reportingContext": "A String", # Output only. The reporting context the issue applies to.
"resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
"severity": "A String", # Output only. How this issue affects serving of the product review.
},
],
"lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
},
}
dataSource: string, Required. Format: `accounts/{account}/dataSources/{datasource}`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
"customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
{ # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
"groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute.
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
},
],
"dataSource": "A String", # Output only. The primary data source of the product review.
"name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
"productReviewAttributes": { # Attributes. # Optional. A list of product review attributes.
"aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
"asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
"A String",
],
"brands": [ # Optional. Contains brand names associated with a product.
"A String",
],
"collectionMethod": "A String", # Optional. The method used to collect the review.
"cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
"A String",
],
"content": "A String", # Optional. The content of the review. If empty, the content might still get populated from pros and cons.
"gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
"A String",
],
"isIncentivizedReview": True or False, # Optional. Indicates whether the review is incentivized.
"isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
"isVerifiedPurchase": True or False, # Optional. Indicates whether the reviewer's purchase is verified.
"maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
"minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
"mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
"A String",
],
"productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
"A String",
],
"productNames": [ # Optional. Descriptive name of a product.
"A String",
],
"pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
"A String",
],
"publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
"publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
"rating": 3.14, # Optional. The reviewer's overall rating of the product.
"reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
"reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
"reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
"link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
"type": "A String", # Optional. Type of the review URI.
},
"reviewTime": "A String", # Required. The timestamp indicating when the review was written.
"reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
"reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
"A String",
],
"reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
"reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
"skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
"A String",
],
"subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
"title": "A String", # Optional. The title of the review.
"transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
},
"productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
"productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
"createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # Output only. The intended destinations for the product review.
{ # The destination status of the product review status.
"reportingContext": "A String", # Output only. The name of the reporting context.
},
],
"itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
{ # The ItemLevelIssue of the product review status.
"attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
"code": "A String", # Output only. The error code of the issue.
"description": "A String", # Output only. A short issue description in English.
"detail": "A String", # Output only. A detailed issue description in English.
"documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
"reportingContext": "A String", # Output only. The reporting context the issue applies to.
"resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
"severity": "A String", # Output only. How this issue affects serving of the product review.
},
],
"lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists product reviews.
Args:
parent: string, Required. The account to list product reviews for. Format: accounts/{account} (required)
pageSize: integer, Optional. The maximum number of products to return. The service may return fewer than this value.
pageToken: string, Optional. A page token, received from a previous `ListProductReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProductReviews` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # response message for the ListProductReviews method.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"productReviews": [ # The product review.
{ # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)
"customAttributes": [ # Optional. A list of custom (merchant-provided) attributes.
{ # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
"groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute.
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
},
],
"dataSource": "A String", # Output only. The primary data source of the product review.
"name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"`
"productReviewAttributes": { # Attributes. # Optional. A list of product review attributes.
"aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.
"asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product.
"A String",
],
"brands": [ # Optional. Contains brand names associated with a product.
"A String",
],
"collectionMethod": "A String", # Optional. The method used to collect the review.
"cons": [ # Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like "con:" unless it was written by the reviewer.
"A String",
],
"content": "A String", # Optional. The content of the review. If empty, the content might still get populated from pros and cons.
"gtins": [ # Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.
"A String",
],
"isIncentivizedReview": True or False, # Optional. Indicates whether the review is incentivized.
"isSpam": True or False, # Optional. Indicates whether the review is marked as spam in the publisher's system.
"isVerifiedPurchase": True or False, # Optional. Indicates whether the reviewer's purchase is verified.
"maxRating": "A String", # Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.
"minRating": "A String", # Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.
"mpns": [ # Optional. Contains MPNs (manufacturer part numbers) associated with a product.
"A String",
],
"productLinks": [ # Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.
"A String",
],
"productNames": [ # Optional. Descriptive name of a product.
"A String",
],
"pros": [ # Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like "pro:" unless it was written by the reviewer.
"A String",
],
"publisherFavicon": "A String", # Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.
"publisherName": "A String", # Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews.
"rating": 3.14, # Optional. The reviewer's overall rating of the product.
"reviewCountry": "A String", # Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code.
"reviewLanguage": "A String", # Optional. The language of the review defined by BCP-47 language code.
"reviewLink": { # The URI of the review landing page. # Optional. The URI of the review landing page.
"link": "A String", # Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`.
"type": "A String", # Optional. Type of the review URI.
},
"reviewTime": "A String", # Required. The timestamp indicating when the review was written.
"reviewerId": "A String", # Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.
"reviewerImageLinks": [ # Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.
"A String",
],
"reviewerIsAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous.
"reviewerUsername": "A String", # Optional. The name of the reviewer of the product review.
"skus": [ # Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.
"A String",
],
"subclientName": "A String", # Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.
"title": "A String", # Optional. The title of the review.
"transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.
},
"productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system.
"productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously.
"createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # Output only. The intended destinations for the product review.
{ # The destination status of the product review status.
"reportingContext": "A String", # Output only. The name of the reporting context.
},
],
"itemLevelIssues": [ # Output only. A list of all issues associated with the product review.
{ # The ItemLevelIssue of the product review status.
"attribute": "A String", # Output only. The attribute's name, if the issue is caused by a single attribute.
"code": "A String", # Output only. The error code of the issue.
"description": "A String", # Output only. A short issue description in English.
"detail": "A String", # Output only. A detailed issue description in English.
"documentation": "A String", # Output only. The URL of a web page to help with resolving this issue.
"reportingContext": "A String", # Output only. The reporting context the issue applies to.
"resolution": "A String", # Output only. Whether the issue can be resolved by the merchant.
"severity": "A String", # Output only. How this issue affects serving of the product review.
},
],
"lastUpdateTime": "A String", # Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
