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