blob: 983c2c740ea1622b43906160675653470300b657 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<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.html">Content API for Shopping</a> . <a href="content_v2.accounts.html">accounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +000078 <code><a href="#authinfo">authinfo()</a></code></p>
79<p class="firstline">Returns information about the authenticated user.</p>
80<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040081 <code><a href="#claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070082<p class="firstline">Claims the website of a Merchant Center sub-account.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -040083<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070084 <code><a href="#close">close()</a></code></p>
85<p class="firstline">Close httplib2 connections.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#custombatch">custombatch(body=None, dryRun=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070088<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070090 <code><a href="#delete">delete(merchantId, accountId, dryRun=None, force=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Deletes a Merchant Center sub-account.</p>
Craig Citro065b5302014-08-14 00:47:23 -070092<p class="toc_element">
93 <code><a href="#get">get(merchantId, accountId)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Retrieves a Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -070095<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#insert">insert(merchantId, body=None, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Creates a Merchant Center sub-account.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#link">link(merchantId, accountId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700101<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700102 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Lists the sub-accounts in your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700104<p class="toc_element">
105 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
106<p class="firstline">Retrieves the next page of results.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#update">update(merchantId, accountId, body=None, dryRun=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700109<p class="firstline">Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700110<h3>Method Details</h3>
111<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000112 <code class="details" id="authinfo">authinfo()</code>
113 <pre>Returns information about the authenticated user.
114
115Args:
116
117Returns:
118 An object of the form:
119
120 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700121 &quot;accountIdentifiers&quot;: [ # The account identifiers corresponding to the authenticated user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000122 # - For an individual account: only the merchant ID is defined
123 # - For an aggregator: only the aggregator ID is defined
124 # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
125 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700126 &quot;aggregatorId&quot;: &quot;A String&quot;, # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
127 &quot;merchantId&quot;: &quot;A String&quot;, # The merchant account ID, set for individual accounts and subaccounts.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000128 },
129 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700130 &quot;kind&quot;: &quot;content#accountsAuthInfoResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsAuthInfoResponse&quot;.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000131 }</pre>
132</div>
133
134<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400135 <code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136 <pre>Claims the website of a Merchant Center sub-account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400137
138Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700139 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400140 accountId: string, The ID of the account whose website is claimed. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700141 overwrite: boolean, Only available to selected merchants. When set to `True`, this flag removes any existing claim on the requested website by another account and replaces it with a claim from this account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400142
143Returns:
144 An object of the form:
145
146 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700147 &quot;kind&quot;: &quot;content#accountsClaimWebsiteResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsClaimWebsiteResponse&quot;.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400148 }</pre>
149</div>
150
151<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152 <code class="details" id="close">close()</code>
153 <pre>Close httplib2 connections.</pre>
154</div>
155
156<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700157 <code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700158 <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
159
160Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700161 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700162 The object takes the form of:
163
164{
Bu Sun Kim65020912020-05-20 12:08:20 -0700165 &quot;entries&quot;: [ # The request entries to be processed in the batch.
Craig Citroe633be12015-03-02 13:40:36 -0800166 { # A batch entry encoding a single non-batch accounts request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700167 &quot;account&quot;: { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. # The account to create or update. Only defined if the method is `insert` or `update`.
168 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
169 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
170 {
171 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
172 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700173 #
174 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700175 # - &quot;`active`&quot;
176 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700177 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700178 ],
179 &quot;businessInformation&quot;: { # The business information of the account.
180 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700181 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700182 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
183 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
184 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
185 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
186 },
187 &quot;customerService&quot;: { # The customer service information of the business.
188 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
189 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
190 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
191 },
192 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
Craig Citro065b5302014-08-14 00:47:23 -0700193 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
195 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
196 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
197 #
198 # Acceptable values are:
199 # - &quot;`active`&quot;
200 # - &quot;`pending`&quot;
201 },
202 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
203 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
204 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
205 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
206 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
207 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
208 {
209 &quot;admin&quot;: True or False, # Whether user is an admin.
210 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
211 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
212 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
213 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
214 },
215 ],
216 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
217 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
218 {
219 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
220 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
221 },
222 ],
223 },
224 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the targeted account. Only defined if the method is not `insert`.
225 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
226 &quot;force&quot;: True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700227 &quot;labelIds&quot;: [ # Label IDs for the &#x27;updatelabels&#x27; request.
228 &quot;A String&quot;,
229 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 &quot;linkRequest&quot;: { # Details about the `link` request.
231 &quot;action&quot;: &quot;A String&quot;, # Action to perform for this link. The `&quot;request&quot;` action is only available to select merchants.
232 #
233 # Acceptable values are:
234 # - &quot;`approve`&quot;
235 # - &quot;`remove`&quot;
236 # - &quot;`request`&quot;
237 &quot;linkType&quot;: &quot;A String&quot;, # Type of the link between the two accounts.
238 #
239 # Acceptable values are:
240 # - &quot;`channelPartner`&quot;
241 # - &quot;`eCommercePlatform`&quot;
242 &quot;linkedAccountId&quot;: &quot;A String&quot;, # The ID of the linked account.
243 },
244 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
245 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700246 #
247 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700248 # - &quot;`claimWebsite`&quot;
249 # - &quot;`delete`&quot;
250 # - &quot;`get`&quot;
251 # - &quot;`insert`&quot;
252 # - &quot;`link`&quot;
253 # - &quot;`update`&quot;
254 &quot;overwrite&quot;: True or False, # Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.
Craig Citro065b5302014-08-14 00:47:23 -0700255 },
256 ],
257 }
258
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700259 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700260
261Returns:
262 An object of the form:
263
264 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 &quot;entries&quot;: [ # The result of the execution of the batch requests.
Craig Citroe633be12015-03-02 13:40:36 -0800266 { # A batch entry encoding a single non-batch accounts response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 &quot;account&quot;: { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role. # The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`.
268 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
269 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
270 {
271 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
272 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700273 #
274 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700275 # - &quot;`active`&quot;
276 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700277 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 ],
279 &quot;businessInformation&quot;: { # The business information of the account.
280 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700281 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700282 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
283 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
284 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
285 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
286 },
287 &quot;customerService&quot;: { # The customer service information of the business.
288 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
289 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
290 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
291 },
292 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
Craig Citro065b5302014-08-14 00:47:23 -0700293 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700294 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
295 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
296 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
297 #
298 # Acceptable values are:
299 # - &quot;`active`&quot;
300 # - &quot;`pending`&quot;
301 },
302 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
303 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
304 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
305 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
306 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
307 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
308 {
309 &quot;admin&quot;: True or False, # Whether user is an admin.
310 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
311 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
312 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
313 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
314 },
315 ],
316 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
317 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
318 {
319 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
320 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Craig Citro065b5302014-08-14 00:47:23 -0700321 },
322 ],
323 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700324 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
325 &quot;errors&quot;: { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
326 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
327 &quot;errors&quot;: [ # A list of errors.
328 { # An error returned by the API.
329 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
330 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
331 &quot;reason&quot;: &quot;A String&quot;, # The error code.
332 },
333 ],
334 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
335 },
336 &quot;kind&quot;: &quot;content#accountsCustomBatchResponseEntry&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accountsCustomBatchResponseEntry`&quot;
337 &quot;linkStatus&quot;: &quot;A String&quot;, # Deprecated. This field is never set.
Dan O'Mearadd494642020-05-01 07:42:23 -0700338 #
339 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700340 # - &quot;`active`&quot;
341 # - &quot;`inactive`&quot;
342 # - &quot;`pending`&quot;
Craig Citro065b5302014-08-14 00:47:23 -0700343 },
344 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700345 &quot;kind&quot;: &quot;content#accountsCustomBatchResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsCustomBatchResponse&quot;.
Craig Citro065b5302014-08-14 00:47:23 -0700346 }</pre>
347</div>
348
349<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700350 <code class="details" id="delete">delete(merchantId, accountId, dryRun=None, force=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700351 <pre>Deletes a Merchant Center sub-account.
Craig Citro065b5302014-08-14 00:47:23 -0700352
353Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700354 merchantId: string, The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700355 accountId: string, The ID of the account. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700356 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Bu Sun Kim65020912020-05-20 12:08:20 -0700357 force: boolean, Flag to delete sub-accounts with products. The default value is false.
Craig Citro065b5302014-08-14 00:47:23 -0700358</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="get">get(merchantId, accountId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 <pre>Retrieves a Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700364
365Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700366 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700367 accountId: string, The ID of the account. (required)
368
369Returns:
370 An object of the form:
371
Dan O'Mearadd494642020-05-01 07:42:23 -0700372 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700373 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
374 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
375 {
376 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
377 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700378 #
379 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700380 # - &quot;`active`&quot;
381 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700382 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700383 ],
384 &quot;businessInformation&quot;: { # The business information of the account.
385 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700386 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700387 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
388 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
389 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
390 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
391 },
392 &quot;customerService&quot;: { # The customer service information of the business.
393 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
394 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
395 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
396 },
397 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
398 },
399 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
400 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
401 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
402 #
403 # Acceptable values are:
404 # - &quot;`active`&quot;
405 # - &quot;`pending`&quot;
406 },
407 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
408 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
409 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
410 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
411 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
412 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
413 {
414 &quot;admin&quot;: True or False, # Whether user is an admin.
415 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
416 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
417 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
418 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
419 },
420 ],
421 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
422 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
423 {
424 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
425 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
426 },
427 ],
428 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700429</div>
430
431<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700432 <code class="details" id="insert">insert(merchantId, body=None, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700433 <pre>Creates a Merchant Center sub-account.
Craig Citro065b5302014-08-14 00:47:23 -0700434
435Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700436 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700437 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700438 The object takes the form of:
439
Dan O'Mearadd494642020-05-01 07:42:23 -0700440{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700441 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
442 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
443 {
444 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
445 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700446 #
447 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700448 # - &quot;`active`&quot;
449 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700450 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700451 ],
452 &quot;businessInformation&quot;: { # The business information of the account.
453 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700454 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700455 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
456 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
457 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
458 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
459 },
460 &quot;customerService&quot;: { # The customer service information of the business.
461 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
462 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
463 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
464 },
465 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
466 },
467 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
468 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
469 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
470 #
471 # Acceptable values are:
472 # - &quot;`active`&quot;
473 # - &quot;`pending`&quot;
474 },
475 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
476 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
477 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
478 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
479 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
480 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
481 {
482 &quot;admin&quot;: True or False, # Whether user is an admin.
483 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
484 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
485 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
486 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
487 },
488 ],
489 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
490 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
491 {
492 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
493 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
494 },
495 ],
496}
Craig Citro065b5302014-08-14 00:47:23 -0700497
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700498 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700499
500Returns:
501 An object of the form:
502
Dan O'Mearadd494642020-05-01 07:42:23 -0700503 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700504 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
505 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
506 {
507 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
508 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700509 #
510 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700511 # - &quot;`active`&quot;
512 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700513 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700514 ],
515 &quot;businessInformation&quot;: { # The business information of the account.
516 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700517 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700518 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
519 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
520 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
521 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
522 },
523 &quot;customerService&quot;: { # The customer service information of the business.
524 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
525 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
526 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
527 },
528 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
529 },
530 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
531 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
532 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
533 #
534 # Acceptable values are:
535 # - &quot;`active`&quot;
536 # - &quot;`pending`&quot;
537 },
538 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
539 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
540 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
541 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
542 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
543 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
544 {
545 &quot;admin&quot;: True or False, # Whether user is an admin.
546 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
547 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
548 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
549 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
550 },
551 ],
552 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
553 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
554 {
555 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
556 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
557 },
558 ],
559 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700560</div>
561
562<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700563 <code class="details" id="link">link(merchantId, accountId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700564 <pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Craig Citro065b5302014-08-14 00:47:23 -0700565
566Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700567 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700568 accountId: string, The ID of the account that should be linked. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700569 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700570 The object takes the form of:
571
572{
Bu Sun Kim65020912020-05-20 12:08:20 -0700573 &quot;action&quot;: &quot;A String&quot;, # Action to perform for this link. The `&quot;request&quot;` action is only available to select merchants.
Dan O'Mearadd494642020-05-01 07:42:23 -0700574 #
575 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700576 # - &quot;`approve`&quot;
577 # - &quot;`remove`&quot;
578 # - &quot;`request`&quot;
579 &quot;linkType&quot;: &quot;A String&quot;, # Type of the link between the two accounts.
Dan O'Mearadd494642020-05-01 07:42:23 -0700580 #
581 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700582 # - &quot;`channelPartner`&quot;
583 # - &quot;`eCommercePlatform`&quot;
584 &quot;linkedAccountId&quot;: &quot;A String&quot;, # The ID of the linked account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700585 }
586
587
588Returns:
589 An object of the form:
590
591 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700592 &quot;kind&quot;: &quot;content#accountsLinkResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsLinkResponse&quot;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700593 }</pre>
594</div>
595
596<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700597 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700598 <pre>Lists the sub-accounts in your Merchant Center account.
599
600Args:
601 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700602 maxResults: integer, The maximum number of accounts to return in the response, used for paging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700603 pageToken: string, The token returned by the previous request.
Craig Citro065b5302014-08-14 00:47:23 -0700604
605Returns:
606 An object of the form:
607
608 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700609 &quot;kind&quot;: &quot;content#accountsListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsListResponse&quot;.
610 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of accounts.
611 &quot;resources&quot;: [
Dan O'Mearadd494642020-05-01 07:42:23 -0700612 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700613 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
614 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
615 {
616 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
617 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700618 #
619 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700620 # - &quot;`active`&quot;
621 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700622 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700623 ],
624 &quot;businessInformation&quot;: { # The business information of the account.
625 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700626 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700627 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
628 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
629 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
630 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
631 },
632 &quot;customerService&quot;: { # The customer service information of the business.
633 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
634 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
635 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
636 },
637 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
Craig Citro065b5302014-08-14 00:47:23 -0700638 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700639 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
640 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
641 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
642 #
643 # Acceptable values are:
644 # - &quot;`active`&quot;
645 # - &quot;`pending`&quot;
646 },
647 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
648 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
649 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
650 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
651 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
652 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
653 {
654 &quot;admin&quot;: True or False, # Whether user is an admin.
655 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
656 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
657 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
658 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
659 },
660 ],
661 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
662 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
663 {
664 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
665 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
666 },
667 ],
668 },
Craig Citro065b5302014-08-14 00:47:23 -0700669 ],
670 }</pre>
671</div>
672
673<div class="method">
674 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
675 <pre>Retrieves the next page of results.
676
677Args:
678 previous_request: The request for the previous page. (required)
679 previous_response: The response from the request for the previous page. (required)
680
681Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700682 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700683 page. Returns None if there are no more items in the collection.
684 </pre>
685</div>
686
687<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700688 <code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700689 <pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700690
691Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700692 merchantId: string, The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700693 accountId: string, The ID of the account. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700694 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700695 The object takes the form of:
696
Dan O'Mearadd494642020-05-01 07:42:23 -0700697{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700698 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
699 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
700 {
701 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
702 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700703 #
704 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700705 # - &quot;`active`&quot;
706 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700707 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700708 ],
709 &quot;businessInformation&quot;: { # The business information of the account.
710 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700711 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700712 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
713 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
714 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
715 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
716 },
717 &quot;customerService&quot;: { # The customer service information of the business.
718 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
719 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
720 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
721 },
722 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
723 },
724 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
725 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
726 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
727 #
728 # Acceptable values are:
729 # - &quot;`active`&quot;
730 # - &quot;`pending`&quot;
731 },
732 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
733 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
734 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
735 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
736 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
737 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
738 {
739 &quot;admin&quot;: True or False, # Whether user is an admin.
740 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
741 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
742 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
743 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
744 },
745 ],
746 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
747 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
748 {
749 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
750 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
751 },
752 ],
753}
Craig Citro065b5302014-08-14 00:47:23 -0700754
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700755 dryRun: boolean, Flag to simulate a request like in a live environment. If set to true, dry-run mode checks the validity of the request and returns errors (if any).
Craig Citro065b5302014-08-14 00:47:23 -0700756
757Returns:
758 An object of the form:
759
Dan O'Mearadd494642020-05-01 07:42:23 -0700760 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, and update require the admin role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700761 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
762 &quot;adwordsLinks&quot;: [ # List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list.
763 {
764 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
765 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
Dan O'Mearadd494642020-05-01 07:42:23 -0700766 #
767 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700768 # - &quot;`active`&quot;
769 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700770 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700771 ],
772 &quot;businessInformation&quot;: { # The business information of the account.
773 &quot;address&quot;: { # The address of the business.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700774 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;). This value cannot be set for a sub-account of an MCA. All MCA sub-accounts inherit the country of their parent MCA.
Bu Sun Kim65020912020-05-20 12:08:20 -0700775 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
776 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
777 &quot;region&quot;: &quot;A String&quot;, # Top-level administrative subdivision of the country. For example, a state like California (&quot;CA&quot;) or a province like Quebec (&quot;QC&quot;).
778 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
779 },
780 &quot;customerService&quot;: { # The customer service information of the business.
781 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
782 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
783 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
784 },
785 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
786 },
787 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
788 &quot;gmbEmail&quot;: &quot;A String&quot;, # The GMB email address of which a specific account within a GMB account. A sample account within a GMB account could be a business account with set of locations, managed under the GMB account.
789 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
790 #
791 # Acceptable values are:
792 # - &quot;`active`&quot;
793 # - &quot;`pending`&quot;
794 },
795 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
796 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
797 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
798 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
799 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
800 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
801 {
802 &quot;admin&quot;: True or False, # Whether user is an admin.
803 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
804 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
805 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
806 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
807 },
808 ],
809 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
810 &quot;youtubeChannelLinks&quot;: [ # List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.
811 {
812 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
813 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it&#x27;s pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it&#x27;s still pending or with status `pending` when it&#x27;s already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.
814 },
815 ],
816 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700817</div>
818
819</body></html>