Setup

To start using Cloud Translation, you need a project that has the Cloud Translation API enabled and credentials to make authenticated calls. The following sections detail how to get set up before you make your first call to the Cloud Translation API.

Cloud Translation is available in two editions. Before you begin, decide which edition you will use because their client library installations are different.

The setup process involves the Google Cloud Console, which is a web interface that you can use to provision, configure, manage, and monitor systems in Google Cloud. If you haven't used the Google Cloud Console before, see the Cloud Console page for more information.

Create or select a project

To use services provided by Google Cloud, you must create a project. A project organizes all your Google Cloud resources. A project consists of a set of collaborators, enabled APIs (and other resources), monitoring tools, billing information, and authentication and access controls. You can create one project, or you can create multiple projects and use them to organize your Google Cloud resources in a resource hierarchy. When creating a project, take note of the project ID. You will need this ID to make API calls. For more information on projects, see the Resource Manager documentation.

We recommend that you create separate projects for experiments, testing, and production. After you create a project, record the project number or ID. You must provide the project number (or ID) when you make calls to the Cloud Translation API.

In the Cloud Console, on the project selector page, select or create a Cloud project.

Go to the project selector page

Enable billing

You must enable billing to use Cloud Translation. For more information about Cloud Translation pricing, see the pricing page.

A billing account is used to define who pays for a given set of resources, and it can be linked to one or more projects. Project usage is charged to the linked billing account. In most cases, you configure billing when you create a project. For more information, see the Billing documentation.

Make sure that billing is enabled for your Google Cloud project. Learn how to confirm billing is enabled for your project.

Enabling the API

You must enable the Cloud Translation API for your project. For more information on enabling APIs, see the Service Usage documentation.

Enable the Cloud Translation API.

Enable the API

Set up authentication

If you plan to use the Cloud Translation API, you need to set up authentication. Any client application that uses the API must be authenticated and granted access to the requested resources. This section describes important authentication concepts and provides steps for setting it up. For more information, see the Google Cloud authentication overview.

Service account and private key

There are multiple options for authentication, but it is recommended that you use service accounts for authentication and access control. A service account provides credentials for applications, as opposed to end-users. Service accounts are owned by projects, and you can create many service accounts for a project. For more information, see Understanding service accounts.

Service accounts are associated with one or more public/private key pairs. When you create a new key pair, you download the private key. Your private key is used to generate credentials when calling the API. You are responsible for security of the private key and other management operations, such as key rotation.

Identity and Access Management roles

When an identity calls an API, Google Cloud requires that the identity has the appropriate permissions. You can grant permissions by granting roles to a service account. For more information, see the Identity and Access Management (IAM) documentation.

Creating service accounts and keys

Set up authentication:

  1. In the Cloud Console, go to the Create service account key page.

    Go to the Create Service Account Key page
  2. From the Service account list, select New service account.
  3. In the Service account name field, enter a name.
  4. From the Role list, select Project > Owner.

    Note: The Role field authorizes your service account to access resources. You can view and change this field later by using the Cloud Console. If you are developing a production app, specify more granular permissions than Project > Owner. For more information, see granting roles to service accounts.
  5. Click Create. A JSON file that contains your key downloads to your computer.

For more information about the different roles, see Cloud Translation - Advanced roles. For example, if you want to allow your service account to translate text, assign the roles/cloudtranslate.user role to it. All of the keys that are associated with that service account receive the same permissions.

Using the service account key file in your environment

Provide authentication credentials to your application code by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS. Replace [PATH] with the file path of the JSON file that contains your service account key. This variable only applies to your current shell session, so if you open a new session, set the variable again.

Linux or macOS

export GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"

Windows

With PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\my-key.json"

With command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

Installing client libraries

Client libraries are available for several popular languages. We recommend that you use these client libraries to make calls to Cloud Translation because they make it easier to access the APIs.

For example, when you use a client library, it can determine your credentials implicitly through the GOOGLE_APPLICATION_CREDENTIALS environment variable. You don't need to explicitly specify your credentials in code. For more information, see Client Libraries Explained in the Cloud APIs documentation.

Cloud Translation - Basic client libraries

Select the programming language that you are using for development, and then run the related command. For more information, see the Cloud Translation - Basic client libraries overview.

C#

nuget install Google.Cloud.Translation.V2

Go

go get -u cloud.google.com/go/translate

Java

If you are using Maven, add the following to your pom.xml file. For more information about BOMs, see The Google Cloud Platform Libraries BOM.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>9.1.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-translate</artifactId>
  </dependency>
</dependencies>

If you are using Gradle, add the following to your dependencies:

compile 'com.google.cloud:google-cloud-translate:1.95.2'

If you are using sbt, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-translate" % "1.95.2"

If you're using IntelliJ or Eclipse, you can add client libraries to your project using the following IDE plugins:

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

Node.js

For more on setting up your Node.js development environment, refer to the Node.js Development Environment Setup Guide.

npm install --save @google-cloud/translate

PHP

composer require google/cloud-translate

Python

For more on setting up your Python development environment, refer to the Python Development Environment Setup Guide.

pip install google-cloud-translate==2.0.1

Ruby

For more on setting up your Ruby development environment, refer to the Ruby Development Environment Setup Guide.

gem install google-cloud-translate

Cloud Translation - Advanced client libraries

Select the programming language that you are using for development, and then run the related command. For more information, see the Cloud Translation - Advanced client libraries overview.

C#

nuget install Google.Cloud.Translate.V3 -Pre

Go

go get -u cloud.google.com/go/translate/apiv3

Java

If you are using Maven, add the following to your pom.xml file. For more information about BOMs, see The Google Cloud Platform Libraries BOM.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>libraries-bom</artifactId>
      <version>9.1.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

<dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>google-cloud-translate</artifactId>
  </dependency>
</dependencies>

If you are using Gradle, add the following to your dependencies:

compile 'com.google.cloud:google-cloud-translate:1.95.2'

If you are using sbt, add the following to your dependencies:

libraryDependencies += "com.google.cloud" % "google-cloud-translate" % "1.95.2"

If you're using IntelliJ or Eclipse, you can add client libraries to your project using the following IDE plugins:

The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.

Node.js

For more on setting up your Node.js development environment, refer to the Node.js Development Environment Setup Guide.

npm install --save @google-cloud/translate

PHP

composer require google/cloud-translate

Python

For more on setting up your Python development environment, refer to the Python Development Environment Setup Guide.

pip install --upgrade google-cloud-translate

Ruby

For more on setting up your Ruby development environment, refer to the Ruby Development Environment Setup Guide.

gem install google-cloud-translate

Install the Cloud SDK

If you plan to send Cloud Translation requests through the command line (such as through curl commands), install and initialize the gcloud command line tool, which is included in the Cloud SDK. The following link provides more information:

Install and initialize the Cloud SDK.

Test the SDK and authentication

If you have set up the GOOGLE_APPLICATION_CREDENTIALS environment variable, you can use gcloud to test your authentication environment. Run the following command and verify that no error occurs and that credentials are returned:

gcloud auth application-default print-access-token

The previous command is used by all Cloud Translation command line REST samples to authenticate API calls.

What's next