| <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. Format: `accounts/{account}` |
| 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: |
| |
| { # Response message for the `AcceptTermsOfService` method. |
| "termsOfServiceAgreementState": { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. # The agreement state after accepting the ToS. |
| "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code |
| "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. |
| "termsOfService": "A String", # Required. The accepted termsOfService. |
| "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. |
| "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| }, |
| }, |
| "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-EU` or `MERCHANT_CENTER-US`. |
| "regionCode": "A String", # Required. Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. |
| "required": { # Describes the terms of service which are required to be accepted. # Optional. The required terms of service |
| "termsOfService": "A String", # Required. The `TermsOfService` that need to be accepted. |
| "tosFileUri": "A String", # Required. Full URL to the terms of service file. This field is the same as `TermsOfService.file_uri`, it is added here for convenience only. |
| }, |
| "termsOfServiceKind": "A String", # Required. Terms of Service kind associated with the particular version. |
| }, |
| }</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. For more information, see [Terms of Service](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`. |
| "external": 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. |
| "fileUri": "A String", # URI for terms of service file that needs to be displayed to signing users. |
| "kind": "A String", # The Kind this terms of service version applies to. |
| "name": "A String", # Identifier. The resource name of the terms of service version. Format: `termsOfService/{version}` |
| "regionCode": "A 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). |
| }</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 - Terms of service for the 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. For more information, see [Terms of Service](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`. |
| "external": 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. |
| "fileUri": "A String", # URI for terms of service file that needs to be displayed to signing users. |
| "kind": "A String", # The Kind this terms of service version applies to. |
| "name": "A String", # Identifier. The resource name of the terms of service version. Format: `termsOfService/{version}` |
| "regionCode": "A 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). |
| }</pre> |
| </div> |
| |
| </body></html> |
