Skip to content

Commit 8e00992

Browse files
feat(merchantapi): update the api
#### merchantapi:accounts_v1beta The following keys were added: - resources.accounts.resources.relationships.methods.get (Total Keys: 11) - resources.accounts.resources.relationships.methods.list (Total Keys: 16) - resources.accounts.resources.relationships.methods.patch (Total Keys: 15) - resources.accounts.resources.services.methods.approve (Total Keys: 12) - resources.accounts.resources.services.methods.get (Total Keys: 11) - resources.accounts.resources.services.methods.list (Total Keys: 16) - resources.accounts.resources.services.methods.propose (Total Keys: 12) - resources.accounts.resources.services.methods.reject (Total Keys: 12) - schemas.AcceptTermsOfServiceResponse (Total Keys: 3) - schemas.AccountManagement (Total Keys: 2) - schemas.AccountRelationship (Total Keys: 7) - schemas.AccountService (Total Keys: 16) - schemas.ApproveAccountServiceRequest (Total Keys: 2) - schemas.CampaignsManagement (Total Keys: 2) - schemas.Handshake (Total Keys: 6) - schemas.ListAccountRelationshipsResponse (Total Keys: 5) - schemas.ListAccountServicesResponse (Total Keys: 5) - schemas.ProductsManagement (Total Keys: 2) - schemas.ProposeAccountServiceRequest (Total Keys: 4) - schemas.RejectAccountServiceRequest (Total Keys: 2) The following keys were changed: - resources.termsOfService.methods.accept.httpMethod (Total Keys: 1) - resources.termsOfService.methods.accept.response.$ref (Total Keys: 1)
1 parent fa57493 commit 8e00992

9 files changed

+1030
-21
lines changed

docs/dyn/merchantapi_accounts_v1beta.accounts.html

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,16 @@ <h2>Instance Methods</h2>
124124
</p>
125125
<p class="firstline">Returns the regions Resource.</p>
126126

127+
<p class="toc_element">
128+
<code><a href="merchantapi_accounts_v1beta.accounts.relationships.html">relationships()</a></code>
129+
</p>
130+
<p class="firstline">Returns the relationships Resource.</p>
131+
132+
<p class="toc_element">
133+
<code><a href="merchantapi_accounts_v1beta.accounts.services.html">services()</a></code>
134+
</p>
135+
<p class="firstline">Returns the services Resource.</p>
136+
127137
<p class="toc_element">
128138
<code><a href="merchantapi_accounts_v1beta.accounts.shippingSettings.html">shippingSettings()</a></code>
129139
</p>
@@ -336,7 +346,7 @@ <h3>Method Details</h3>
336346
<pre>List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type=&quot;ACCOUNT_AGGREGATION&quot;))`
337347

338348
Args:
339-
provider: string, Required. The aggregation service provider. Format: `providers/{providerId}` (required)
349+
provider: string, Required. The aggregation service provider. Format: `accounts/{providerId}` (required)
340350
pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
341351
pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
342352
x__xgafv: string, V1 error format.

docs/dyn/merchantapi_accounts_v1beta.accounts.issues.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ <h2>Instance Methods</h2>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
8181
<code><a href="#list">list(parent, languageCode=None, pageSize=None, pageToken=None, timeZone=None, x__xgafv=None)</a></code></p>
82-
<p class="firstline">Lists all account issues of a Merchant Center account.</p>
82+
<p class="firstline">Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually.</p>
8383
<p class="toc_element">
8484
<code><a href="#list_next">list_next()</a></code></p>
8585
<p class="firstline">Retrieves the next page of results.</p>
@@ -91,7 +91,7 @@ <h3>Method Details</h3>
9191

9292
<div class="method">
9393
<code class="details" id="list">list(parent, languageCode=None, pageSize=None, pageToken=None, timeZone=None, x__xgafv=None)</code>
94-
<pre>Lists all account issues of a Merchant Center account.
94+
<pre>Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually.
9595

9696
Args:
9797
parent: string, Required. The parent, which owns this collection of issues. Format: `accounts/{account}` (required)
Lines changed: 196 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,196 @@
1+
<html><body>
2+
<style>
3+
4+
body, 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+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, 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="merchantapi_accounts_v1beta.html">Merchant API</a> . <a href="merchantapi_accounts_v1beta.accounts.html">accounts</a> . <a href="merchantapi_accounts_v1beta.accounts.relationships.html">relationships</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#close">close()</a></code></p>
79+
<p class="firstline">Close httplib2 connections.</p>
80+
<p class="toc_element">
81+
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Retrieve an account relationship.</p>
83+
<p class="toc_element">
84+
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">List account relationships for the specified account.</p>
86+
<p class="toc_element">
87+
<code><a href="#list_next">list_next()</a></code></p>
88+
<p class="firstline">Retrieves the next page of results.</p>
89+
<p class="toc_element">
90+
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Updates the account relationship. Executing this method requires admin access.</p>
92+
<h3>Method Details</h3>
93+
<div class="method">
94+
<code class="details" id="close">close()</code>
95+
<pre>Close httplib2 connections.</pre>
96+
</div>
97+
98+
<div class="method">
99+
<code class="details" id="get">get(name, x__xgafv=None)</code>
100+
<pre>Retrieve an account relationship.
101+
102+
Args:
103+
name: string, Required. The resource name of the account relationship to get. (required)
104+
x__xgafv: string, V1 error format.
105+
Allowed values
106+
1 - v1 error format
107+
2 - v2 error format
108+
109+
Returns:
110+
An object of the form:
111+
112+
{ # The `AccountRelationship` message defines a formal connection between a merchant&#x27;s account and a service provider&#x27;s account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant&#x27;s data relevant to those services. Establishing an account relationship involves linking the merchant&#x27;s account with a provider&#x27;s account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
113+
&quot;accountIdAlias&quot;: &quot;A String&quot;, # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.
114+
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account relationship.
115+
&quot;provider&quot;: &quot;A String&quot;, # Immutable. 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`).
116+
&quot;providerDisplayName&quot;: &quot;A String&quot;, # Output only. The human-readable display name of the provider account.
117+
}</pre>
118+
</div>
119+
120+
<div class="method">
121+
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
122+
<pre>List account relationships for the specified account.
123+
124+
Args:
125+
parent: string, Required. The parent account of the account relationship to filter by. (required)
126+
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`.
127+
pageToken: string, Optional. The token returned by the previous `list` request.
128+
x__xgafv: string, V1 error format.
129+
Allowed values
130+
1 - v1 error format
131+
2 - v2 error format
132+
133+
Returns:
134+
An object of the form:
135+
136+
{ # Response after trying to list account relationships.
137+
&quot;accountRelationships&quot;: [ # The account relationships that match your filter.
138+
{ # The `AccountRelationship` message defines a formal connection between a merchant&#x27;s account and a service provider&#x27;s account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant&#x27;s data relevant to those services. Establishing an account relationship involves linking the merchant&#x27;s account with a provider&#x27;s account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
139+
&quot;accountIdAlias&quot;: &quot;A String&quot;, # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.
140+
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account relationship.
141+
&quot;provider&quot;: &quot;A String&quot;, # Immutable. 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`).
142+
&quot;providerDisplayName&quot;: &quot;A String&quot;, # Output only. The human-readable display name of the provider account.
143+
},
144+
],
145+
&quot;nextPageToken&quot;: &quot;A String&quot;, # 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.
146+
}</pre>
147+
</div>
148+
149+
<div class="method">
150+
<code class="details" id="list_next">list_next()</code>
151+
<pre>Retrieves the next page of results.
152+
153+
Args:
154+
previous_request: The request for the previous page. (required)
155+
previous_response: The response from the request for the previous page. (required)
156+
157+
Returns:
158+
A request object that you can call &#x27;execute()&#x27; on to request the next
159+
page. Returns None if there are no more items in the collection.
160+
</pre>
161+
</div>
162+
163+
<div class="method">
164+
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
165+
<pre>Updates the account relationship. Executing this method requires admin access.
166+
167+
Args:
168+
name: string, Identifier. The resource name of the account relationship. (required)
169+
body: object, The request body.
170+
The object takes the form of:
171+
172+
{ # The `AccountRelationship` message defines a formal connection between a merchant&#x27;s account and a service provider&#x27;s account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant&#x27;s data relevant to those services. Establishing an account relationship involves linking the merchant&#x27;s account with a provider&#x27;s account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
173+
&quot;accountIdAlias&quot;: &quot;A String&quot;, # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.
174+
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account relationship.
175+
&quot;provider&quot;: &quot;A String&quot;, # Immutable. 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`).
176+
&quot;providerDisplayName&quot;: &quot;A String&quot;, # Output only. The human-readable display name of the provider account.
177+
}
178+
179+
updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias`
180+
x__xgafv: string, V1 error format.
181+
Allowed values
182+
1 - v1 error format
183+
2 - v2 error format
184+
185+
Returns:
186+
An object of the form:
187+
188+
{ # The `AccountRelationship` message defines a formal connection between a merchant&#x27;s account and a service provider&#x27;s account. This relationship enables the provider to offer specific services to the merchant, such as product management or campaign management. It specifies the access rights and permissions to the merchant&#x27;s data relevant to those services. Establishing an account relationship involves linking the merchant&#x27;s account with a provider&#x27;s account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).
189+
&quot;accountIdAlias&quot;: &quot;A String&quot;, # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems.
190+
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the account relationship.
191+
&quot;provider&quot;: &quot;A String&quot;, # Immutable. 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`).
192+
&quot;providerDisplayName&quot;: &quot;A String&quot;, # Output only. The human-readable display name of the provider account.
193+
}</pre>
194+
</div>
195+
196+
</body></html>

0 commit comments

Comments
 (0)