blob: 9c21b270449ac0eb644a68dd3f2166b3d192f17b [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">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#custombatch">custombatch(body=None, dryRun=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070085<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070087 <code><a href="#delete">delete(merchantId, accountId, dryRun=None, force=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Deletes a Merchant Center sub-account.</p>
Craig Citro065b5302014-08-14 00:47:23 -070089<p class="toc_element">
90 <code><a href="#get">get(merchantId, accountId)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Retrieves a Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -070092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#insert">insert(merchantId, body=None, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="firstline">Creates a Merchant Center sub-account.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#link">link(merchantId, accountId, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<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 -070098<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070099 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Lists the sub-accounts in your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#update">update(merchantId, accountId, body=None, dryRun=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700106<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 -0700107<h3>Method Details</h3>
108<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000109 <code class="details" id="authinfo">authinfo()</code>
110 <pre>Returns information about the authenticated user.
111
112Args:
113
114Returns:
115 An object of the form:
116
117 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700118 &quot;accountIdentifiers&quot;: [ # The account identifiers corresponding to the authenticated user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000119 # - For an individual account: only the merchant ID is defined
120 # - For an aggregator: only the aggregator ID is defined
121 # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
122 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &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).
124 &quot;merchantId&quot;: &quot;A String&quot;, # The merchant account ID, set for individual accounts and subaccounts.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000125 },
126 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &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 +0000128 }</pre>
129</div>
130
131<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400132 <code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 <pre>Claims the website of a Merchant Center sub-account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400134
135Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 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 -0400137 accountId: string, The ID of the account whose website is claimed. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700138 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 -0400139
140Returns:
141 An object of the form:
142
143 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 &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 -0400145 }</pre>
146</div>
147
148<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700149 <code class="details" id="custombatch">custombatch(body=None, dryRun=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700150 <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
151
152Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700153 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700154 The object takes the form of:
155
156{
Bu Sun Kim65020912020-05-20 12:08:20 -0700157 &quot;entries&quot;: [ # The request entries to be processed in the batch.
Craig Citroe633be12015-03-02 13:40:36 -0800158 { # A batch entry encoding a single non-batch accounts request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700159 &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`.
160 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
161 &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.
162 {
163 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
164 &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 -0700165 #
166 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700167 # - &quot;`active`&quot;
168 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700169 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 ],
171 &quot;businessInformation&quot;: { # The business information of the account.
172 &quot;address&quot;: { # The address of the business.
173 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
174 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
175 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
176 &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;).
177 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
178 },
179 &quot;customerService&quot;: { # The customer service information of the business.
180 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
181 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
182 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
183 },
184 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
Craig Citro065b5302014-08-14 00:47:23 -0700185 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700186 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
187 &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.
188 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
189 #
190 # Acceptable values are:
191 # - &quot;`active`&quot;
192 # - &quot;`pending`&quot;
193 },
194 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
195 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
196 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
197 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
198 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
199 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
200 {
201 &quot;admin&quot;: True or False, # Whether user is an admin.
202 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
203 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
204 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
205 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
206 },
207 ],
208 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
209 &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.
210 {
211 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
212 &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.
213 },
214 ],
215 },
216 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the targeted account. Only defined if the method is not `insert`.
217 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
218 &quot;force&quot;: True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
219 &quot;linkRequest&quot;: { # Details about the `link` request.
220 &quot;action&quot;: &quot;A String&quot;, # Action to perform for this link. The `&quot;request&quot;` action is only available to select merchants.
221 #
222 # Acceptable values are:
223 # - &quot;`approve`&quot;
224 # - &quot;`remove`&quot;
225 # - &quot;`request`&quot;
226 &quot;linkType&quot;: &quot;A String&quot;, # Type of the link between the two accounts.
227 #
228 # Acceptable values are:
229 # - &quot;`channelPartner`&quot;
230 # - &quot;`eCommercePlatform`&quot;
231 &quot;linkedAccountId&quot;: &quot;A String&quot;, # The ID of the linked account.
232 },
233 &quot;merchantId&quot;: &quot;A String&quot;, # The ID of the managing account.
234 &quot;method&quot;: &quot;A String&quot;, # The method of the batch entry.
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 #
236 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 # - &quot;`claimWebsite`&quot;
238 # - &quot;`delete`&quot;
239 # - &quot;`get`&quot;
240 # - &quot;`insert`&quot;
241 # - &quot;`link`&quot;
242 # - &quot;`update`&quot;
243 &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 -0700244 },
245 ],
246 }
247
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700248 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 -0700249
250Returns:
251 An object of the form:
252
253 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700254 &quot;entries&quot;: [ # The result of the execution of the batch requests.
Craig Citroe633be12015-03-02 13:40:36 -0800255 { # A batch entry encoding a single non-batch accounts response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700256 &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`.
257 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
258 &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.
259 {
260 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
261 &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 -0700262 #
263 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700264 # - &quot;`active`&quot;
265 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700267 ],
268 &quot;businessInformation&quot;: { # The business information of the account.
269 &quot;address&quot;: { # The address of the business.
270 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
271 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
272 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
273 &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;).
274 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
275 },
276 &quot;customerService&quot;: { # The customer service information of the business.
277 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
278 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
279 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
280 },
281 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
Craig Citro065b5302014-08-14 00:47:23 -0700282 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
284 &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.
285 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
286 #
287 # Acceptable values are:
288 # - &quot;`active`&quot;
289 # - &quot;`pending`&quot;
290 },
291 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
292 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
293 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
294 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
295 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
296 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
297 {
298 &quot;admin&quot;: True or False, # Whether user is an admin.
299 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
300 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
301 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
302 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
303 },
304 ],
305 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
306 &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.
307 {
308 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
309 &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 -0700310 },
311 ],
312 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700313 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
314 &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.
315 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
316 &quot;errors&quot;: [ # A list of errors.
317 { # An error returned by the API.
318 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
319 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
320 &quot;reason&quot;: &quot;A String&quot;, # The error code.
321 },
322 ],
323 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
324 },
325 &quot;kind&quot;: &quot;content#accountsCustomBatchResponseEntry&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accountsCustomBatchResponseEntry`&quot;
326 &quot;linkStatus&quot;: &quot;A String&quot;, # Deprecated. This field is never set.
Dan O'Mearadd494642020-05-01 07:42:23 -0700327 #
328 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700329 # - &quot;`active`&quot;
330 # - &quot;`inactive`&quot;
331 # - &quot;`pending`&quot;
Craig Citro065b5302014-08-14 00:47:23 -0700332 },
333 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700334 &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 -0700335 }</pre>
336</div>
337
338<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700339 <code class="details" id="delete">delete(merchantId, accountId, dryRun=None, force=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700340 <pre>Deletes a Merchant Center sub-account.
Craig Citro065b5302014-08-14 00:47:23 -0700341
342Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700343 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 -0700344 accountId: string, The ID of the account. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700345 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 -0700346 force: boolean, Flag to delete sub-accounts with products. The default value is false.
Craig Citro065b5302014-08-14 00:47:23 -0700347</pre>
348</div>
349
350<div class="method">
351 <code class="details" id="get">get(merchantId, accountId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700352 <pre>Retrieves a Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700353
354Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700355 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 -0700356 accountId: string, The ID of the account. (required)
357
358Returns:
359 An object of the form:
360
Dan O'Mearadd494642020-05-01 07:42:23 -0700361 { # 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 -0700362 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
363 &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.
364 {
365 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
366 &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 -0700367 #
368 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700369 # - &quot;`active`&quot;
370 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700371 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700372 ],
373 &quot;businessInformation&quot;: { # The business information of the account.
374 &quot;address&quot;: { # The address of the business.
375 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
376 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
377 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
378 &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;).
379 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
380 },
381 &quot;customerService&quot;: { # The customer service information of the business.
382 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
383 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
384 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
385 },
386 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
387 },
388 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
389 &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.
390 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
391 #
392 # Acceptable values are:
393 # - &quot;`active`&quot;
394 # - &quot;`pending`&quot;
395 },
396 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
397 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
398 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
399 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
400 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
401 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
402 {
403 &quot;admin&quot;: True or False, # Whether user is an admin.
404 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
405 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
406 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
407 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
408 },
409 ],
410 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
411 &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.
412 {
413 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
414 &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.
415 },
416 ],
417 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700418</div>
419
420<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700421 <code class="details" id="insert">insert(merchantId, body=None, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700422 <pre>Creates a Merchant Center sub-account.
Craig Citro065b5302014-08-14 00:47:23 -0700423
424Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700425 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700426 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700427 The object takes the form of:
428
Dan O'Mearadd494642020-05-01 07:42:23 -0700429{ # 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 -0700430 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
431 &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.
432 {
433 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
434 &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 -0700435 #
436 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700437 # - &quot;`active`&quot;
438 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700439 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700440 ],
441 &quot;businessInformation&quot;: { # The business information of the account.
442 &quot;address&quot;: { # The address of the business.
443 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
444 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
445 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
446 &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;).
447 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
448 },
449 &quot;customerService&quot;: { # The customer service information of the business.
450 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
451 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
452 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
453 },
454 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
455 },
456 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
457 &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.
458 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
459 #
460 # Acceptable values are:
461 # - &quot;`active`&quot;
462 # - &quot;`pending`&quot;
463 },
464 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
465 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
466 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
467 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
468 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
469 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
470 {
471 &quot;admin&quot;: True or False, # Whether user is an admin.
472 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
473 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
474 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
475 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
476 },
477 ],
478 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
479 &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.
480 {
481 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
482 &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.
483 },
484 ],
485}
Craig Citro065b5302014-08-14 00:47:23 -0700486
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700487 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 -0700488
489Returns:
490 An object of the form:
491
Dan O'Mearadd494642020-05-01 07:42:23 -0700492 { # 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 -0700493 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
494 &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.
495 {
496 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
497 &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 -0700498 #
499 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700500 # - &quot;`active`&quot;
501 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700502 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700503 ],
504 &quot;businessInformation&quot;: { # The business information of the account.
505 &quot;address&quot;: { # The address of the business.
506 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
507 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
508 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
509 &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;).
510 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
511 },
512 &quot;customerService&quot;: { # The customer service information of the business.
513 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
514 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
515 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
516 },
517 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
518 },
519 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
520 &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.
521 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
522 #
523 # Acceptable values are:
524 # - &quot;`active`&quot;
525 # - &quot;`pending`&quot;
526 },
527 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
528 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
529 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
530 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
531 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
532 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
533 {
534 &quot;admin&quot;: True or False, # Whether user is an admin.
535 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
536 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
537 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
538 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
539 },
540 ],
541 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
542 &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.
543 {
544 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
545 &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.
546 },
547 ],
548 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700549</div>
550
551<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700552 <code class="details" id="link">link(merchantId, accountId, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700553 <pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Craig Citro065b5302014-08-14 00:47:23 -0700554
555Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700556 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 -0700557 accountId: string, The ID of the account that should be linked. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700558 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700559 The object takes the form of:
560
561{
Bu Sun Kim65020912020-05-20 12:08:20 -0700562 &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 -0700563 #
564 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700565 # - &quot;`approve`&quot;
566 # - &quot;`remove`&quot;
567 # - &quot;`request`&quot;
568 &quot;linkType&quot;: &quot;A String&quot;, # Type of the link between the two accounts.
Dan O'Mearadd494642020-05-01 07:42:23 -0700569 #
570 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700571 # - &quot;`channelPartner`&quot;
572 # - &quot;`eCommercePlatform`&quot;
573 &quot;linkedAccountId&quot;: &quot;A String&quot;, # The ID of the linked account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700574 }
575
576
577Returns:
578 An object of the form:
579
580 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700581 &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 -0700582 }</pre>
583</div>
584
585<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700586 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700587 <pre>Lists the sub-accounts in your Merchant Center account.
588
589Args:
590 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700591 maxResults: integer, The maximum number of accounts to return in the response, used for paging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700592 pageToken: string, The token returned by the previous request.
Craig Citro065b5302014-08-14 00:47:23 -0700593
594Returns:
595 An object of the form:
596
597 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700598 &quot;kind&quot;: &quot;content#accountsListResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsListResponse&quot;.
599 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of accounts.
600 &quot;resources&quot;: [
Dan O'Mearadd494642020-05-01 07:42:23 -0700601 { # 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 -0700602 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
603 &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.
604 {
605 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
606 &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 -0700607 #
608 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700609 # - &quot;`active`&quot;
610 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700611 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700612 ],
613 &quot;businessInformation&quot;: { # The business information of the account.
614 &quot;address&quot;: { # The address of the business.
615 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
616 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
617 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
618 &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;).
619 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
620 },
621 &quot;customerService&quot;: { # The customer service information of the business.
622 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
623 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
624 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
625 },
626 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
Craig Citro065b5302014-08-14 00:47:23 -0700627 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700628 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
629 &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.
630 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
631 #
632 # Acceptable values are:
633 # - &quot;`active`&quot;
634 # - &quot;`pending`&quot;
635 },
636 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
637 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
638 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
639 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
640 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
641 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
642 {
643 &quot;admin&quot;: True or False, # Whether user is an admin.
644 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
645 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
646 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
647 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
648 },
649 ],
650 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
651 &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.
652 {
653 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
654 &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.
655 },
656 ],
657 },
Craig Citro065b5302014-08-14 00:47:23 -0700658 ],
659 }</pre>
660</div>
661
662<div class="method">
663 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
664 <pre>Retrieves the next page of results.
665
666Args:
667 previous_request: The request for the previous page. (required)
668 previous_response: The response from the request for the previous page. (required)
669
670Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700671 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700672 page. Returns None if there are no more items in the collection.
673 </pre>
674</div>
675
676<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700677 <code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700678 <pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
Craig Citro065b5302014-08-14 00:47:23 -0700679
680Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700681 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 -0700682 accountId: string, The ID of the account. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700683 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700684 The object takes the form of:
685
Dan O'Mearadd494642020-05-01 07:42:23 -0700686{ # 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 -0700687 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
688 &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.
689 {
690 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
691 &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 -0700692 #
693 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700694 # - &quot;`active`&quot;
695 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700696 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700697 ],
698 &quot;businessInformation&quot;: { # The business information of the account.
699 &quot;address&quot;: { # The address of the business.
700 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
701 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
702 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
703 &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;).
704 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
705 },
706 &quot;customerService&quot;: { # The customer service information of the business.
707 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
708 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
709 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
710 },
711 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
712 },
713 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
714 &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.
715 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
716 #
717 # Acceptable values are:
718 # - &quot;`active`&quot;
719 # - &quot;`pending`&quot;
720 },
721 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
722 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
723 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
724 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
725 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
726 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
727 {
728 &quot;admin&quot;: True or False, # Whether user is an admin.
729 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
730 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
731 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
732 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
733 },
734 ],
735 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
736 &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.
737 {
738 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
739 &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.
740 },
741 ],
742}
Craig Citro065b5302014-08-14 00:47:23 -0700743
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700744 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 -0700745
746Returns:
747 An object of the form:
748
Dan O'Mearadd494642020-05-01 07:42:23 -0700749 { # 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 -0700750 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
751 &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.
752 {
753 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
754 &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 -0700755 #
756 # Acceptable values are:
Bu Sun Kim65020912020-05-20 12:08:20 -0700757 # - &quot;`active`&quot;
758 # - &quot;`pending`&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700759 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700760 ],
761 &quot;businessInformation&quot;: { # The business information of the account.
762 &quot;address&quot;: { # The address of the business.
763 &quot;country&quot;: &quot;A String&quot;, # CLDR country code (e.g. &quot;US&quot;).
764 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
765 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
766 &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;).
767 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
768 },
769 &quot;customerService&quot;: { # The customer service information of the business.
770 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
771 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
772 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
773 },
774 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
775 },
776 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
777 &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.
778 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account.
779 #
780 # Acceptable values are:
781 # - &quot;`active`&quot;
782 # - &quot;`pending`&quot;
783 },
784 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
785 &quot;kind&quot;: &quot;content#account&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
786 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
787 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
788 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
789 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
790 {
791 &quot;admin&quot;: True or False, # Whether user is an admin.
792 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
793 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
794 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
795 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
796 },
797 ],
798 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
799 &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.
800 {
801 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
802 &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.
803 },
804 ],
805 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700806</div>
807
808</body></html>