/
content_v2_1.products.html
2127 lines (2080 loc) 路 199 KB
/
content_v2_1.products.html
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
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<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.products.html">products</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="#custombatch">custombatch(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves, inserts, and deletes multiple products in a single request.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, productId, feedId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a product from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, productId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a product from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#insert">insert(merchantId, body=None, feedId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.</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="#update">update(merchantId, productId, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.</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="custombatch">custombatch(body=None, x__xgafv=None)</code>
<pre>Retrieves, inserts, and deletes multiple products in a single request.
Args:
body: object, The request body.
The object takes the form of:
{
"entries": [ # The request entries to be processed in the batch.
{ # A batch entry encoding a single non-batch products request.
"batchId": 42, # An entry ID, unique within the batch request.
"feedId": "A String", # The Content API Supplemental Feed ID. If present then product insertion or deletion applies to a supplemental feed instead of primary Content API feed.
"merchantId": "A String", # The ID of the managing account.
"method": "A String", # The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`update`"
"product": { # Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. # The product to insert or update. Only required if the method is `insert` or `update`. If the `update` method is used with `updateMask` only to delete a field, then this isn't required. For example, setting `salePrice` on the `updateMask` and not providing a `product` will result in an existing sale price on the product specified by `productId` being deleted.
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"additionalSizeType": "A String", # Additional cut of the item. Used together with size_type to represent combined size types for apparel items.
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"ageGroup": "A String", # Target age group of the item.
"availability": "A String", # Availability status of the item.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"brand": "A String", # Brand of the item.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"cloudExportAdditionalProperties": [ # Extra fields to export to the Cloud Retail program.
{ # Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
"boolValue": True or False, # Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
"floatValue": [ # Float values of the given property. For example for a TV product 1.2345. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
3.14,
],
"intValue": [ # Integer values of the given property. For example, 1080 for a screen resolution of a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
"A String",
],
"maxValue": 3.14, # Maximum float value of the given property. For example for a TV product 100.00.
"minValue": 3.14, # Minimum float value of the given property. For example for a TV product 1.00.
"propertyName": "A String", # Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
"textValue": [ # Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.
"A String",
],
"unitCode": "A String", # Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256 bytes.
},
],
"color": "A String", # Color of the item.
"condition": "A String", # Condition or state of the item.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"description": "A String", # Description of the item.
"disclosureDate": "A String", # The date time when an offer becomes visible in search results across Google鈥檚 YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date]( https://support.google.com/merchants/answer/13034208) for more information.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.
"externalSellerId": "A String", # Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
"feedLabel": "A String", # Feed label for the item. Either `targetCountry` or `feedLabel` is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"gender": "A String", # Target gender of the item.
"googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.
"identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
"imageLink": "A String", # URL of an image of the item.
"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"installment": { # Number and amount of installments to pay for an item.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
"A String",
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
},
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
"pattern": "A String", # The item's pattern (for example, polka dots).
"pause": "A String", # Publication of this item should be temporarily paused. Acceptable values are: - "`ads`"
"pickupMethod": "A String", # The pick up option for the item. Acceptable values are: - "`buy`" - "`reserve`" - "`ship to store`" - "`not supported`"
"pickupSla": "A String", # Item store pickup timeline. Acceptable values are: - "`same day`" - "`next day`" - "`2-day`" - "`3-day`" - "`4-day`" - "`5-day`" - "`6-day`" - "`7-day`" - "`multi-week`"
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"productDetails": [ # Technical specification or additional product details.
{
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
"sectionName": "A String", # The section header used to group a set of product details.
},
],
"productHeight": { # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"productLength": { # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"productTypes": [ # Categories of the item (formatted as in product data specification).
"A String",
],
"productWeight": { # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`g`" - "`kg`" - "`oz`" - "`lb`"
"value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
"productWidth": { # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see product data specification ).
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"shipping": [ # Shipping rules.
{
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.
"maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
"maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
"minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it's not required if maxHandlingTime is present.
"minTransitTime": "A String", # Minimum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it's not required if maxTransitTime is present.
"postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"service": "A String", # A free-form description of the service class or delivery speed.
},
],
"shippingHeight": { # Height of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"shippingLength": { # Length of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
"shippingWidth": { # Width of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shoppingAdsExcludedCountries": [ # List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.
"A String",
],
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).
"A String",
],
"source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"period": "A String", # The type of subscription period.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.
"postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"region": "A String", # The geographic region to which the tax rate applies.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"title": "A String", # Title of the item.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"unit": "A String", # The unit of the denominator.
"value": "A String", # The denominator of the unit price.
},
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
},
"productId": "A String", # The ID of the product to get or mutate. Only defined if the method is `get`, `delete`, or `update`.
"updateMask": "A String", # The comma-separated list of product attributes to be updated. Example: `"title,salePrice"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. *You must specify the update mask to delete attributes.* Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged. Only defined if the method is `update`.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"entries": [ # The result of the execution of the batch requests.
{ # A batch entry encoding a single non-batch products response.
"batchId": 42, # The ID of the request entry this entry responds to.
"errors": { # A list of errors returned by a failed batch entry. # A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request.
"code": 42, # The HTTP status of the first error in `errors`.
"errors": [ # A list of errors.
{ # An error returned by the API.
"domain": "A String", # The domain of the error.
"message": "A String", # A description of the error.
"reason": "A String", # The error code.
},
],
"message": "A String", # The message of the first error in `errors`.
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponseEntry`"
"product": { # Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. # The inserted product. Only defined if the method is `insert` and if the request was successful.
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"additionalSizeType": "A String", # Additional cut of the item. Used together with size_type to represent combined size types for apparel items.
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"ageGroup": "A String", # Target age group of the item.
"availability": "A String", # Availability status of the item.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"brand": "A String", # Brand of the item.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"cloudExportAdditionalProperties": [ # Extra fields to export to the Cloud Retail program.
{ # Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
"boolValue": True or False, # Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
"floatValue": [ # Float values of the given property. For example for a TV product 1.2345. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
3.14,
],
"intValue": [ # Integer values of the given property. For example, 1080 for a screen resolution of a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
"A String",
],
"maxValue": 3.14, # Maximum float value of the given property. For example for a TV product 100.00.
"minValue": 3.14, # Minimum float value of the given property. For example for a TV product 1.00.
"propertyName": "A String", # Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
"textValue": [ # Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.
"A String",
],
"unitCode": "A String", # Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256 bytes.
},
],
"color": "A String", # Color of the item.
"condition": "A String", # Condition or state of the item.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"description": "A String", # Description of the item.
"disclosureDate": "A String", # The date time when an offer becomes visible in search results across Google鈥檚 YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date]( https://support.google.com/merchants/answer/13034208) for more information.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.
"externalSellerId": "A String", # Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
"feedLabel": "A String", # Feed label for the item. Either `targetCountry` or `feedLabel` is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"gender": "A String", # Target gender of the item.
"googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.
"identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
"imageLink": "A String", # URL of an image of the item.
"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"installment": { # Number and amount of installments to pay for an item.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
"A String",
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
},
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
"pattern": "A String", # The item's pattern (for example, polka dots).
"pause": "A String", # Publication of this item should be temporarily paused. Acceptable values are: - "`ads`"
"pickupMethod": "A String", # The pick up option for the item. Acceptable values are: - "`buy`" - "`reserve`" - "`ship to store`" - "`not supported`"
"pickupSla": "A String", # Item store pickup timeline. Acceptable values are: - "`same day`" - "`next day`" - "`2-day`" - "`3-day`" - "`4-day`" - "`5-day`" - "`6-day`" - "`7-day`" - "`multi-week`"
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"productDetails": [ # Technical specification or additional product details.
{
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
"sectionName": "A String", # The section header used to group a set of product details.
},
],
"productHeight": { # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"productLength": { # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"productTypes": [ # Categories of the item (formatted as in product data specification).
"A String",
],
"productWeight": { # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`g`" - "`kg`" - "`oz`" - "`lb`"
"value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
"productWidth": { # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see product data specification ).
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"shipping": [ # Shipping rules.
{
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.
"maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
"maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
"minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it's not required if maxHandlingTime is present.
"minTransitTime": "A String", # Minimum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it's not required if maxTransitTime is present.
"postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"service": "A String", # A free-form description of the service class or delivery speed.
},
],
"shippingHeight": { # Height of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"shippingLength": { # Length of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
"shippingWidth": { # Width of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shoppingAdsExcludedCountries": [ # List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.
"A String",
],
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).
"A String",
],
"source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"period": "A String", # The type of subscription period.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.
"postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"region": "A String", # The geographic region to which the tax rate applies.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"title": "A String", # Title of the item.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"unit": "A String", # The unit of the denominator.
"value": "A String", # The denominator of the unit price.
},
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
},
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponse`".
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, productId, feedId=None, x__xgafv=None)</code>
<pre>Deletes a product from your Merchant Center account.
Args:
merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
productId: string, The REST ID of the product. (required)
feedId: string, The Content API Supplemental Feed ID. If present then product deletion applies to the data in a supplemental feed. If absent, entire product will be deleted.
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, productId, x__xgafv=None)</code>
<pre>Retrieves a product from your Merchant Center account.
Args:
merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
productId: string, The REST ID of the product. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"additionalSizeType": "A String", # Additional cut of the item. Used together with size_type to represent combined size types for apparel items.
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"ageGroup": "A String", # Target age group of the item.
"availability": "A String", # Availability status of the item.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"brand": "A String", # Brand of the item.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"cloudExportAdditionalProperties": [ # Extra fields to export to the Cloud Retail program.
{ # Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
"boolValue": True or False, # Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
"floatValue": [ # Float values of the given property. For example for a TV product 1.2345. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
3.14,
],
"intValue": [ # Integer values of the given property. For example, 1080 for a screen resolution of a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
"A String",
],
"maxValue": 3.14, # Maximum float value of the given property. For example for a TV product 100.00.
"minValue": 3.14, # Minimum float value of the given property. For example for a TV product 1.00.
"propertyName": "A String", # Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
"textValue": [ # Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.
"A String",
],
"unitCode": "A String", # Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256 bytes.
},
],
"color": "A String", # Color of the item.
"condition": "A String", # Condition or state of the item.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"description": "A String", # Description of the item.
"disclosureDate": "A String", # The date time when an offer becomes visible in search results across Google鈥檚 YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date]( https://support.google.com/merchants/answer/13034208) for more information.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.
"externalSellerId": "A String", # Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
"feedLabel": "A String", # Feed label for the item. Either `targetCountry` or `feedLabel` is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"gender": "A String", # Target gender of the item.
"googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.
"identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
"imageLink": "A String", # URL of an image of the item.
"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"installment": { # Number and amount of installments to pay for an item.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
"A String",
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
},
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).
"mobileLink": "A String", # URL for the mobile-optimized version of your item's landing page.
"mobileLinkTemplate": "A String", # URL template for merchant hosted local storefront optimized for mobile devices.
"mpn": "A String", # Manufacturer Part Number (MPN) of the item.
"multipack": "A String", # The number of identical products in a merchant-defined multipack.
"offerId": "A String", # Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.
"pattern": "A String", # The item's pattern (for example, polka dots).
"pause": "A String", # Publication of this item should be temporarily paused. Acceptable values are: - "`ads`"
"pickupMethod": "A String", # The pick up option for the item. Acceptable values are: - "`buy`" - "`reserve`" - "`ship to store`" - "`not supported`"
"pickupSla": "A String", # Item store pickup timeline. Acceptable values are: - "`same day`" - "`next day`" - "`2-day`" - "`3-day`" - "`4-day`" - "`5-day`" - "`6-day`" - "`7-day`" - "`multi-week`"
"price": { # Price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"productDetails": [ # Technical specification or additional product details.
{
"attributeName": "A String", # The name of the product detail.
"attributeValue": "A String", # The value of the product detail.
"sectionName": "A String", # The section header used to group a set of product details.
},
],
"productHeight": { # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"productHighlights": [ # Bullet points describing the most relevant highlights of a product.
"A String",
],
"productLength": { # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"productTypes": [ # Categories of the item (formatted as in product data specification).
"A String",
],
"productWeight": { # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
"unit": "A String", # Required. The weight unit. Acceptable values are: - "`g`" - "`kg`" - "`oz`" - "`lb`"
"value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
},
"productWidth": { # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
"unit": "A String", # Required. The length units. Acceptable values are: - "`in`" - "`cm`"
"value": 3.14, # Required. The length value represented as a number. The value can have a maximum precision of four decimal places.
},
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
"salePrice": { # Advertised sale price of the item.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"salePriceEffectiveDate": "A String", # Date range during which the item is on sale (see product data specification ).
"sellOnGoogleQuantity": "A String", # The quantity of the product that is available for selling on Google. Supported only for online products.
"shipping": [ # Shipping rules.
{
"country": "A String", # The CLDR territory code of the country to which an item will ship.
"locationGroupName": "A String", # The location where the shipping is applicable, represented by a location group name.
"locationId": "A String", # The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.
"maxHandlingTime": "A String", # Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
"maxTransitTime": "A String", # Maximum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.
"minHandlingTime": "A String", # Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it's not required if maxHandlingTime is present.
"minTransitTime": "A String", # Minimum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it's not required if maxTransitTime is present.
"postalCode": "A String", # The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.
"price": { # Fixed shipping price, represented as a number.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"region": "A String", # The geographic region to which a shipping rate applies.
"service": "A String", # A free-form description of the service class or delivery speed.
},
],
"shippingHeight": { # Height of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingLabel": "A String", # The shipping label of the product, used to group product in account-level shipping rules.
"shippingLength": { # Length of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shippingWeight": { # Weight of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The weight of the product used to calculate the shipping cost of the item.
},
"shippingWidth": { # Width of the item for shipping.
"unit": "A String", # The unit of value.
"value": 3.14, # The dimension of the product used to calculate the shipping cost of the item.
},
"shoppingAdsExcludedCountries": [ # List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.
"A String",
],
"sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
"sizeType": "A String", # The cut of the item. Recommended for apparel items.
"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).
"A String",
],
"source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`"
"subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
"amount": { # The amount the buyer has to pay per subscription period.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"period": "A String", # The type of subscription period.
"periodLength": "A String", # The number of subscription periods the buyer has to pay.
},
"targetCountry": "A String", # Required. The CLDR territory code for the item's country of sale.
"taxCategory": "A String", # The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
"taxes": [ # Tax information.
{
"country": "A String", # The country within which the item is taxed, specified as a CLDR territory code.
"locationId": "A String", # The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.
"postalCode": "A String", # The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.
"rate": 3.14, # The percentage of tax rate that applies to the item price.
"region": "A String", # The geographic region to which the tax rate applies.
"taxShip": True or False, # Should be set to true if tax is charged on shipping.
},
],
"title": "A String", # Title of the item.
"transitTimeLabel": "A String", # The transit time label of the product, used to group product in account-level transit time tables.
"unitPricingBaseMeasure": { # The preference of the denominator of the unit price.
"unit": "A String", # The unit of the denominator.
"value": "A String", # The denominator of the unit price.
},
"unitPricingMeasure": { # The measure and dimension of an item.
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(merchantId, body=None, feedId=None, x__xgafv=None)</code>
<pre>Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.
Args:
merchantId: string, The ID of the account that contains the product. This account cannot be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
"additionalImageLinks": [ # Additional URLs of images of the item.
"A String",
],
"additionalSizeType": "A String", # Additional cut of the item. Used together with size_type to represent combined size types for apparel items.
"adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
"adsLabels": [ # Similar to ads_grouping, but only works on CPC.
"A String",
],
"adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
"adult": True or False, # Should be set to true if the item is targeted towards adults.
"ageGroup": "A String", # Target age group of the item.
"availability": "A String", # Availability status of the item.
"availabilityDate": "A String", # The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
"brand": "A String", # Brand of the item.
"canonicalLink": "A String", # URL for the canonical version of your item's landing page.
"channel": "A String", # Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`"
"cloudExportAdditionalProperties": [ # Extra fields to export to the Cloud Retail program.
{ # Product property for the Cloud Retail API. For example, properties for a TV product could be "Screen-Resolution" or "Screen-Size".
"boolValue": True or False, # Boolean value of the given property. For example for a TV product, "True" or "False" if the screen is UHD.
"floatValue": [ # Float values of the given property. For example for a TV product 1.2345. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
3.14,
],
"intValue": [ # Integer values of the given property. For example, 1080 for a screen resolution of a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.
"A String",
],
"maxValue": 3.14, # Maximum float value of the given property. For example for a TV product 100.00.
"minValue": 3.14, # Minimum float value of the given property. For example for a TV product 1.00.
"propertyName": "A String", # Name of the given property. For example, "Screen-Resolution" for a TV product. Maximum string size is 256 characters.
"textValue": [ # Text value of the given property. For example, "8K(UHD)" could be a text value for a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.
"A String",
],
"unitCode": "A String", # Unit of the given property. For example, "Pixels" for a TV product. Maximum string size is 256 bytes.
},
],
"color": "A String", # Color of the item.
"condition": "A String", # Condition or state of the item.
"contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item.
"costOfGoodsSold": { # Cost of goods sold. Used for gross profit reporting.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"customAttributes": [ # A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).
{
"groupValues": [ # Subattributes within this attribute group. Exactly one of value or groupValues must be provided.
# Object with schema name: CustomAttribute
],
"name": "A String", # The name of the attribute. Underscores will be replaced by spaces upon insertion.
"value": "A String", # The value of the attribute.
},
],
"customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
"customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
"customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
"customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
"customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
"description": "A String", # Description of the item.
"disclosureDate": "A String", # The date time when an offer becomes visible in search results across Google鈥檚 YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date]( https://support.google.com/merchants/answer/13034208) for more information.
"displayAdsId": "A String", # An identifier for an item for dynamic remarketing campaigns.
"displayAdsLink": "A String", # URL directly to your item's landing page for dynamic remarketing campaigns.
"displayAdsSimilarIds": [ # Advertiser-specified recommendations.
"A String",
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns.
"energyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.
"A String",
],
"expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.
"externalSellerId": "A String", # Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
"feedLabel": "A String", # Feed label for the item. Either `targetCountry` or `feedLabel` is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).
"gender": "A String", # Target gender of the item.
"googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
"gtin": "A String", # Global Trade Item Number (GTIN) of the item.
"id": "A String", # The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.
"identifierExists": True or False, # False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.
"imageLink": "A String", # URL of an image of the item.
"includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
"A String",
],
"installment": { # Number and amount of installments to pay for an item.
"amount": { # The amount the buyer has to pay per month.
"currency": "A String", # The currency of the price.
"value": "A String", # The price represented as a number.
},
"months": "A String", # The number of installments the buyer has to pay.
},
"isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "`content#product`"
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
"A String",
],
"link": "A String", # URL directly linking to your item's page on your website.
"linkTemplate": "A String", # URL template for merchant hosted local storefront.
"loyaltyPoints": { # Loyalty points that users receive after purchasing the item. Japan only.
"name": "A String", # Name of loyalty points program. It is recommended to limit the name to 12 full-width characters or 24 Roman characters.
"pointsValue": "A String", # The retailer's loyalty points in absolute value.
"ratio": 3.14, # The ratio of a point when converted to currency. Google assumes currency based on Merchant Center settings. If ratio is left out, it defaults to 1.0.
},
"material": "A String", # The material of which the item is made.
"maxEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"maxHandlingTime": "A String", # Maximal product handling time (in business days).
"minEnergyEfficiencyClass": "A String", # The energy efficiency class as defined in EU directive 2010/30/EU.
"minHandlingTime": "A String", # Minimal product handling time (in business days).