1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="merchantapi_accounts_v1.html">Merchant API</a> . <a href="merchantapi_accounts_v1.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1.accounts.services.html">services</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Approve an account service proposal.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve an account service.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List account services for the specified accounts. Supports filtering.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#propose">propose(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Propose an account service.</p>
<p class="toc_element">
<code><a href="#reject">reject(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reject an account service (both proposed and approve services can be rejected).</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
<pre>Approve an account service proposal.
Args:
name: string, Required. The resource name of the account service to approve. Format: `accounts/{account}/services/{service}` (required)
body: object, The request body.
The object takes the form of:
{ # Request to approve an account service.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.
"accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.
},
"accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.
},
"campaignsManagement": { # `CampaignManagement` payload. # Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
},
"externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
"handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
"actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`.
"approvalState": "A String", # Output only. The approval state of this handshake.
},
"localListingManagement": { # `LocalListingManagement` payload. # Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.
},
"mutability": "A String", # Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
"name": "A String", # Identifier. The resource name of the account service. Format: `accounts/{account}/services/{service}`
"productsManagement": { # `ProductsManagement` payload. # Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.
},
"provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
"providerDisplayName": "A String", # Output only. The human-readable display name of the provider account.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieve an account service.
Args:
name: string, Required. The resource name of the account service to get. Format: `accounts/{account}/services/{service}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.
"accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.
},
"accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.
},
"campaignsManagement": { # `CampaignManagement` payload. # Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
},
"externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
"handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
"actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`.
"approvalState": "A String", # Output only. The approval state of this handshake.
},
"localListingManagement": { # `LocalListingManagement` payload. # Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.
},
"mutability": "A String", # Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
"name": "A String", # Identifier. The resource name of the account service. Format: `accounts/{account}/services/{service}`
"productsManagement": { # `ProductsManagement` payload. # Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.
},
"provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
"providerDisplayName": "A String", # Output only. The human-readable display name of the provider account.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List account services for the specified accounts. Supports filtering.
Args:
parent: string, Required. The parent account of the account service to filter by. Format: `accounts/{account}` (required)
pageSize: integer, Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
pageToken: string, Optional. The token returned by the previous `list` request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response after trying to list account services.
"accountServices": [ # The account services that match your filter.
{ # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.
"accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.
},
"accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.
},
"campaignsManagement": { # `CampaignManagement` payload. # Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
},
"externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
"handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
"actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`.
"approvalState": "A String", # Output only. The approval state of this handshake.
},
"localListingManagement": { # `LocalListingManagement` payload. # Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.
},
"mutability": "A String", # Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
"name": "A String", # Identifier. The resource name of the account service. Format: `accounts/{account}/services/{service}`
"productsManagement": { # `ProductsManagement` payload. # Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.
},
"provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
"providerDisplayName": "A String", # Output only. The human-readable display name of the provider account.
},
],
"nextPageToken": "A String", # A page token. You can send the `page_token` to get the next page. Only included in the `list` response if there are more pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="propose">propose(parent, body=None, x__xgafv=None)</code>
<pre>Propose an account service.
Args:
parent: string, Required. The resource name of the parent account for the service. Format: `accounts/{account}` (required)
body: object, The request body.
The object takes the form of:
{ # Request to propose an account service.
"accountService": { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. # Required. The account service to propose.
"accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.
},
"accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.
},
"campaignsManagement": { # `CampaignManagement` payload. # Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
},
"externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
"handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
"actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`.
"approvalState": "A String", # Output only. The approval state of this handshake.
},
"localListingManagement": { # `LocalListingManagement` payload. # Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.
},
"mutability": "A String", # Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
"name": "A String", # Identifier. The resource name of the account service. Format: `accounts/{account}/services/{service}`
"productsManagement": { # `ProductsManagement` payload. # Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.
},
"provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
"providerDisplayName": "A String", # Output only. The human-readable display name of the provider account.
},
"provider": "A String", # Required. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.
"accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is an advanced account, to manage multiple sub-accounts (client accounts). Through this service, the advanced account provider can perform administrative and operational tasks across all linked sub-accounts. This is useful for agencies, aggregators, or large retailers that need centralized control over many Merchant Center accounts.
},
"accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information.
},
"campaignsManagement": { # `CampaignManagement` payload. # Service type for managing advertising campaigns. Grants the provider access to create and manage the business's ad campaigns, including setting up campaigns, adjusting bids, and optimizing performance.
},
"externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider.
"handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved).
"actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`.
"approvalState": "A String", # Output only. The approval state of this handshake.
},
"localListingManagement": { # `LocalListingManagement` payload. # Service type for local listings management. The business group associated with the external account id will be used to provide local inventory to this Merchant Center account.
},
"mutability": "A String", # Output only. Whether the service is mutable (e.g. through Approve / Reject RPCs). A service that was created through another system or API might be immutable.
"name": "A String", # Identifier. The resource name of the account service. Format: `accounts/{account}/services/{service}`
"productsManagement": { # `ProductsManagement` payload. # Service type for managing products. This allows the provider to handle product data on behalf of the business, including reading and writing product listings. It's commonly used when the provider offers inventory management or catalog synchronization services to keep the business's product information up-to-date across platforms.
},
"provider": "A String", # Output only. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`).
"providerDisplayName": "A String", # Output only. The human-readable display name of the provider account.
}</pre>
</div>
<div class="method">
<code class="details" id="reject">reject(name, body=None, x__xgafv=None)</code>
<pre>Reject an account service (both proposed and approve services can be rejected).
Args:
name: string, Required. The resource name of the account service to reject. Format: `accounts/{account}/services/{service}` (required)
body: object, The request body.
The object takes the form of:
{ # Request to reject an account service.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
</body></html>
|
