Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4ba8c235185d73c50911d3e1ef511904b474fee2 / . / docs / dyn / content_v2.accounts.html
blob: 26ac97852106e58e4f1ad035d95ac702a6d48c11 [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>
82<p class="firstline">Claims the website of a Merchant Center sub-account. This method can only be called for multi-client accounts.</p>
83<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]84 <code><a href="#custombatch">custombatch(body, dryRun=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]85<p class="firstline">Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.</p>
86<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]87 <code><a href="#delete">delete(merchantId, accountId, dryRun=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88<p class="firstline">Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts.</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>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]91<p class="firstline">Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]93 <code><a href="#insert">insert(merchantId, body, dryRun=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]94<p class="firstline">Creates a Merchant Center sub-account. This method can only be called for multi-client accounts.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95<p class="toc_element">
96 <code><a href="#list">list(merchantId, pageToken=None, maxResults=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]97<p class="firstline">Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]102 <code><a href="#patch">patch(merchantId, accountId, body, dryRun=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103<p class="firstline">Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]104<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]105 <code><a href="#update">update(merchantId, accountId, body, dryRun=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106<p class="firstline">Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client 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>
133 <pre>Claims the website of a Merchant Center sub-account. This method can only be called for multi-client accounts.
134
135Args:
136 merchantId: string, The ID of the managing account. (required)
137 accountId: string, The ID of the account whose website is claimed. (required)
138 overwrite: boolean, Flag to remove any existing claim on the requested website by another account and replace it with a claim from this account.
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">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]149 <code class="details" id="custombatch">custombatch(body, 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:
153 body: object, The request body. (required)
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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]159 "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]160 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
161 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
162 "name": "A String", # Display name for the account.
163 "adultContent": True or False, # Indicates whether the merchant sells adult content.
164 "id": "A String", # Merchant Center account ID.
165 "websiteUrl": "A String", # The merchant's website.
166 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]167 "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]168 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]169 "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]170 "adwordsId": "A String", # Customer ID of the AdWords account.
171 },
172 ],
173 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
174 {
175 "admin": True or False, # Whether user is an admin.
176 "emailAddress": "A String", # User's email address.
177 },
178 ],
179 },
180 "merchantId": "A String", # The ID of the managing account.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]181 "batchId": 42, # An entry ID, unique within the batch request.
182 "method": "A String",
183 "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.
184 "accountId": "A String", # The ID of the targeted account. Only defined if the method is get, delete or claimwebsite.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]185 },
186 ],
187 }
188
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]189 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]190
191Returns:
192 An object of the form:
193
194 {
195 "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]196 "entries": [ # The result of the execution of the batch requests.
197 { # A batch entry encoding a single non-batch accounts response.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]198 "batchId": 42, # The ID of the request entry this entry responds to.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame^]199 "account": { # Account data. # The retrieved, created, or updated account. Not defined if the method was delete or claimwebsite.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]200 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
201 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
202 "name": "A String", # Display name for the account.
203 "adultContent": True or False, # Indicates whether the merchant sells adult content.
204 "id": "A String", # Merchant Center account ID.
205 "websiteUrl": "A String", # The merchant's website.
206 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]207 "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]208 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]209 "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]210 "adwordsId": "A String", # Customer ID of the AdWords account.
211 },
212 ],
213 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
214 {
215 "admin": True or False, # Whether user is an admin.
216 "emailAddress": "A String", # User's email address.
217 },
218 ],
219 },
220 "errors": { # A list of errors returned by a failed batch entry. # A list of errors defined if and only if the request failed.
221 "message": "A String", # The message of the first error in errors.
222 "code": 42, # The HTTP status of the first error in errors.
223 "errors": [ # A list of errors.
224 { # An error returned by the API.
225 "reason": "A String", # The error code.
226 "domain": "A String", # The domain of the error.
227 "message": "A String", # A description of the error.
228 },
229 ],
230 },
231 "kind": "content#accountsCustomBatchResponseEntry", # Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry".
232 },
233 ],
234 }</pre>
235</div>
236
237<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]238 <code class="details" id="delete">delete(merchantId, accountId, dryRun=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]239 <pre>Deletes a Merchant Center sub-account. This method can only be called for multi-client accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]240
241Args:
242 merchantId: string, The ID of the managing account. (required)
243 accountId: string, The ID of the account. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]244 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245</pre>
246</div>
247
248<div class="method">
249 <code class="details" id="get">get(merchantId, accountId)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]250 <pre>Retrieves a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]251
252Args:
253 merchantId: string, The ID of the managing account. (required)
254 accountId: string, The ID of the account. (required)
255
256Returns:
257 An object of the form:
258
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]259 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
261 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
262 "name": "A String", # Display name for the account.
263 "adultContent": True or False, # Indicates whether the merchant sells adult content.
264 "id": "A String", # Merchant Center account ID.
265 "websiteUrl": "A String", # The merchant's website.
266 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]267 "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]268 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]269 "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]270 "adwordsId": "A String", # Customer ID of the AdWords account.
271 },
272 ],
273 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
274 {
275 "admin": True or False, # Whether user is an admin.
276 "emailAddress": "A String", # User's email address.
277 },
278 ],
279 }</pre>
280</div>
281
282<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]283 <code class="details" id="insert">insert(merchantId, body, dryRun=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]284 <pre>Creates a Merchant Center sub-account. This method can only be called for multi-client accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]285
286Args:
287 merchantId: string, The ID of the managing account. (required)
288 body: object, The request body. (required)
289 The object takes the form of:
290
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]291{ # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]292 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
293 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
294 "name": "A String", # Display name for the account.
295 "adultContent": True or False, # Indicates whether the merchant sells adult content.
296 "id": "A String", # Merchant Center account ID.
297 "websiteUrl": "A String", # The merchant's website.
298 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]299 "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]300 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]301 "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]302 "adwordsId": "A String", # Customer ID of the AdWords account.
303 },
304 ],
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.
308 "emailAddress": "A String", # User's email address.
309 },
310 ],
311 }
312
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]313 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]314
315Returns:
316 An object of the form:
317
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]318 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]319 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
320 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
321 "name": "A String", # Display name for the account.
322 "adultContent": True or False, # Indicates whether the merchant sells adult content.
323 "id": "A String", # Merchant Center account ID.
324 "websiteUrl": "A String", # The merchant's website.
325 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]326 "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]327 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]328 "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]329 "adwordsId": "A String", # Customer ID of the AdWords account.
330 },
331 ],
332 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
333 {
334 "admin": True or False, # Whether user is an admin.
335 "emailAddress": "A String", # User's email address.
336 },
337 ],
338 }</pre>
339</div>
340
341<div class="method">
342 <code class="details" id="list">list(merchantId, pageToken=None, maxResults=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]343 <pre>Lists the sub-accounts in your Merchant Center account. This method can only be called for multi-client accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]344
345Args:
346 merchantId: string, The ID of the managing account. (required)
347 pageToken: string, The token returned by the previous request.
348 maxResults: integer, The maximum number of accounts to return in the response, used for paging.
349
350Returns:
351 An object of the form:
352
353 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]354 "nextPageToken": "A String", # The token for the retrieval of the next page of accounts.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]355 "kind": "content#accountsListResponse", # Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse".
356 "resources": [
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]357 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]358 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
359 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
360 "name": "A String", # Display name for the account.
361 "adultContent": True or False, # Indicates whether the merchant sells adult content.
362 "id": "A String", # Merchant Center account ID.
363 "websiteUrl": "A String", # The merchant's website.
364 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]365 "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]366 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]367 "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]368 "adwordsId": "A String", # Customer ID of the AdWords account.
369 },
370 ],
371 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
372 {
373 "admin": True or False, # Whether user is an admin.
374 "emailAddress": "A String", # User's email address.
375 },
376 ],
377 },
378 ],
379 }</pre>
380</div>
381
382<div class="method">
383 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
384 <pre>Retrieves the next page of results.
385
386Args:
387 previous_request: The request for the previous page. (required)
388 previous_response: The response from the request for the previous page. (required)
389
390Returns:
391 A request object that you can call 'execute()' on to request the next
392 page. Returns None if there are no more items in the collection.
393 </pre>
394</div>
395
396<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]397 <code class="details" id="patch">patch(merchantId, accountId, body, dryRun=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]398 <pre>Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account. This method supports patch semantics.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]399
400Args:
401 merchantId: string, The ID of the managing account. (required)
402 accountId: string, The ID of the account. (required)
403 body: object, The request body. (required)
404 The object takes the form of:
405
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]406{ # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]407 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
408 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
409 "name": "A String", # Display name for the account.
410 "adultContent": True or False, # Indicates whether the merchant sells adult content.
411 "id": "A String", # Merchant Center account ID.
412 "websiteUrl": "A String", # The merchant's website.
413 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]414 "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]415 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]416 "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]417 "adwordsId": "A String", # Customer ID of the AdWords account.
418 },
419 ],
420 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
421 {
422 "admin": True or False, # Whether user is an admin.
423 "emailAddress": "A String", # User's email address.
424 },
425 ],
426 }
427
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]428 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]429
430Returns:
431 An object of the form:
432
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]433 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]434 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
435 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
436 "name": "A String", # Display name for the account.
437 "adultContent": True or False, # Indicates whether the merchant sells adult content.
438 "id": "A String", # Merchant Center account ID.
439 "websiteUrl": "A String", # The merchant's website.
440 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]441 "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]442 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]443 "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]444 "adwordsId": "A String", # Customer ID of the AdWords account.
445 },
446 ],
447 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
448 {
449 "admin": True or False, # Whether user is an admin.
450 "emailAddress": "A String", # User's email address.
451 },
452 ],
453 }</pre>
454</div>
455
456<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]457 <code class="details" id="update">update(merchantId, accountId, body, dryRun=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]458 <pre>Updates a Merchant Center account. This method can only be called for accounts to which the managing account has access: either the managing account itself or sub-accounts if the managing account is a multi-client account.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]459
460Args:
461 merchantId: string, The ID of the managing account. (required)
462 accountId: string, The ID of the account. (required)
463 body: object, The request body. (required)
464 The object takes the form of:
465
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]466{ # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]467 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
468 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
469 "name": "A String", # Display name for the account.
470 "adultContent": True or False, # Indicates whether the merchant sells adult content.
471 "id": "A String", # Merchant Center account ID.
472 "websiteUrl": "A String", # The merchant's website.
473 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]474 "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]475 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]476 "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]477 "adwordsId": "A String", # Customer ID of the AdWords account.
478 },
479 ],
480 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
481 {
482 "admin": True or False, # Whether user is an admin.
483 "emailAddress": "A String", # User's email address.
484 },
485 ],
486 }
487
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]488 dryRun: boolean, Flag to run the request in dry-run mode.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]489
490Returns:
491 An object of the form:
492
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]493 { # Account data.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]494 "reviewsUrl": "A String", # URL for individual seller reviews, i.e., reviews for each child account.
495 "kind": "content#account", # Identifies what kind of resource this is. Value: the fixed string "content#account".
496 "name": "A String", # Display name for the account.
497 "adultContent": True or False, # Indicates whether the merchant sells adult content.
498 "id": "A String", # Merchant Center account ID.
499 "websiteUrl": "A String", # The merchant's website.
500 "sellerId": "A String", # Client-specific, locally-unique, internal ID for the child account.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]501 "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]502 {
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]503 "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]504 "adwordsId": "A String", # Customer ID of the AdWords account.
505 },
506 ],
507 "users": [ # Users with access to the account. Every account (except for subaccounts) must have at least one admin user.
508 {
509 "admin": True or False, # Whether user is an admin.
510 "emailAddress": "A String", # User's email address.
511 },
512 ],
513 }</pre>
514</div>
515
516</body></html>