Managing Cloud APIs and Libraries

You can access Google Cloud Platform products and services from your code using Cloud APIs. These Cloud APIs expose a simple JSON REST interface that you can call via client libraries.

This document describes how to enable Cloud APIs, manage service accounts and environment variables to access APIs locally, and add Cloud Client Libraries for Java to your Maven project.

Note: For non-Maven projects, Cloud Code does not add the Cloud Client Libraries to your build, but it does support the other features described here.

Note: The following IDEs support this feature:

• IntelliJ IDEA - Ultimate
• IntelliJ IDEA - Community
• Other IntelliJ Platform-based IDEs

Note: For App Engine standard environment applications, Java 7 is not supported. See the GitHub page for information on the supported platforms.

Before You Begin

Follow the Quickstart to install and setup IntelliJ IDEA.

Adding the Cloud Client Libraries

To add libraries to your project in IntelliJ:

For Maven Projects

1. Select Tools > Cloud Code > Add Cloud libraries and Manage Cloud APIs.

The Add Google Cloud Libraries dialog displays the supported libraries.


2. In the GCP Project field, be sure that the right project and account are shown. If not, click the ellipse to pick the correct project and account.
3. In the Add Google Client Library to Module drop-down menu, select the module that you want to add the library to.
4. In the Google Cloud Java drop-down menu, select the version of the Google Cloud Java BOM you want to use.

Google Cloud Java solves version conflicts between libraries by adding the Google Cloud Java Bill of Materials (BOM) to the pom.xml file of your projects.

5. Select the checkbox for each library you want to add.
Some APIs require that you enable them on Google Cloud Platform before you can access them. For these APIs, selecting the checkbox automatically selects Enable the API on the Google Cloud Platform.
6. Click Continue.

The Enable GCP APIs and Manage Service Accounts Confirmation dialog displays.


7. In the Service account name field, keep the default name or enter a new one.
8. In the Download path field, navigate to the location where you want to download the service account key.
You should keep the key in a secure location and never check it into source control.
9. If your API requires it, select which roles you want to add to the service account.
10. Click OK.


IntelliJ makes the following updates:

• adds the selected dependencies to your pom.xml.
• enables the selected APIs on Google Cloud Platform.
• creates the service account and downloads its key to the specified location.
11. To access the Google Cloud APIs locally, set the GOOGLE_APPLICATION_CREDENTIALS and GOOGLE_CLOUD_PROJECT environment variables on your local development server or on any of your local run configurations:
1. Click the copy icon to copy the variables to your clipboard.
2. Edit your run configuration.
3. In the Environment Variables section, click the paste icon.

For the local application server, this section appears on the Startup/Connection tab.

4. The environment variables are automatically inserted for you.
If you are using App Engine standard and have local run configurations, the confirmation dialog displays those run configs. Select the configurations you want to add these environment variables to and click Add Variables.

For non-Maven Projects

1. Select Tools > Cloud Code > Manage Cloud APIs.

The Manage Google Cloud APIs dialog displays the supported libraries.


2. In the GCP Project field, be sure that the right project and account are shown. If not, click the ellipse to pick the correct project and account.
3. Select the checkbox for each library you want to add.
Some APIs require that you enable them on Google Cloud Platform before you can access them. For these APIs, selecting the checkbox automatically selects Enable the API on the Google Cloud Platform.
4. Click Continue.

The Enable GCP APIs and Manage Service Accounts Confirmation dialog displays.


5. In the Service account name field, keep the default name or enter a new one.
6. In the Download path field, navigate to the location where you want to download the service account key.
You should keep the key in a secure location and never check it into source control.
7. If your API requires it, select which roles you want to add to the service account.
8. Click OK.


IntelliJ makes the following updates:

• enables the selected APIs on Google Cloud Platform.
• creates the service account and downloads its key to the specified location.
9. To access the Google Cloud APIs locally, set the GOOGLE_APPLICATION_CREDENTIALS and GOOGLE_CLOUD_PROJECT environment variables on your local development server or on any of your local run configurations:
1. Click the copy icon to copy the variables to your clipboard.
2. Edit your run configuration.
3. In the Environment Variables section, click the paste icon.

For the local application server, this section appears on the Startup/Connection tab.

4. The environment variables are automatically inserted for you.
If you are using App Engine standard and have local run configurations, the confirmation dialog displays those run configs. Select the configurations you want to add these environment variables to and click Add Variables.

Getting Support

To send feedback, report issues on GitHub, or ask a question on Stack Overflow.