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
|
<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="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.repricingrules.html">repricingrules</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="content_v2_1.repricingrules.repricingreports.html">repricingreports()</a></code>
</p>
<p class="firstline">Returns the repricingreports Resource.</p>
<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="#create">create(merchantId, body=None, ruleId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a repricing rule for your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, ruleId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a repricing rule in your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, ruleId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a repricing rule from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, countryCode=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the repricing rules in your Merchant Center account.</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>
<p class="toc_element">
<code><a href="#patch">patch(merchantId, ruleId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.</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="create">create(merchantId, body=None, ruleId=None, x__xgafv=None)</code>
<pre>Creates a repricing rule for your Merchant Center account.
Args:
merchantId: string, Required. The id of the merchant who owns the repricing rule. (required)
body: object, The request body.
The object takes the form of:
{ # *Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
"cogsBasedRule": { # A repricing rule that changes the sale price based on cost of goods sale. # The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
"percentageDelta": 42, # The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.
"priceDelta": "A String", # The price delta against the COGS. For example, 2 means $2 more of the COGS.
},
"countryCode": "A String", # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
"effectiveTimePeriod": { # Required. Time period when the rule should take effect.
"fixedTimePeriods": [ # A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.
{ # Definition of a fixed time period.
"endTime": "A String", # The end time (exclusive) of the period. It can only be hour granularity.
"startTime": "A String", # The start time (inclusive) of the period. It can only be hour granularity.
},
],
},
"eligibleOfferMatcher": { # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands. # Required. Match criteria for the eligible offers.
"brandMatcher": { # Matcher by string attributes. # Filter by the brand.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"itemGroupIdMatcher": { # Matcher by string attributes. # Filter by the item group id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"matcherOption": "A String", # Determines whether to use the custom matchers or the product feed attribute "repricing_rule_id" to specify offer-rule mapping.
"offerIdMatcher": { # Matcher by string attributes. # Filter by the offer id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"skipWhenOnPromotion": True or False, # When true, the rule won't be applied to offers with active promotions.
},
"languageCode": "A String", # Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
"merchantId": "A String", # Output only. Immutable. Merchant that owns the repricing rule.
"paused": True or False, # Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
"restriction": { # Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price). # Required. Restriction of the rule appliance.
"floor": { # Definition of a boundary. # The inclusive floor lower bound. The repricing rule only applies when new price >= floor.
"percentageDelta": 42, # The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.
"priceDelta": "A String", # The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.
},
"useAutoPricingMinPrice": True or False, # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.
},
"ruleId": "A String", # Output only. Immutable. The ID to uniquely identify each repricing rule.
"statsBasedRule": { # Definition of stats based rule. # The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
"percentageDelta": 42, # The percent change against the price target. Valid from 0 to 100 inclusively.
"priceDelta": "A String", # The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.
},
"title": "A String", # The title for the rule.
"type": "A String", # Required. Immutable. The type of the rule.
}
ruleId: string, Required. The id of the rule to create.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # *Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
"cogsBasedRule": { # A repricing rule that changes the sale price based on cost of goods sale. # The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
"percentageDelta": 42, # The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.
"priceDelta": "A String", # The price delta against the COGS. For example, 2 means $2 more of the COGS.
},
"countryCode": "A String", # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
"effectiveTimePeriod": { # Required. Time period when the rule should take effect.
"fixedTimePeriods": [ # A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.
{ # Definition of a fixed time period.
"endTime": "A String", # The end time (exclusive) of the period. It can only be hour granularity.
"startTime": "A String", # The start time (inclusive) of the period. It can only be hour granularity.
},
],
},
"eligibleOfferMatcher": { # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands. # Required. Match criteria for the eligible offers.
"brandMatcher": { # Matcher by string attributes. # Filter by the brand.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"itemGroupIdMatcher": { # Matcher by string attributes. # Filter by the item group id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"matcherOption": "A String", # Determines whether to use the custom matchers or the product feed attribute "repricing_rule_id" to specify offer-rule mapping.
"offerIdMatcher": { # Matcher by string attributes. # Filter by the offer id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"skipWhenOnPromotion": True or False, # When true, the rule won't be applied to offers with active promotions.
},
"languageCode": "A String", # Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
"merchantId": "A String", # Output only. Immutable. Merchant that owns the repricing rule.
"paused": True or False, # Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
"restriction": { # Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price). # Required. Restriction of the rule appliance.
"floor": { # Definition of a boundary. # The inclusive floor lower bound. The repricing rule only applies when new price >= floor.
"percentageDelta": 42, # The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.
"priceDelta": "A String", # The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.
},
"useAutoPricingMinPrice": True or False, # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.
},
"ruleId": "A String", # Output only. Immutable. The ID to uniquely identify each repricing rule.
"statsBasedRule": { # Definition of stats based rule. # The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
"percentageDelta": 42, # The percent change against the price target. Valid from 0 to 100 inclusively.
"priceDelta": "A String", # The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.
},
"title": "A String", # The title for the rule.
"type": "A String", # Required. Immutable. The type of the rule.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, ruleId, x__xgafv=None)</code>
<pre>Deletes a repricing rule in your Merchant Center account.
Args:
merchantId: string, Required. The id of the merchant who owns the repricing rule. (required)
ruleId: string, Required. The id of the rule to Delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(merchantId, ruleId, x__xgafv=None)</code>
<pre>Retrieves a repricing rule from your Merchant Center account.
Args:
merchantId: string, Required. The id of the merchant who owns the repricing rule. (required)
ruleId: string, Required. The id of the rule to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # *Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
"cogsBasedRule": { # A repricing rule that changes the sale price based on cost of goods sale. # The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
"percentageDelta": 42, # The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.
"priceDelta": "A String", # The price delta against the COGS. For example, 2 means $2 more of the COGS.
},
"countryCode": "A String", # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
"effectiveTimePeriod": { # Required. Time period when the rule should take effect.
"fixedTimePeriods": [ # A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.
{ # Definition of a fixed time period.
"endTime": "A String", # The end time (exclusive) of the period. It can only be hour granularity.
"startTime": "A String", # The start time (inclusive) of the period. It can only be hour granularity.
},
],
},
"eligibleOfferMatcher": { # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands. # Required. Match criteria for the eligible offers.
"brandMatcher": { # Matcher by string attributes. # Filter by the brand.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"itemGroupIdMatcher": { # Matcher by string attributes. # Filter by the item group id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"matcherOption": "A String", # Determines whether to use the custom matchers or the product feed attribute "repricing_rule_id" to specify offer-rule mapping.
"offerIdMatcher": { # Matcher by string attributes. # Filter by the offer id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"skipWhenOnPromotion": True or False, # When true, the rule won't be applied to offers with active promotions.
},
"languageCode": "A String", # Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
"merchantId": "A String", # Output only. Immutable. Merchant that owns the repricing rule.
"paused": True or False, # Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
"restriction": { # Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price). # Required. Restriction of the rule appliance.
"floor": { # Definition of a boundary. # The inclusive floor lower bound. The repricing rule only applies when new price >= floor.
"percentageDelta": 42, # The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.
"priceDelta": "A String", # The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.
},
"useAutoPricingMinPrice": True or False, # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.
},
"ruleId": "A String", # Output only. Immutable. The ID to uniquely identify each repricing rule.
"statsBasedRule": { # Definition of stats based rule. # The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
"percentageDelta": 42, # The percent change against the price target. Valid from 0 to 100 inclusively.
"priceDelta": "A String", # The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.
},
"title": "A String", # The title for the rule.
"type": "A String", # Required. Immutable. The type of the rule.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, countryCode=None, languageCode=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the repricing rules in your Merchant Center account.
Args:
merchantId: string, Required. The id of the merchant who owns the repricing rule. (required)
countryCode: string, [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US"), used as a filter on repricing rules.
languageCode: string, The two-letter ISO 639-1 language code associated with the repricing rule, used as a filter.
pageSize: integer, The maximum number of repricing rules to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListRepricingRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepricingRules` 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 `ListRepricingRules` 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.
"repricingRules": [ # The rules from the specified merchant.
{ # *Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
"cogsBasedRule": { # A repricing rule that changes the sale price based on cost of goods sale. # The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
"percentageDelta": 42, # The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.
"priceDelta": "A String", # The price delta against the COGS. For example, 2 means $2 more of the COGS.
},
"countryCode": "A String", # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
"effectiveTimePeriod": { # Required. Time period when the rule should take effect.
"fixedTimePeriods": [ # A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.
{ # Definition of a fixed time period.
"endTime": "A String", # The end time (exclusive) of the period. It can only be hour granularity.
"startTime": "A String", # The start time (inclusive) of the period. It can only be hour granularity.
},
],
},
"eligibleOfferMatcher": { # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands. # Required. Match criteria for the eligible offers.
"brandMatcher": { # Matcher by string attributes. # Filter by the brand.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"itemGroupIdMatcher": { # Matcher by string attributes. # Filter by the item group id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"matcherOption": "A String", # Determines whether to use the custom matchers or the product feed attribute "repricing_rule_id" to specify offer-rule mapping.
"offerIdMatcher": { # Matcher by string attributes. # Filter by the offer id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"skipWhenOnPromotion": True or False, # When true, the rule won't be applied to offers with active promotions.
},
"languageCode": "A String", # Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
"merchantId": "A String", # Output only. Immutable. Merchant that owns the repricing rule.
"paused": True or False, # Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
"restriction": { # Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price). # Required. Restriction of the rule appliance.
"floor": { # Definition of a boundary. # The inclusive floor lower bound. The repricing rule only applies when new price >= floor.
"percentageDelta": 42, # The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.
"priceDelta": "A String", # The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.
},
"useAutoPricingMinPrice": True or False, # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.
},
"ruleId": "A String", # Output only. Immutable. The ID to uniquely identify each repricing rule.
"statsBasedRule": { # Definition of stats based rule. # The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
"percentageDelta": 42, # The percent change against the price target. Valid from 0 to 100 inclusively.
"priceDelta": "A String", # The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.
},
"title": "A String", # The title for the rule.
"type": "A String", # Required. Immutable. The type of the rule.
},
],
}</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>
<div class="method">
<code class="details" id="patch">patch(merchantId, ruleId, body=None, x__xgafv=None)</code>
<pre>Updates a repricing rule in your Merchant Center account. All mutable fields will be overwritten in each update request. In each update, you must provide all required mutable fields, or an error will be thrown. If you do not provide an optional field in the update request, if that field currently exists, it will be deleted from the rule.
Args:
merchantId: string, Required. The id of the merchant who owns the repricing rule. (required)
ruleId: string, Required. The id of the rule to update. (required)
body: object, The request body.
The object takes the form of:
{ # *Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
"cogsBasedRule": { # A repricing rule that changes the sale price based on cost of goods sale. # The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
"percentageDelta": 42, # The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.
"priceDelta": "A String", # The price delta against the COGS. For example, 2 means $2 more of the COGS.
},
"countryCode": "A String", # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
"effectiveTimePeriod": { # Required. Time period when the rule should take effect.
"fixedTimePeriods": [ # A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.
{ # Definition of a fixed time period.
"endTime": "A String", # The end time (exclusive) of the period. It can only be hour granularity.
"startTime": "A String", # The start time (inclusive) of the period. It can only be hour granularity.
},
],
},
"eligibleOfferMatcher": { # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands. # Required. Match criteria for the eligible offers.
"brandMatcher": { # Matcher by string attributes. # Filter by the brand.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"itemGroupIdMatcher": { # Matcher by string attributes. # Filter by the item group id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"matcherOption": "A String", # Determines whether to use the custom matchers or the product feed attribute "repricing_rule_id" to specify offer-rule mapping.
"offerIdMatcher": { # Matcher by string attributes. # Filter by the offer id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"skipWhenOnPromotion": True or False, # When true, the rule won't be applied to offers with active promotions.
},
"languageCode": "A String", # Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
"merchantId": "A String", # Output only. Immutable. Merchant that owns the repricing rule.
"paused": True or False, # Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
"restriction": { # Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price). # Required. Restriction of the rule appliance.
"floor": { # Definition of a boundary. # The inclusive floor lower bound. The repricing rule only applies when new price >= floor.
"percentageDelta": 42, # The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.
"priceDelta": "A String", # The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.
},
"useAutoPricingMinPrice": True or False, # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.
},
"ruleId": "A String", # Output only. Immutable. The ID to uniquely identify each repricing rule.
"statsBasedRule": { # Definition of stats based rule. # The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
"percentageDelta": 42, # The percent change against the price target. Valid from 0 to 100 inclusively.
"priceDelta": "A String", # The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.
},
"title": "A String", # The title for the rule.
"type": "A String", # Required. Immutable. The type of the rule.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # *Deprecated*: New merchants can't start using this resource. Represents a repricing rule. A repricing rule is used by shopping serving to adjust transactable offer prices if conditions are met.
"cogsBasedRule": { # A repricing rule that changes the sale price based on cost of goods sale. # The rule definition for TYPE_COGS_BASED. Required when the rule type is TYPE_COGS_BASED.
"percentageDelta": 42, # The percent change against the COGS. Ex: 20 would mean to set the adjusted price 1.2X of the COGS data.
"priceDelta": "A String", # The price delta against the COGS. For example, 2 means $2 more of the COGS.
},
"countryCode": "A String", # Required. Immutable. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, "US").
"effectiveTimePeriod": { # Required. Time period when the rule should take effect.
"fixedTimePeriods": [ # A list of fixed time periods combined with OR. The maximum number of entries is limited to 5.
{ # Definition of a fixed time period.
"endTime": "A String", # The end time (exclusive) of the period. It can only be hour granularity.
"startTime": "A String", # The start time (inclusive) of the period. It can only be hour granularity.
},
],
},
"eligibleOfferMatcher": { # Matcher that specifies eligible offers. When the USE_FEED_ATTRIBUTE option is selected, only the repricing_rule_id attribute on the product feed is used to specify offer-rule mapping. When the CUSTOM_FILTER option is selected, only the *_matcher fields are used to filter the offers for offer-rule mapping. If the CUSTOM_FILTER option is selected, an offer needs to satisfy each custom filter matcher to be eligible for a rule. Size limit: the sum of the number of entries in all the matchers should not exceed 20. For example, there can be 15 product ids and 5 brands, but not 10 product ids and 11 brands. # Required. Match criteria for the eligible offers.
"brandMatcher": { # Matcher by string attributes. # Filter by the brand.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"itemGroupIdMatcher": { # Matcher by string attributes. # Filter by the item group id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"matcherOption": "A String", # Determines whether to use the custom matchers or the product feed attribute "repricing_rule_id" to specify offer-rule mapping.
"offerIdMatcher": { # Matcher by string attributes. # Filter by the offer id.
"strAttributes": [ # String attributes, as long as such attribute of an offer is one of the string attribute values, the offer is considered as passing the matcher. The string matcher checks an offer for inclusivity in the string attributes, not equality. Only literal string matching is supported, no regular expressions.
"A String",
],
},
"skipWhenOnPromotion": True or False, # When true, the rule won't be applied to offers with active promotions.
},
"languageCode": "A String", # Required. Immutable. The two-letter ISO 639-1 language code associated with the repricing rule.
"merchantId": "A String", # Output only. Immutable. Merchant that owns the repricing rule.
"paused": True or False, # Represents whether a rule is paused. A paused rule will behave like a non-paused rule within CRUD operations, with the major difference that a paused rule will not be evaluated and will have no effect on offers.
"restriction": { # Definition of a rule restriction. At least one of the following needs to be true: (1) use_auto_pricing_min_price is true (2) floor.price_delta exists (3) floor.percentage_delta exists If floor.price_delta and floor.percentage_delta are both set on a rule, the highest value will be chosen by the Repricer. In other words, for a product with a price of $50, if the `floor.percentage_delta` is "-10" and the floor.price_delta is "-12", the offer price will only be lowered $5 (10% lower than the original offer price). # Required. Restriction of the rule appliance.
"floor": { # Definition of a boundary. # The inclusive floor lower bound. The repricing rule only applies when new price >= floor.
"percentageDelta": 42, # The percentage delta relative to the offer selling price. This field is signed. It must be negative in floor. When it is used in floor, it should be > -100. For example, if an offer is selling at $10 and this field is -30 in floor, the repricing rule only applies if the calculated new price is >= $7.
"priceDelta": "A String", # The price micros relative to the offer selling price. This field is signed. It must be negative in floor. For example, if an offer is selling at $10 and this field is -$2 in floor, the repricing rule only applies if the calculated new price is >= $8.
},
"useAutoPricingMinPrice": True or False, # If true, use the AUTO_PRICING_MIN_PRICE offer attribute as the lower bound of the rule. If use_auto_pricing_min_price is true, then only offers with `AUTO_PRICING_MIN_PRICE` existing on the offer will get Repricer treatment, even if a floor value is set on the rule. Also, if use_auto_pricing_min_price is true, the floor restriction will be ignored.
},
"ruleId": "A String", # Output only. Immutable. The ID to uniquely identify each repricing rule.
"statsBasedRule": { # Definition of stats based rule. # The rule definition for TYPE_STATS_BASED. Required when the rule type is TYPE_STATS_BASED.
"percentageDelta": 42, # The percent change against the price target. Valid from 0 to 100 inclusively.
"priceDelta": "A String", # The price delta against the above price target. A positive value means the price should be adjusted to be above statistical measure, and a negative value means below. Currency code must not be included.
},
"title": "A String", # The title for the rule.
"type": "A String", # Required. Immutable. The type of the rule.
}</pre>
</div>
</body></html>
|
