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