REST Resource: termsOfService
Stay organized with collections
Save and categorize content based on your preferences.
Resource: TermsOfService
The TermsOfService message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see Terms of Service.
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 termsOfService.retrieveLatest, and accept them as required through termsOfService.accept.
| JSON representation |
{
"name": string,
"regionCode": string,
"kind": enum (TermsOfServiceKind),
"external": boolean,
"fileUri": string
} |
| Fields |
name |
string
Identifier. The resource name of the terms of service version. Format: termsOfService/{version}
|
regionCode |
string
Region code as defined by CLDR. 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).
|
kind |
enum (TermsOfServiceKind)
The Kind this terms of service version applies to.
|
external |
boolean
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.
|
fileUri |
string
URI for terms of service file that needs to be displayed to signing users.
|
Methods |
|
|
Accepts a TermsOfService. |
|
|
Retrieves the TermsOfService associated with the provided version. |
|
|
Retrieves the latest version of the TermsOfService for a given kind and region_code. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-08 UTC.
[null,null,["Last updated 2025-04-08 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eTermsOfService\u003c/code\u003e message outlines the legal agreements merchants must accept to use specific features or services.\u003c/p\u003e\n"],["\u003cp\u003eMerchants can access and accept the latest terms of service through dedicated methods like \u003ccode\u003etermsOfService.retrieveLatest\u003c/code\u003e and \u003ccode\u003etermsOfService.accept\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTermsOfService\u003c/code\u003e message includes details like region code, kind, external status, and a file URI for the terms of service document.\u003c/p\u003e\n"],["\u003cp\u003eImportant fields within the \u003ccode\u003eTermsOfService\u003c/code\u003e message include name, region code, kind, external status, and file URI.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods are available for interacting with terms of service, including accepting, retrieving a specific version, and retrieving the latest version.\u003c/p\u003e\n"]]],[],null,["# REST Resource: termsOfService\n\n- [Resource: TermsOfService](#TermsOfService)\n - [JSON representation](#TermsOfService.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: TermsOfService\n------------------------\n\nThe `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173).\n\nThis 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 `termsOfService.retrieveLatest`, and accept them as required through `termsOfService.accept`.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"regionCode\": string, \"kind\": enum (/merchant/api/reference/rest/accounts_v1beta/TermsOfServiceKind), \"external\": boolean, \"fileUri\": string } ``` |\n\n| Fields ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the terms of service version. Format: `termsOfService/{version}` |\n| `regionCode` | `string` 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). |\n| `kind` | `enum (`[TermsOfServiceKind](/merchant/api/reference/rest/accounts_v1beta/TermsOfServiceKind)`)` The Kind this terms of service version applies to. |\n| `external` | `boolean` 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. |\n| `fileUri` | `string` URI for terms of service file that needs to be displayed to signing users. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n| ### [accept](/merchant/api/reference/rest/accounts_v1beta/termsOfService/accept) | Accepts a `TermsOfService`. |\n| ### [get](/merchant/api/reference/rest/accounts_v1beta/termsOfService/get) | Retrieves the `TermsOfService` associated with the provided version. |\n| ### [retrieveLatest](/merchant/api/reference/rest/accounts_v1beta/termsOfService/retrieveLatest) | Retrieves the latest version of the `TermsOfService` for a given `kind` and `region_code`. |"]]
