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
|
<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.collections.html">collections</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="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.</p>
<p class="toc_element">
<code><a href="#delete">delete(merchantId, collectionId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a collection from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#get">get(merchantId, collectionId, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a collection from your Merchant Center account.</p>
<p class="toc_element">
<code><a href="#list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token 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>
<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, x__xgafv=None)</code>
<pre>Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.
Args:
merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required)
body: object, The request body.
The object takes the form of:
{ # The collection message.
"customLabel0": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
"customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"featuredProduct": [ # This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
{ # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)
"offerId": "A String", # The unique identifier for the product item.
"x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image.
"y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image.
},
],
"headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
"A String",
],
"id": "A String", # Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
"imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
"A String",
],
"language": "A String", # The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
"link": "A String", # A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
"mobileLink": "A String", # A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
"productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155)
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The collection message.
"customLabel0": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
"customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"featuredProduct": [ # This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
{ # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)
"offerId": "A String", # The unique identifier for the product item.
"x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image.
"y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image.
},
],
"headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
"A String",
],
"id": "A String", # Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
"imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
"A String",
],
"language": "A String", # The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
"link": "A String", # A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
"mobileLink": "A String", # A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
"productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155)
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(merchantId, collectionId, x__xgafv=None)</code>
<pre>Deletes a collection from your Merchant Center account.
Args:
merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required)
collectionId: string, Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection. (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, collectionId, x__xgafv=None)</code>
<pre>Retrieves a collection from your Merchant Center account.
Args:
merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required)
collectionId: string, Required. The REST ID of the collection. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The collection message.
"customLabel0": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
"customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"featuredProduct": [ # This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
{ # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)
"offerId": "A String", # The unique identifier for the product item.
"x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image.
"y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image.
},
],
"headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
"A String",
],
"id": "A String", # Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
"imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
"A String",
],
"language": "A String", # The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
"link": "A String", # A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
"mobileLink": "A String", # A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
"productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155)
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.
Args:
merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required)
pageSize: integer, The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
pageToken: string, Token (if provided) to retrieve the subsequent page. All other parameters must match the original 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 ListCollections 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.
"resources": [ # The collections listed.
{ # The collection message.
"customLabel0": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)
"customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.
"featuredProduct": [ # This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)
{ # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)
"offerId": "A String", # The unique identifier for the product item.
"x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image.
"y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image.
},
],
"headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)
"A String",
],
"id": "A String", # Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)
"imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)
"A String",
],
"language": "A String", # The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)
"link": "A String", # A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)
"mobileLink": "A String", # A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)
"productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155)
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
