blob: 729723777502af4aef4a3d1dc911a4f6067af013 [file] [edit]
<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_v1beta.html">Merchant API</a> . <a href="merchantapi_accounts_v1beta.termsOfService.html">termsOfService</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#accept">accept(name, account=None, regionCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Accepts a `TermsOfService`. Executing this method requires admin access.</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">Retrieves the `TermsOfService` associated with the provided version.</p>
<p class="toc_element">
<code><a href="#retrieveLatest">retrieveLatest(kind=None, regionCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the latest version of the `TermsOfService` for a given `kind` and `region_code`.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="accept">accept(name, account=None, regionCode=None, x__xgafv=None)</code>
<pre>Accepts a `TermsOfService`. Executing this method requires admin access.
Args:
name: string, Required. The resource name of the terms of service version. Format: `termsOfService/{version}` (required)
account: string, Required. The account for which to accept the ToS.
regionCode: string, Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
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>
<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>Retrieves the `TermsOfService` associated with the provided version.
Args:
name: string, Required. The resource name of the terms of service version. Format: `termsOfService/{version}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services (see https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.
&quot;external&quot;: True or False, # Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
&quot;fileUri&quot;: &quot;A String&quot;, # URI for terms of service file that needs to be displayed to signing users.
&quot;kind&quot;: &quot;A String&quot;, # The Kind this terms of service version applies to.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the terms of service version. Format: `termsOfService/{version}`
&quot;regionCode&quot;: &quot;A String&quot;, # Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country where the ToS applies specifically to that country or `001` when the same `TermsOfService` can be signed in any country. However note that when signing a ToS that applies globally we still expect that a specific country is provided (this should be merchant business country or program country of participation).
}</pre>
</div>
<div class="method">
<code class="details" id="retrieveLatest">retrieveLatest(kind=None, regionCode=None, x__xgafv=None)</code>
<pre>Retrieves the latest version of the `TermsOfService` for a given `kind` and `region_code`.
Args:
kind: string, Required. The Kind this terms of service version applies to.
Allowed values
TERMS_OF_SERVICE_KIND_UNSPECIFIED - Default value. This value is unused.
MERCHANT_CENTER - Merchant Center application.
regionCode: string, Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services (see https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.
&quot;external&quot;: True or False, # Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API.
&quot;fileUri&quot;: &quot;A String&quot;, # URI for terms of service file that needs to be displayed to signing users.
&quot;kind&quot;: &quot;A String&quot;, # The Kind this terms of service version applies to.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the terms of service version. Format: `termsOfService/{version}`
&quot;regionCode&quot;: &quot;A String&quot;, # Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country where the ToS applies specifically to that country or `001` when the same `TermsOfService` can be signed in any country. However note that when signing a ToS that applies globally we still expect that a specific country is provided (this should be merchant business country or program country of participation).
}</pre>
</div>
</body></html>