Debian Codegraph @

docs/dyn/content_v2.accounts.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">
78 <code><a href="#authinfo">authinfo(x__xgafv=None)</a></code></p>
79 <p class="firstline">Returns information about the authenticated user.</p>
80 <p class="toc_element">
81 <code><a href="#claimwebsite">claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Claims the website of a Merchant Center sub-account.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
89 <p class="toc_element">
90 <code><a href="#delete">delete(merchantId, accountId, dryRun=None, force=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Deletes a Merchant Center sub-account.</p>
92 <p class="toc_element">
93 <code><a href="#get">get(merchantId, accountId, x__xgafv=None)</a></code></p>
94 <p class="firstline">Retrieves a Merchant Center account.</p>
95 <p class="toc_element">
96 <code><a href="#insert">insert(merchantId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a Merchant Center sub-account.</p>
98 <p class="toc_element">
99 <code><a href="#link">link(merchantId, accountId, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.</p>
101 <p class="toc_element">
102 <code><a href="#list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Lists the sub-accounts in your Merchant Center account.</p>
104 <p class="toc_element">
105 <code><a href="#list_next">list_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.</p>
110 <h3>Method Details</h3>
111 <div class="method">
112 <code class="details" id="authinfo">authinfo(x__xgafv=None)</code>
113 <pre>Returns information about the authenticated user.
114
115 Args:
116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
120
121 Returns:
122 An object of the form:
123
124 {
125 &quot;accountIdentifiers&quot;: [ # The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
126 {
127 &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).
128 &quot;merchantId&quot;: &quot;A String&quot;, # The merchant account ID, set for individual accounts and subaccounts.
129 },
130 ],
131 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsAuthInfoResponse&quot;.
132 }</pre>
133 </div>
134
135 <div class="method">
136 <code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None, x__xgafv=None)</code>
137 <pre>Claims the website of a Merchant Center sub-account.
138
139 Args:
140 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)
141 accountId: string, The ID of the account whose website is claimed. (required)
142 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.
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148 Returns:
149 An object of the form:
150
151 {
152 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsClaimWebsiteResponse&quot;.
153 }</pre>
154 </div>
155
156 <div class="method">
157 <code class="details" id="close">close()</code>
158 <pre>Close httplib2 connections.</pre>
159 </div>
160
161 <div class="method">
162 <code class="details" id="custombatch">custombatch(body=None, dryRun=None, x__xgafv=None)</code>
163 <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
164
165 Args:
166 body: object, The request body.
167 The object takes the form of:
168
169 {
170 &quot;entries&quot;: [ # The request entries to be processed in the batch.
171 { # A batch entry encoding a single non-batch accounts request.
172 &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`.
173 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
174 &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.
175 {
176 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
177 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
178 },
179 ],
180 &quot;businessInformation&quot;: { # The business information of the account.
181 &quot;address&quot;: { # The address of the business.
182 &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.
183 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
184 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
185 &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;).
186 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
187 },
188 &quot;customerService&quot;: { # The customer service information of the business.
189 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
190 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
191 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
192 },
193 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
194 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
195 },
196 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
197 &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.
198 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
199 },
200 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
201 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
202 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
203 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
204 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
205 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
206 {
207 &quot;admin&quot;: True or False, # Whether user is an admin.
208 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
209 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
210 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
211 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
212 },
213 ],
214 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
215 &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.
216 {
217 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
218 &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.
219 },
220 ],
221 },
222 &quot;accountId&quot;: &quot;A String&quot;, # The ID of the targeted account. Only defined if the method is not `insert`.
223 &quot;batchId&quot;: 42, # An entry ID, unique within the batch request.
224 &quot;force&quot;: True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.
225 &quot;labelIds&quot;: [ # Label IDs for the &#x27;updatelabels&#x27; request.
226 &quot;A String&quot;,
227 ],
228 &quot;linkRequest&quot;: { # Details about the `link` request.
229 &quot;action&quot;: &quot;A String&quot;, # Action to perform for this link. The `&quot;request&quot;` action is only available to select merchants. Acceptable values are: - &quot;`approve`&quot; - &quot;`remove`&quot; - &quot;`request`&quot;
230 &quot;linkType&quot;: &quot;A String&quot;, # Type of the link between the two accounts. Acceptable values are: - &quot;`channelPartner`&quot; - &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. Acceptable values are: - &quot;`claimWebsite`&quot; - &quot;`delete`&quot; - &quot;`get`&quot; - &quot;`insert`&quot; - &quot;`link`&quot; - &quot;`update`&quot;
235 &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.
236 },
237 ],
238 }
239
240 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).
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246 Returns:
247 An object of the form:
248
249 {
250 &quot;entries&quot;: [ # The result of the execution of the batch requests.
251 { # A batch entry encoding a single non-batch accounts response.
252 &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`.
253 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
254 &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.
255 {
256 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
257 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
258 },
259 ],
260 &quot;businessInformation&quot;: { # The business information of the account.
261 &quot;address&quot;: { # The address of the business.
262 &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.
263 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
264 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
265 &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;).
266 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
267 },
268 &quot;customerService&quot;: { # The customer service information of the business.
269 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
270 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
271 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
272 },
273 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
274 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
275 },
276 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
277 &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.
278 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
279 },
280 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
281 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
282 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
283 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
284 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
285 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
286 {
287 &quot;admin&quot;: True or False, # Whether user is an admin.
288 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
289 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
290 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
291 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
292 },
293 ],
294 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
295 &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.
296 {
297 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
298 &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.
299 },
300 ],
301 },
302 &quot;batchId&quot;: 42, # The ID of the request entry this entry responds to.
303 &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.
304 &quot;code&quot;: 42, # The HTTP status of the first error in `errors`.
305 &quot;errors&quot;: [ # A list of errors.
306 { # An error returned by the API.
307 &quot;domain&quot;: &quot;A String&quot;, # The domain of the error.
308 &quot;message&quot;: &quot;A String&quot;, # A description of the error.
309 &quot;reason&quot;: &quot;A String&quot;, # The error code.
310 },
311 ],
312 &quot;message&quot;: &quot;A String&quot;, # The message of the first error in `errors`.
313 },
314 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#accountsCustomBatchResponseEntry`&quot;
315 &quot;linkStatus&quot;: &quot;A String&quot;, # Deprecated. This field is never set. Acceptable values are: - &quot;`active`&quot; - &quot;`inactive`&quot; - &quot;`pending`&quot;
316 },
317 ],
318 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsCustomBatchResponse&quot;.
319 }</pre>
320 </div>
321
322 <div class="method">
323 <code class="details" id="delete">delete(merchantId, accountId, dryRun=None, force=None, x__xgafv=None)</code>
324 <pre>Deletes a Merchant Center sub-account.
325
326 Args:
327 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)
328 accountId: string, The ID of the account. (required)
329 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).
330 force: boolean, Flag to delete sub-accounts with products. The default value is false.
331 x__xgafv: string, V1 error format.
332 Allowed values
333 1 - v1 error format
334 2 - v2 error format
335 </pre>
336 </div>
337
338 <div class="method">
339 <code class="details" id="get">get(merchantId, accountId, x__xgafv=None)</code>
340 <pre>Retrieves a Merchant Center account.
341
342 Args:
343 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)
344 accountId: string, The ID of the account. (required)
345 x__xgafv: string, V1 error format.
346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
349
350 Returns:
351 An object of the form:
352
353 { # 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.
354 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
355 &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.
356 {
357 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
358 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
359 },
360 ],
361 &quot;businessInformation&quot;: { # The business information of the account.
362 &quot;address&quot;: { # The address of the business.
363 &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.
364 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
365 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
366 &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;).
367 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
368 },
369 &quot;customerService&quot;: { # The customer service information of the business.
370 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
371 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
372 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
373 },
374 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
375 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
376 },
377 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
378 &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.
379 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
380 },
381 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
382 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
383 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
384 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
385 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
386 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
387 {
388 &quot;admin&quot;: True or False, # Whether user is an admin.
389 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
390 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
391 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
392 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
393 },
394 ],
395 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
396 &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.
397 {
398 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
399 &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.
400 },
401 ],
402 }</pre>
403 </div>
404
405 <div class="method">
406 <code class="details" id="insert">insert(merchantId, body=None, dryRun=None, x__xgafv=None)</code>
407 <pre>Creates a Merchant Center sub-account.
408
409 Args:
410 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
411 body: object, The request body.
412 The object takes the form of:
413
414 { # 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.
415 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
416 &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.
417 {
418 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
419 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
420 },
421 ],
422 &quot;businessInformation&quot;: { # The business information of the account.
423 &quot;address&quot;: { # The address of the business.
424 &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.
425 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
426 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
427 &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;).
428 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
429 },
430 &quot;customerService&quot;: { # The customer service information of the business.
431 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
432 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
433 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
434 },
435 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
436 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
437 },
438 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
439 &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.
440 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
441 },
442 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
443 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
444 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
445 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
446 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
447 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
448 {
449 &quot;admin&quot;: True or False, # Whether user is an admin.
450 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
451 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
452 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
453 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
454 },
455 ],
456 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
457 &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.
458 {
459 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
460 &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.
461 },
462 ],
463 }
464
465 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).
466 x__xgafv: string, V1 error format.
467 Allowed values
468 1 - v1 error format
469 2 - v2 error format
470
471 Returns:
472 An object of the form:
473
474 { # 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.
475 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
476 &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.
477 {
478 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
479 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
480 },
481 ],
482 &quot;businessInformation&quot;: { # The business information of the account.
483 &quot;address&quot;: { # The address of the business.
484 &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.
485 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
486 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
487 &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;).
488 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
489 },
490 &quot;customerService&quot;: { # The customer service information of the business.
491 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
492 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
493 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
494 },
495 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
496 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
497 },
498 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
499 &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.
500 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
501 },
502 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
503 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
504 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
505 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
506 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
507 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
508 {
509 &quot;admin&quot;: True or False, # Whether user is an admin.
510 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
511 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
512 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
513 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
514 },
515 ],
516 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
517 &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.
518 {
519 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
520 &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.
521 },
522 ],
523 }</pre>
524 </div>
525
526 <div class="method">
527 <code class="details" id="link">link(merchantId, accountId, body=None, x__xgafv=None)</code>
528 <pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
529
530 Args:
531 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)
532 accountId: string, The ID of the account that should be linked. (required)
533 body: object, The request body.
534 The object takes the form of:
535
536 {
537 &quot;action&quot;: &quot;A String&quot;, # Action to perform for this link. The `&quot;request&quot;` action is only available to select merchants. Acceptable values are: - &quot;`approve`&quot; - &quot;`remove`&quot; - &quot;`request`&quot;
538 &quot;linkType&quot;: &quot;A String&quot;, # Type of the link between the two accounts. Acceptable values are: - &quot;`channelPartner`&quot; - &quot;`eCommercePlatform`&quot;
539 &quot;linkedAccountId&quot;: &quot;A String&quot;, # The ID of the linked account.
540 }
541
542 x__xgafv: string, V1 error format.
543 Allowed values
544 1 - v1 error format
545 2 - v2 error format
546
547 Returns:
548 An object of the form:
549
550 {
551 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsLinkResponse&quot;.
552 }</pre>
553 </div>
554
555 <div class="method">
556 <code class="details" id="list">list(merchantId, maxResults=None, pageToken=None, x__xgafv=None)</code>
557 <pre>Lists the sub-accounts in your Merchant Center account.
558
559 Args:
560 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
561 maxResults: integer, The maximum number of accounts to return in the response, used for paging.
562 pageToken: string, The token returned by the previous request.
563 x__xgafv: string, V1 error format.
564 Allowed values
565 1 - v1 error format
566 2 - v2 error format
567
568 Returns:
569 An object of the form:
570
571 {
572 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;content#accountsListResponse&quot;.
573 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token for the retrieval of the next page of accounts.
574 &quot;resources&quot;: [
575 { # 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.
576 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
577 &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.
578 {
579 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
580 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
581 },
582 ],
583 &quot;businessInformation&quot;: { # The business information of the account.
584 &quot;address&quot;: { # The address of the business.
585 &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.
586 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
587 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
588 &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;).
589 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
590 },
591 &quot;customerService&quot;: { # The customer service information of the business.
592 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
593 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
594 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
595 },
596 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
597 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
598 },
599 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
600 &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.
601 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
602 },
603 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
604 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
605 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
606 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
607 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
608 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
609 {
610 &quot;admin&quot;: True or False, # Whether user is an admin.
611 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
612 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
613 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
614 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
615 },
616 ],
617 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
618 &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.
619 {
620 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
621 &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.
622 },
623 ],
624 },
625 ],
626 }</pre>
627 </div>
628
629 <div class="method">
630 <code class="details" id="list_next">list_next()</code>
631 <pre>Retrieves the next page of results.
632
633 Args:
634 previous_request: The request for the previous page. (required)
635 previous_response: The response from the request for the previous page. (required)
636
637 Returns:
638 A request object that you can call &#x27;execute()&#x27; on to request the next
639 page. Returns None if there are no more items in the collection.
640 </pre>
641 </div>
642
643 <div class="method">
644 <code class="details" id="update">update(merchantId, accountId, body=None, dryRun=None, x__xgafv=None)</code>
645 <pre>Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.
646
647 Args:
648 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)
649 accountId: string, The ID of the account. (required)
650 body: object, The request body.
651 The object takes the form of:
652
653 { # 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.
654 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
655 &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.
656 {
657 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
658 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
659 },
660 ],
661 &quot;businessInformation&quot;: { # The business information of the account.
662 &quot;address&quot;: { # The address of the business.
663 &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.
664 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
665 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
666 &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;).
667 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
668 },
669 &quot;customerService&quot;: { # The customer service information of the business.
670 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
671 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
672 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
673 },
674 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
675 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
676 },
677 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
678 &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.
679 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
680 },
681 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
682 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
683 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
684 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
685 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
686 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
687 {
688 &quot;admin&quot;: True or False, # Whether user is an admin.
689 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
690 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
691 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
692 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
693 },
694 ],
695 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
696 &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.
697 {
698 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
699 &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.
700 },
701 ],
702 }
703
704 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).
705 x__xgafv: string, V1 error format.
706 Allowed values
707 1 - v1 error format
708 2 - v2 error format
709
710 Returns:
711 An object of the form:
712
713 { # 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.
714 &quot;adultContent&quot;: True or False, # Indicates whether the merchant sells adult content.
715 &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.
716 {
717 &quot;adwordsId&quot;: &quot;A String&quot;, # Customer ID of the AdWords account.
718 &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. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
719 },
720 ],
721 &quot;businessInformation&quot;: { # The business information of the account.
722 &quot;address&quot;: { # The address of the business.
723 &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.
724 &quot;locality&quot;: &quot;A String&quot;, # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
725 &quot;postalCode&quot;: &quot;A String&quot;, # Postal code or ZIP (e.g. &quot;94043&quot;).
726 &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;).
727 &quot;streetAddress&quot;: &quot;A String&quot;, # Street-level part of the address.
728 },
729 &quot;customerService&quot;: { # The customer service information of the business.
730 &quot;email&quot;: &quot;A String&quot;, # Customer service email.
731 &quot;phoneNumber&quot;: &quot;A String&quot;, # Customer service phone number.
732 &quot;url&quot;: &quot;A String&quot;, # Customer service URL.
733 },
734 &quot;koreanBusinessRegistrationNumber&quot;: &quot;A String&quot;, # The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.
735 &quot;phoneNumber&quot;: &quot;A String&quot;, # The phone number of the business.
736 },
737 &quot;googleMyBusinessLink&quot;: { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
738 &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.
739 &quot;status&quot;: &quot;A String&quot;, # Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - &quot;`active`&quot; - &quot;`pending`&quot;
740 },
741 &quot;id&quot;: &quot;A String&quot;, # Required for update. Merchant Center account ID.
742 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;`content#account`&quot;
743 &quot;name&quot;: &quot;A String&quot;, # Required. Display name for the account.
744 &quot;reviewsUrl&quot;: &quot;A String&quot;, # [DEPRECATED] This field is never returned and will be ignored if provided.
745 &quot;sellerId&quot;: &quot;A String&quot;, # Client-specific, locally-unique, internal ID for the child account.
746 &quot;users&quot;: [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
747 {
748 &quot;admin&quot;: True or False, # Whether user is an admin.
749 &quot;emailAddress&quot;: &quot;A String&quot;, # User&#x27;s email address.
750 &quot;orderManager&quot;: True or False, # Whether user is an order manager.
751 &quot;paymentsAnalyst&quot;: True or False, # Whether user can access payment statements.
752 &quot;paymentsManager&quot;: True or False, # Whether user can manage payment settings.
753 },
754 ],
755 &quot;websiteUrl&quot;: &quot;A String&quot;, # The merchant&#x27;s website.
756 &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.
757 {
758 &quot;channelId&quot;: &quot;A String&quot;, # Channel ID.
759 &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.
760 },
761 ],
762 }</pre>
763 </div>
764
765 </body></html>