1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="content_v2_1.html">Content API for Shopping</a> . <a href="content_v2_1.collections.html">collections</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(merchantId, body=None, x__xgafv=None)</a></code></p> 82<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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(merchantId, collectionId, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a collection from your Merchant Center account.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(merchantId, collectionId, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a collection from your Merchant Center account.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<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> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(merchantId, body=None, x__xgafv=None)</code> 103 <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. 104 105Args: 106 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # The collection message. 111 "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) 112 "customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 113 "customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 114 "customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 115 "customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 116 "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) 117 { # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736) 118 "offerId": "A String", # The unique identifier for the product item. 119 "x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image. 120 "y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image. 121 }, 122 ], 123 "headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580) 124 "A String", 125 ], 126 "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) 127 "imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236) 128 "A String", 129 ], 130 "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) 131 "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) 132 "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) 133 "productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155) 134} 135 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # The collection message. 145 "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) 146 "customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 147 "customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 148 "customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 149 "customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 150 "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) 151 { # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736) 152 "offerId": "A String", # The unique identifier for the product item. 153 "x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image. 154 "y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image. 155 }, 156 ], 157 "headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580) 158 "A String", 159 ], 160 "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) 161 "imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236) 162 "A String", 163 ], 164 "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) 165 "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) 166 "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) 167 "productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155) 168}</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="delete">delete(merchantId, collectionId, x__xgafv=None)</code> 173 <pre>Deletes a collection from your Merchant Center account. 174 175Args: 176 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) 177 collectionId: string, Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection. (required) 178 x__xgafv: string, V1 error format. 179 Allowed values 180 1 - v1 error format 181 2 - v2 error format 182</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="get">get(merchantId, collectionId, x__xgafv=None)</code> 187 <pre>Retrieves a collection from your Merchant Center account. 188 189Args: 190 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) 191 collectionId: string, Required. The REST ID of the collection. (required) 192 x__xgafv: string, V1 error format. 193 Allowed values 194 1 - v1 error format 195 2 - v2 error format 196 197Returns: 198 An object of the form: 199 200 { # The collection message. 201 "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) 202 "customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 203 "customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 204 "customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 205 "customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 206 "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) 207 { # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736) 208 "offerId": "A String", # The unique identifier for the product item. 209 "x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image. 210 "y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image. 211 }, 212 ], 213 "headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580) 214 "A String", 215 ], 216 "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) 217 "imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236) 218 "A String", 219 ], 220 "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) 221 "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) 222 "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) 223 "productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155) 224}</pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="list">list(merchantId, pageSize=None, pageToken=None, x__xgafv=None)</code> 229 <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. 230 231Args: 232 merchantId: string, Required. The ID of the account that contains the collection. This account cannot be a multi-client account. (required) 233 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. 234 pageToken: string, Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. 235 x__xgafv: string, V1 error format. 236 Allowed values 237 1 - v1 error format 238 2 - v2 error format 239 240Returns: 241 An object of the form: 242 243 { # Response message for the ListCollections method. 244 "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. 245 "resources": [ # The collections listed. 246 { # The collection message. 247 "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) 248 "customLabel1": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 249 "customLabel2": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 250 "customLabel3": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 251 "customLabel4": "A String", # Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. 252 "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) 253 { # The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736) 254 "offerId": "A String", # The unique identifier for the product item. 255 "x": 3.14, # Required. X-coordinate of the product callout on the Shoppable Image. 256 "y": 3.14, # Required. Y-coordinate of the product callout on the Shoppable Image. 257 }, 258 ], 259 "headline": [ # Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580) 260 "A String", 261 ], 262 "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) 263 "imageLink": [ # The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236) 264 "A String", 265 ], 266 "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) 267 "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) 268 "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) 269 "productCountry": "A String", # [product_country attribute](https://support.google.com/merchants/answer/9674155) 270 }, 271 ], 272}</pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 277 <pre>Retrieves the next page of results. 278 279Args: 280 previous_request: The request for the previous page. (required) 281 previous_response: The response from the request for the previous page. (required) 282 283Returns: 284 A request object that you can call 'execute()' on to request the next 285 page. Returns None if there are no more items in the collection. 286 </pre> 287</div> 288 289</body></html>