Get Terms of Service

Merchant API Code Sample to Get Terms of Service

Java

// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package shopping.merchant.samples.accounts.termsofservices.v1beta;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1beta.GetTermsOfServiceRequest;
import com.google.shopping.merchant.accounts.v1beta.TermsOfService;
import com.google.shopping.merchant.accounts.v1beta.TermsOfServiceName;
import com.google.shopping.merchant.accounts.v1beta.TermsOfServiceServiceClient;
import com.google.shopping.merchant.accounts.v1beta.TermsOfServiceServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;

/** This class demonstrates how to get a TermsOfService for a specific version. */
public class GetTermsOfServiceSample {

  public static void getTermsOfService(Config config) throws Exception {

    // Obtains OAuth token based on the user's configuration.
    GoogleCredentials credential = new Authenticator().authenticate();

    // Creates service settings using the credentials retrieved above.
    TermsOfServiceServiceSettings termsOfServiceServiceSettings =
        TermsOfServiceServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credential))
            .build();

    // Creates TermsOfService name to identify TermsOfService.
    String name = TermsOfServiceName.newBuilder().setVersion("132").build().toString();

    // Calls the API and catches and prints any network failures/errors.
    try (TermsOfServiceServiceClient termsOfServiceServiceClient =
        TermsOfServiceServiceClient.create(termsOfServiceServiceSettings)) {

      // The name has the format: termsOfService/{version}
      GetTermsOfServiceRequest request =
          GetTermsOfServiceRequest.newBuilder().setName(name).build();

      System.out.println("Sending Get TermsOfService request:");
      TermsOfService response = termsOfServiceServiceClient.getTermsOfService(request);

      System.out.println("Retrieved TermsOfService below");
      System.out.println(response);
    } catch (Exception e) {
      System.out.println(e);
    }
  }

  public static void main(String[] args) throws Exception {
    Config config = Config.load();

    getTermsOfService(config);
  }
}

PHP

<?php
/**
 * Copyright 2025 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
require_once __DIR__ . '/../../../../vendor/autoload.php';
require_once __DIR__ . '/../../../Authentication/Authentication.php';
require_once __DIR__ . '/../../../Authentication/Config.php';
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Accounts\V1beta\Client\TermsOfServiceServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\GetTermsOfServiceRequest;

/**
 * Demonstrates how to get a TermsOfService for a specific version.
 */
class GetTermsOfService
{
    /**
     * Gets a TermsOfService.
     *
     * @param array $config The configuration data.
     * @return void
     */
    public static function getTermsOfService($config): void
    {
        // Get OAuth credentials.
        $credentials = Authentication::useServiceAccountOrTokenFile();

        // Create client options.
        $options = ['credentials' => $credentials];

        // Create a TermsOfServiceServiceClient.
        $termsOfServiceServiceClient = new TermsOfServiceServiceClient($options);

        // Terms of service version to get
        $version = "132";  // Replace with the version you want to retrieve

        // Create TermsOfService name.
        $name = "termsOfService/" . $version;

        try {
            // Prepare the request.
            $request = new GetTermsOfServiceRequest([
                'name' => $name,
            ]);

            print "Sending Get TermsOfService request:" . PHP_EOL;
            $response = $termsOfServiceServiceClient->getTermsOfService($request);

            print "Retrieved TermsOfService below\n";
            print $response->serializeToJsonString() . PHP_EOL;
        } catch (ApiException $e) {
            print $e->getMessage();
        }
    }

    /**
     * Helper to execute the sample.
     *
     * @return void
     */
    public function callSample(): void
    {
        $config = Config::generateConfig();

        self::getTermsOfService($config);
    }

}

// Run the script
$sample = new GetTermsOfService();
$sample->callSample();

Python

# -*- coding: utf-8 -*-
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Module for retrieving a specific version of the TermsOfService."""

from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1beta import GetTermsOfServiceRequest
from google.shopping.merchant_accounts_v1beta import TermsOfServiceServiceClient

# Replace with your actual value.
_VERSION = "132"  # Replace with the version you want to retrieve


def get_terms_of_service():
  """Gets a TermsOfService for a specific version."""

  credentials = generate_user_credentials.main()
  client = TermsOfServiceServiceClient(credentials=credentials)

  name = "termsOfService/" + _VERSION

  request = GetTermsOfServiceRequest(name=name)

  try:
    print("Sending Get TermsOfService request:")
    response = client.get_terms_of_service(request=request)
    print("Retrieved TermsOfService below")
    print(response)
  except RuntimeError as e:
    print(e)


if __name__ == "__main__":
  get_terms_of_service()