Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / content_v2.accounts.html
blob: 83b5605f6b68f87689f5020861dd86515bd3c45c [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="content_v2.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 +0000[diff] [blame]78 <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 -0400[diff] [blame]81 <code><a href="#claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]82<p class="firstline">Claims the website of a Merchant Center sub-account.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]83<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]84 <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]85<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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]87 <code><a href="#delete">delete(merchantId, accountId, force=None, dryRun=None)</a></code></p>
88<p class="firstline">Deletes a Merchant Center sub-account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]89<p class="toc_element">
90 <code><a href="#get">get(merchantId, accountId)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]91<p class="firstline">Retrieves a Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93 <code><a href="#insert">insert(merchantId, body, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]94<p class="firstline">Creates a Merchant Center sub-account.</p>
95<p class="toc_element">
96 <code><a href="#link">link(merchantId, accountId, body)</a></code></p>
97<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 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]100<p class="firstline">Lists the sub-accounts in your Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101<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">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]105 <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]106<p class="firstline">Updates a Merchant Center account. This method supports patch semantics.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]107<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]108 <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]109<p class="firstline">Updates a Merchant Center account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]112 <code class="details" id="authinfo">authinfo()</code>
113 <pre>Returns information about the authenticated user.
114
115Args:
116
117Returns:
118 An object of the form:
119
120 {
121 "kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
122 "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]123 # - For an individual account: only the merchant ID is defined
124 # - For an aggregator: only the aggregator ID is defined
125 # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
126 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]127 "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
128 "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
129 },
130 ],
131 }</pre>
132</div>
133
134<div class="method">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]135 <code class="details" id="claimwebsite">claimwebsite(merchantId, accountId, overwrite=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]136 <pre>Claims the website of a Merchant Center sub-account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]137
138Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]139 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 -0400[diff] [blame]140 accountId: string, The ID of the account whose website is claimed. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]141 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 -0400[diff] [blame]142
143Returns:
144 An object of the form:
145
146 {
147 "kind": "content#accountsClaimWebsiteResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsClaimWebsiteResponse".
148 }</pre>
149</div>
150
151<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152 <code class="details" id="custombatch">custombatch(body, dryRun=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]153 <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
154
155Args:
156 body: object, The request body. (required)
157 The object takes the form of:
158
159{
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]160 "entries": [ # The request entries to be processed in the batch.
161 { # A batch entry encoding a single non-batch accounts request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]162 "linkRequest": { # Details about the link request.
163 "action": "A String", # Action to perform for this link. The "request" action is only available to select merchants.
164 "linkType": "A String", # Type of the link between the two accounts.
165 "linkedAccountId": "A String", # The ID of the linked account.
166 },
167 "account": { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role. # The account to create or update. Only defined if the method is insert or update.
168 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]169 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
170 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]171 "youtubeChannelLinks": [ # 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.
172 {
173 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
174 "channelId": "A String", # Channel ID.
175 },
176 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]177 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]178 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]179 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]180 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]181 "adwordsId": "A String", # Customer ID of the AdWords account.
182 },
183 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]184 "websiteUrl": "A String", # The merchant's website.
185 "businessInformation": { # The business information of the account.
186 "phoneNumber": "A String", # The phone number of the business.
187 "customerService": { # The customer service information of the business.
188 "url": "A String", # Customer service URL.
189 "phoneNumber": "A String", # Customer service phone number.
190 "email": "A String", # Customer service email.
191 },
192 "address": { # The address of the business.
193 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
194 "country": "A String", # CLDR country code (e.g. "US").
195 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
196 "streetAddress": "A String", # Street-level part of the address.
197 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
198 },
199 },
200 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
201 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
202 "gmbEmail": "A String", # 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.
203 },
204 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
205 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]206 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
207 {
208 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]209 "orderManager": True or False, # Whether user is an order manager.
210 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]211 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]212 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]213 },
214 ],
215 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]216 "force": True or False, # Whether the account should be deleted if the account has offers. Only applicable if the method is delete.
217 "method": "A String", # The method of the batch entry.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]218 "batchId": 42, # An entry ID, unique within the batch request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]219 "merchantId": "A String", # The ID of the managing account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]220 "overwrite": 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]221 "accountId": "A String", # The ID of the targeted account. Only defined if the method is not insert.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 },
223 ],
224 }
225
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]226 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 -0700[diff] [blame]227
228Returns:
229 An object of the form:
230
231 {
232 "kind": "content#accountsCustomBatchResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponse".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]233 "entries": [ # The result of the execution of the batch requests.
234 { # A batch entry encoding a single non-batch accounts response.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]235 "batchId": 42, # The ID of the request entry this entry responds to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]236 "account": { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role. # The retrieved, created, or updated account. Not defined if the method was delete, claimwebsite or link.
237 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]238 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
239 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]240 "youtubeChannelLinks": [ # 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.
241 {
242 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
243 "channelId": "A String", # Channel ID.
244 },
245 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]246 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]247 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]248 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]249 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]250 "adwordsId": "A String", # Customer ID of the AdWords account.
251 },
252 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]253 "websiteUrl": "A String", # The merchant's website.
254 "businessInformation": { # The business information of the account.
255 "phoneNumber": "A String", # The phone number of the business.
256 "customerService": { # The customer service information of the business.
257 "url": "A String", # Customer service URL.
258 "phoneNumber": "A String", # Customer service phone number.
259 "email": "A String", # Customer service email.
260 },
261 "address": { # The address of the business.
262 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
263 "country": "A String", # CLDR country code (e.g. "US").
264 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
265 "streetAddress": "A String", # Street-level part of the address.
266 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
267 },
268 },
269 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
270 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
271 "gmbEmail": "A String", # 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.
272 },
273 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
274 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]275 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
276 {
277 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]278 "orderManager": True or False, # Whether user is an order manager.
279 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]280 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]281 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]282 },
283 ],
284 },
285 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
286 "message": "A String", # The message of the first error in errors.
287 "code": 42, # The HTTP status of the first error in errors.
288 "errors": [ # A list of errors.
289 { # An error returned by the API.
290 "reason": "A String", # The error code.
291 "domain": "A String", # The domain of the error.
292 "message": "A String", # A description of the error.
293 },
294 ],
295 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]296 "linkStatus": "A String", # Deprecated. This field is never set.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]297 "kind": "content#accountsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry".
298 },
299 ],
300 }</pre>
301</div>
302
303<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]304 <code class="details" id="delete">delete(merchantId, accountId, force=None, dryRun=None)</code>
305 <pre>Deletes a Merchant Center sub-account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]306
307Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]308 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 -0700[diff] [blame]309 accountId: string, The ID of the account. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]310 force: boolean, Flag to delete sub-accounts with products. The default value is false.
311 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 -0700[diff] [blame]312</pre>
313</div>
314
315<div class="method">
316 <code class="details" id="get">get(merchantId, accountId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]317 <pre>Retrieves a Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]318
319Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]320 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 -0700[diff] [blame]321 accountId: string, The ID of the account. (required)
322
323Returns:
324 An object of the form:
325
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]326 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
327 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]328 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
329 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]330 "youtubeChannelLinks": [ # 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.
331 {
332 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
333 "channelId": "A String", # Channel ID.
334 },
335 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]336 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]337 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]338 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]339 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]340 "adwordsId": "A String", # Customer ID of the AdWords account.
341 },
342 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]343 "websiteUrl": "A String", # The merchant's website.
344 "businessInformation": { # The business information of the account.
345 "phoneNumber": "A String", # The phone number of the business.
346 "customerService": { # The customer service information of the business.
347 "url": "A String", # Customer service URL.
348 "phoneNumber": "A String", # Customer service phone number.
349 "email": "A String", # Customer service email.
350 },
351 "address": { # The address of the business.
352 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
353 "country": "A String", # CLDR country code (e.g. "US").
354 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
355 "streetAddress": "A String", # Street-level part of the address.
356 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
357 },
358 },
359 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
360 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
361 "gmbEmail": "A String", # 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.
362 },
363 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
364 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]365 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
366 {
367 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]368 "orderManager": True or False, # Whether user is an order manager.
369 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]370 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]371 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]372 },
373 ],
374 }</pre>
375</div>
376
377<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]378 <code class="details" id="insert">insert(merchantId, body, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]379 <pre>Creates a Merchant Center sub-account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]380
381Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]382 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]383 body: object, The request body. (required)
384 The object takes the form of:
385
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]386{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
387 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]388 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
389 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]390 "youtubeChannelLinks": [ # 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.
391 {
392 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
393 "channelId": "A String", # Channel ID.
394 },
395 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]396 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]397 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]398 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]399 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]400 "adwordsId": "A String", # Customer ID of the AdWords account.
401 },
402 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]403 "websiteUrl": "A String", # The merchant's website.
404 "businessInformation": { # The business information of the account.
405 "phoneNumber": "A String", # The phone number of the business.
406 "customerService": { # The customer service information of the business.
407 "url": "A String", # Customer service URL.
408 "phoneNumber": "A String", # Customer service phone number.
409 "email": "A String", # Customer service email.
410 },
411 "address": { # The address of the business.
412 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
413 "country": "A String", # CLDR country code (e.g. "US").
414 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
415 "streetAddress": "A String", # Street-level part of the address.
416 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
417 },
418 },
419 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
420 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
421 "gmbEmail": "A String", # 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.
422 },
423 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
424 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]425 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
426 {
427 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]428 "orderManager": True or False, # Whether user is an order manager.
429 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]430 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]431 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]432 },
433 ],
434 }
435
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]436 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 -0700[diff] [blame]437
438Returns:
439 An object of the form:
440
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]441 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
442 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]443 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
444 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]445 "youtubeChannelLinks": [ # 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.
446 {
447 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
448 "channelId": "A String", # Channel ID.
449 },
450 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]451 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]452 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]453 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]454 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]455 "adwordsId": "A String", # Customer ID of the AdWords account.
456 },
457 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]458 "websiteUrl": "A String", # The merchant's website.
459 "businessInformation": { # The business information of the account.
460 "phoneNumber": "A String", # The phone number of the business.
461 "customerService": { # The customer service information of the business.
462 "url": "A String", # Customer service URL.
463 "phoneNumber": "A String", # Customer service phone number.
464 "email": "A String", # Customer service email.
465 },
466 "address": { # The address of the business.
467 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
468 "country": "A String", # CLDR country code (e.g. "US").
469 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
470 "streetAddress": "A String", # Street-level part of the address.
471 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
472 },
473 },
474 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
475 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
476 "gmbEmail": "A String", # 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.
477 },
478 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
479 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]480 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
481 {
482 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]483 "orderManager": True or False, # Whether user is an order manager.
484 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]485 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]486 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]487 },
488 ],
489 }</pre>
490</div>
491
492<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]493 <code class="details" id="link">link(merchantId, accountId, body)</code>
494 <pre>Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]495
496Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]497 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)
498 accountId: string, The ID of the account that should be linked. (required)
499 body: object, The request body. (required)
500 The object takes the form of:
501
502{
503 "action": "A String", # Action to perform for this link. The "request" action is only available to select merchants.
504 "linkType": "A String", # Type of the link between the two accounts.
505 "linkedAccountId": "A String", # The ID of the linked account.
506 }
507
508
509Returns:
510 An object of the form:
511
512 {
513 "kind": "content#accountsLinkResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsLinkResponse".
514 }</pre>
515</div>
516
517<div class="method">
518 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
519 <pre>Lists the sub-accounts in your Merchant Center account.
520
521Args:
522 merchantId: string, The ID of the managing account. This must be a multi-client account. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]523 pageToken: string, The token returned by the previous request.
524 maxResults: integer, The maximum number of accounts to return in the response, used for paging.
525
526Returns:
527 An object of the form:
528
529 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]530 "nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]531 "kind": "content#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
532 "resources": [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]533 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
534 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]535 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
536 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]537 "youtubeChannelLinks": [ # 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.
538 {
539 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
540 "channelId": "A String", # Channel ID.
541 },
542 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]543 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]544 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]545 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]546 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]547 "adwordsId": "A String", # Customer ID of the AdWords account.
548 },
549 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]550 "websiteUrl": "A String", # The merchant's website.
551 "businessInformation": { # The business information of the account.
552 "phoneNumber": "A String", # The phone number of the business.
553 "customerService": { # The customer service information of the business.
554 "url": "A String", # Customer service URL.
555 "phoneNumber": "A String", # Customer service phone number.
556 "email": "A String", # Customer service email.
557 },
558 "address": { # The address of the business.
559 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
560 "country": "A String", # CLDR country code (e.g. "US").
561 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
562 "streetAddress": "A String", # Street-level part of the address.
563 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
564 },
565 },
566 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
567 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
568 "gmbEmail": "A String", # 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.
569 },
570 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
571 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]572 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
573 {
574 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]575 "orderManager": True or False, # Whether user is an order manager.
576 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]577 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]578 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]579 },
580 ],
581 },
582 ],
583 }</pre>
584</div>
585
586<div class="method">
587 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
588 <pre>Retrieves the next page of results.
589
590Args:
591 previous_request: The request for the previous page. (required)
592 previous_response: The response from the request for the previous page. (required)
593
594Returns:
595 A request object that you can call 'execute()' on to request the next
596 page. Returns None if there are no more items in the collection.
597 </pre>
598</div>
599
600<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]601 <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]602 <pre>Updates a Merchant Center account. This method supports patch semantics.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]603
604Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]605 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 -0700[diff] [blame]606 accountId: string, The ID of the account. (required)
607 body: object, The request body. (required)
608 The object takes the form of:
609
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]610{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
611 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]612 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
613 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]614 "youtubeChannelLinks": [ # 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.
615 {
616 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
617 "channelId": "A String", # Channel ID.
618 },
619 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]620 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]621 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]622 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]623 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]624 "adwordsId": "A String", # Customer ID of the AdWords account.
625 },
626 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]627 "websiteUrl": "A String", # The merchant's website.
628 "businessInformation": { # The business information of the account.
629 "phoneNumber": "A String", # The phone number of the business.
630 "customerService": { # The customer service information of the business.
631 "url": "A String", # Customer service URL.
632 "phoneNumber": "A String", # Customer service phone number.
633 "email": "A String", # Customer service email.
634 },
635 "address": { # The address of the business.
636 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
637 "country": "A String", # CLDR country code (e.g. "US").
638 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
639 "streetAddress": "A String", # Street-level part of the address.
640 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
641 },
642 },
643 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
644 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
645 "gmbEmail": "A String", # 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.
646 },
647 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
648 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]649 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
650 {
651 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]652 "orderManager": True or False, # Whether user is an order manager.
653 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]654 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]655 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]656 },
657 ],
658 }
659
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]660 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 -0700[diff] [blame]661
662Returns:
663 An object of the form:
664
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]665 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
666 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]667 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
668 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]669 "youtubeChannelLinks": [ # 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.
670 {
671 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
672 "channelId": "A String", # Channel ID.
673 },
674 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]675 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]676 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]677 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]678 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]679 "adwordsId": "A String", # Customer ID of the AdWords account.
680 },
681 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]682 "websiteUrl": "A String", # The merchant's website.
683 "businessInformation": { # The business information of the account.
684 "phoneNumber": "A String", # The phone number of the business.
685 "customerService": { # The customer service information of the business.
686 "url": "A String", # Customer service URL.
687 "phoneNumber": "A String", # Customer service phone number.
688 "email": "A String", # Customer service email.
689 },
690 "address": { # The address of the business.
691 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
692 "country": "A String", # CLDR country code (e.g. "US").
693 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
694 "streetAddress": "A String", # Street-level part of the address.
695 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
696 },
697 },
698 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
699 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
700 "gmbEmail": "A String", # 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.
701 },
702 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
703 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]704 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
705 {
706 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]707 "orderManager": True or False, # Whether user is an order manager.
708 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]709 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]710 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]711 },
712 ],
713 }</pre>
714</div>
715
716<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]717 <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]718 <pre>Updates a Merchant Center account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]719
720Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]721 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 -0700[diff] [blame]722 accountId: string, The ID of the account. (required)
723 body: object, The request body. (required)
724 The object takes the form of:
725
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]726{ # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
727 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]728 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
729 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]730 "youtubeChannelLinks": [ # 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.
731 {
732 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
733 "channelId": "A String", # Channel ID.
734 },
735 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]736 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]737 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]738 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]739 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]740 "adwordsId": "A String", # Customer ID of the AdWords account.
741 },
742 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]743 "websiteUrl": "A String", # The merchant's website.
744 "businessInformation": { # The business information of the account.
745 "phoneNumber": "A String", # The phone number of the business.
746 "customerService": { # The customer service information of the business.
747 "url": "A String", # Customer service URL.
748 "phoneNumber": "A String", # Customer service phone number.
749 "email": "A String", # Customer service email.
750 },
751 "address": { # The address of the business.
752 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
753 "country": "A String", # CLDR country code (e.g. "US").
754 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
755 "streetAddress": "A String", # Street-level part of the address.
756 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
757 },
758 },
759 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
760 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
761 "gmbEmail": "A String", # 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.
762 },
763 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
764 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]765 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
766 {
767 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]768 "orderManager": True or False, # Whether user is an order manager.
769 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]770 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]771 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]772 },
773 ],
774 }
775
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]776 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 -0700[diff] [blame]777
778Returns:
779 An object of the form:
780
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]781 { # Account data. After the creation of a new account it may take a few minutes before it is fully operational. The methods delete, insert, patch, and update require the admin role.
782 "reviewsUrl": "A String", # [DEPRECATED] This field is never returned and will be ignored if provided.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]783 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
784 "name": "A String", # Display name for the account.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]785 "youtubeChannelLinks": [ # 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.
786 {
787 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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.
788 "channelId": "A String", # Channel ID.
789 },
790 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]791 "adultContent": True or False, # Indicates whether the merchant sells adult content.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]792 "adwordsLinks": [ # 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]793 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]794 "status": "A String", # 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's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it'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 -0700[diff] [blame]795 "adwordsId": "A String", # Customer ID of the AdWords account.
796 },
797 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]798 "websiteUrl": "A String", # The merchant's website.
799 "businessInformation": { # The business information of the account.
800 "phoneNumber": "A String", # The phone number of the business.
801 "customerService": { # The customer service information of the business.
802 "url": "A String", # Customer service URL.
803 "phoneNumber": "A String", # Customer service phone number.
804 "email": "A String", # Customer service email.
805 },
806 "address": { # The address of the business.
807 "postalCode": "A String", # Postal code or ZIP (e.g. "94043").
808 "country": "A String", # CLDR country code (e.g. "US").
809 "region": "A String", # Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
810 "streetAddress": "A String", # Street-level part of the address.
811 "locality": "A String", # City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).
812 },
813 },
814 "googleMyBusinessLink": { # The GMB account which is linked or in the process of being linked with the Merchant Center account.
815 "status": "A String", # Status of the link between this Merchant Center account and the GMB account.
816 "gmbEmail": "A String", # 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.
817 },
818 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
819 "id": "A String", # Merchant Center account ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]820 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
821 {
822 "admin": True or False, # Whether user is an admin.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]823 "orderManager": True or False, # Whether user is an order manager.
824 "paymentsAnalyst": True or False, # Whether user can access payment statements.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]825 "emailAddress": "A String", # User's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]826 "paymentsManager": True or False, # Whether user can manage payment settings.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]827 },
828 ],
829 }</pre>
830</div>
831
832</body></html>