Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c1f8beda2812f174908cf495687a15638482e309 / . / docs / dyn / content_v2.accounts.html
blob: 061adcdfba3d9c647821395963d28fbcf504279a [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">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]81 <code><a href="#custombatch">custombatch(body)</a></code></p>
82<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(merchantId, accountId)</a></code></p>
85<p class="firstline">Deletes a Merchant Center sub-account.</p>
86<p class="toc_element">
87 <code><a href="#get">get(merchantId, accountId)</a></code></p>
88<p class="firstline">Retrieves a Merchant Center account.</p>
89<p class="toc_element">
90 <code><a href="#insert">insert(merchantId, body)</a></code></p>
91<p class="firstline">Creates a Merchant Center sub-account.</p>
92<p class="toc_element">
93 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
94<p class="firstline">Lists the sub-accounts in your Merchant Center account.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99 <code><a href="#patch">patch(merchantId, accountId, body)</a></code></p>
100<p class="firstline">Updates a Merchant Center account. This method supports patch semantics.</p>
101<p class="toc_element">
102 <code><a href="#update">update(merchantId, accountId, body)</a></code></p>
103<p class="firstline">Updates a Merchant Center account.</p>
104<h3>Method Details</h3>
105<div class="method">
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]106 <code class="details" id="authinfo">authinfo()</code>
107 <pre>Returns information about the authenticated user.
108
109Args:
110
111Returns:
112 An object of the form:
113
114 {
115 "kind": "content#accountsAuthInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsAuthInfoResponse".
116 "accountIdentifiers": [ # The account identifiers corresponding to the authenticated user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]117 # - For an individual account: only the merchant ID is defined
118 # - For an aggregator: only the aggregator ID is defined
119 # - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined.
120 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]121 "aggregatorId": "A String", # The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).
122 "merchantId": "A String", # The merchant account ID, set for individual accounts and subaccounts.
123 },
124 ],
125 }</pre>
126</div>
127
128<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]129 <code class="details" id="custombatch">custombatch(body)</code>
130 <pre>Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.
131
132Args:
133 body: object, The request body. (required)
134 The object takes the form of:
135
136{
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 "entries": [ # The request entries to be processed in the batch.
138 { # A batch entry encoding a single non-batch accounts request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 "batchId": 42, # An entry ID, unique within the batch request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]140 "method": "A String",
141 "account": { # Account data. # The account to create or update. Only defined if the method is insert or update.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
143 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
144 "name": "A String", # Display name for the account.
145 "adultContent": True or False, # Indicates whether the merchant sells adult content.
146 "id": "A String", # Merchant Center account ID.
147 "websiteUrl": "A String", # The merchant's website.
148 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]149 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]150 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]151 "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]152 "adwordsId": "A String", # Customer ID of the AdWords account.
153 },
154 ],
155 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
156 {
157 "admin": True or False, # Whether user is an admin.
158 "emailAddress": "A String", # User's email address.
159 },
160 ],
161 },
162 "merchantId": "A String", # The ID of the managing account.
163 "accountId": "A String", # The ID of the account to get or delete. Only defined if the method is get or delete.
164 },
165 ],
166 }
167
168
169Returns:
170 An object of the form:
171
172 {
173 "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]174 "entries": [ # The result of the execution of the batch requests.
175 { # A batch entry encoding a single non-batch accounts response.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]176 "batchId": 42, # The ID of the request entry this entry responds to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]177 "account": { # Account data. # The retrieved, created, or updated account. Not defined if the method was delete.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]178 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
179 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
180 "name": "A String", # Display name for the account.
181 "adultContent": True or False, # Indicates whether the merchant sells adult content.
182 "id": "A String", # Merchant Center account ID.
183 "websiteUrl": "A String", # The merchant's website.
184 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]185 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]186 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]187 "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]188 "adwordsId": "A String", # Customer ID of the AdWords account.
189 },
190 ],
191 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
192 {
193 "admin": True or False, # Whether user is an admin.
194 "emailAddress": "A String", # User's email address.
195 },
196 ],
197 },
198 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
199 "message": "A String", # The message of the first error in errors.
200 "code": 42, # The HTTP status of the first error in errors.
201 "errors": [ # A list of errors.
202 { # An error returned by the API.
203 "reason": "A String", # The error code.
204 "domain": "A String", # The domain of the error.
205 "message": "A String", # A description of the error.
206 },
207 ],
208 },
209 "kind": "content#accountsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry".
210 },
211 ],
212 }</pre>
213</div>
214
215<div class="method">
216 <code class="details" id="delete">delete(merchantId, accountId)</code>
217 <pre>Deletes a Merchant Center sub-account.
218
219Args:
220 merchantId: string, The ID of the managing account. (required)
221 accountId: string, The ID of the account. (required)
222</pre>
223</div>
224
225<div class="method">
226 <code class="details" id="get">get(merchantId, accountId)</code>
227 <pre>Retrieves a Merchant Center account.
228
229Args:
230 merchantId: string, The ID of the managing account. (required)
231 accountId: string, The ID of the account. (required)
232
233Returns:
234 An object of the form:
235
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]236 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]237 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
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.
240 "adultContent": True or False, # Indicates whether the merchant sells adult content.
241 "id": "A String", # Merchant Center account ID.
242 "websiteUrl": "A String", # The merchant's website.
243 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]244 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]245 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]246 "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]247 "adwordsId": "A String", # Customer ID of the AdWords account.
248 },
249 ],
250 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
251 {
252 "admin": True or False, # Whether user is an admin.
253 "emailAddress": "A String", # User's email address.
254 },
255 ],
256 }</pre>
257</div>
258
259<div class="method">
260 <code class="details" id="insert">insert(merchantId, body)</code>
261 <pre>Creates a Merchant Center sub-account.
262
263Args:
264 merchantId: string, The ID of the managing account. (required)
265 body: object, The request body. (required)
266 The object takes the form of:
267
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]268{ # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]269 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
270 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
271 "name": "A String", # Display name for the account.
272 "adultContent": True or False, # Indicates whether the merchant sells adult content.
273 "id": "A String", # Merchant Center account ID.
274 "websiteUrl": "A String", # The merchant's website.
275 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]276 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]277 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]278 "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]279 "adwordsId": "A String", # Customer ID of the AdWords account.
280 },
281 ],
282 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
283 {
284 "admin": True or False, # Whether user is an admin.
285 "emailAddress": "A String", # User's email address.
286 },
287 ],
288 }
289
290
291Returns:
292 An object of the form:
293
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]294 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]295 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
296 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
297 "name": "A String", # Display name for the account.
298 "adultContent": True or False, # Indicates whether the merchant sells adult content.
299 "id": "A String", # Merchant Center account ID.
300 "websiteUrl": "A String", # The merchant's website.
301 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]302 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]303 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]304 "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]305 "adwordsId": "A String", # Customer ID of the AdWords account.
306 },
307 ],
308 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
309 {
310 "admin": True or False, # Whether user is an admin.
311 "emailAddress": "A String", # User's email address.
312 },
313 ],
314 }</pre>
315</div>
316
317<div class="method">
318 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
319 <pre>Lists the sub-accounts in your Merchant Center account.
320
321Args:
322 merchantId: string, The ID of the managing account. (required)
323 pageToken: string, The token returned by the previous request.
324 maxResults: integer, The maximum number of accounts to return in the response, used for paging.
325
326Returns:
327 An object of the form:
328
329 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]330 "nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]331 "kind": "content#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
332 "resources": [
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]333 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]334 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
335 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
336 "name": "A String", # Display name for the account.
337 "adultContent": True or False, # Indicates whether the merchant sells adult content.
338 "id": "A String", # Merchant Center account ID.
339 "websiteUrl": "A String", # The merchant's website.
340 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]341 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]342 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]343 "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]344 "adwordsId": "A String", # Customer ID of the AdWords account.
345 },
346 ],
347 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
348 {
349 "admin": True or False, # Whether user is an admin.
350 "emailAddress": "A String", # User's email address.
351 },
352 ],
353 },
354 ],
355 }</pre>
356</div>
357
358<div class="method">
359 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
360 <pre>Retrieves the next page of results.
361
362Args:
363 previous_request: The request for the previous page. (required)
364 previous_response: The response from the request for the previous page. (required)
365
366Returns:
367 A request object that you can call 'execute()' on to request the next
368 page. Returns None if there are no more items in the collection.
369 </pre>
370</div>
371
372<div class="method">
373 <code class="details" id="patch">patch(merchantId, accountId, body)</code>
374 <pre>Updates a Merchant Center account. This method supports patch semantics.
375
376Args:
377 merchantId: string, The ID of the managing account. (required)
378 accountId: string, The ID of the account. (required)
379 body: object, The request body. (required)
380 The object takes the form of:
381
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]382{ # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]383 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
384 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
385 "name": "A String", # Display name for the account.
386 "adultContent": True or False, # Indicates whether the merchant sells adult content.
387 "id": "A String", # Merchant Center account ID.
388 "websiteUrl": "A String", # The merchant's website.
389 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]390 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]391 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]392 "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]393 "adwordsId": "A String", # Customer ID of the AdWords account.
394 },
395 ],
396 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
397 {
398 "admin": True or False, # Whether user is an admin.
399 "emailAddress": "A String", # User's email address.
400 },
401 ],
402 }
403
404
405Returns:
406 An object of the form:
407
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]408 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]409 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
410 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
411 "name": "A String", # Display name for the account.
412 "adultContent": True or False, # Indicates whether the merchant sells adult content.
413 "id": "A String", # Merchant Center account ID.
414 "websiteUrl": "A String", # The merchant's website.
415 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]416 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]417 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]418 "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]419 "adwordsId": "A String", # Customer ID of the AdWords account.
420 },
421 ],
422 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
423 {
424 "admin": True or False, # Whether user is an admin.
425 "emailAddress": "A String", # User's email address.
426 },
427 ],
428 }</pre>
429</div>
430
431<div class="method">
432 <code class="details" id="update">update(merchantId, accountId, body)</code>
433 <pre>Updates a Merchant Center account.
434
435Args:
436 merchantId: string, The ID of the managing account. (required)
437 accountId: string, The ID of the account. (required)
438 body: object, The request body. (required)
439 The object takes the form of:
440
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]441{ # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]442 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
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.
445 "adultContent": True or False, # Indicates whether the merchant sells adult content.
446 "id": "A String", # Merchant Center account ID.
447 "websiteUrl": "A String", # The merchant's website.
448 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]449 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]450 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]451 "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]452 "adwordsId": "A String", # Customer ID of the AdWords account.
453 },
454 ],
455 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
456 {
457 "admin": True or False, # Whether user is an admin.
458 "emailAddress": "A String", # User's email address.
459 },
460 ],
461 }
462
463
464Returns:
465 An object of the form:
466
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]467 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]468 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
469 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
470 "name": "A String", # Display name for the account.
471 "adultContent": True or False, # Indicates whether the merchant sells adult content.
472 "id": "A String", # Merchant Center account ID.
473 "websiteUrl": "A String", # The merchant's website.
474 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]475 "adwordsLinks": [ # List of linked AdWords accounts, active or pending approval. To create a new link request, add a new link with status active to the list. It will remain is state pending until approved or rejected in the AdWords interface. 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]476 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]477 "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]478 "adwordsId": "A String", # Customer ID of the AdWords account.
479 },
480 ],
481 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
482 {
483 "admin": True or False, # Whether user is an admin.
484 "emailAddress": "A String", # User's email address.
485 },
486 ],
487 }</pre>
488</div>
489
490</body></html>