Before You Begin

Overview

Before you can begin using Cloud Talent Solution (CTS), you must enable the API in the Google Cloud Platform (GCP) Console. The steps below walk you through the following actions:

  • Enable CTS on a GCP project.
    1. Make sure billing is enabled for CTS.
    2. Accept the Data Logging Terms & Conditions.
    3. Create and/or assign one or more service accounts to Cloud Talent Solution.
    4. Download a service account credential key.
  • Set your authentication environment variable.

GCP Console set-up

  1. Go to the GCP Console. Navigate to the drop-down menu at the top of the page and choose the GCP project that you'd like to associate with Cloud Talent Solution. If you have previously created one or more projects, they will appear in a list in the pop-up menu. You can either choose a pre-existing project (a check mark will appear next to the project you select) or create a new project by clicking NEW PROJECT. For more details on creating a GCP project, please see the documentation.

  2. If you create a new project, you will be prompted to link a billing account to this project. If you are using a pre-existing project, make sure that you have billing enabled. You can access the project's billing information at any time by going to the main navigation menu (the hamburger icon in the upper left corner) and clicking the Billing option:

  3. Once you have selected a GCP project and linked it to a billing account, you can enable the Cloud Talent Solution API. Go to the main navigation menu and scroll down to the Artificial Intelligence section. Click on Talent Solution and choose Overview from the menu that pops up:

  4. If you would first like to try the API without linking it to your project, you can choose the TRY THIS API option. See the Job Search API Explorer documentation for more information on using this feature. To enable the Cloud Talent Solution API for use with your GCP project, click ENABLE:

  5. The data logging page appears. You must accept the terms & conditions to have full access to CTS features. If you choose not to accept these terms, you'll only be able to use deletion API requests. Click ENABLE:

  6. You are now prompted to link one or more service accounts to the CTS API. If you are using a project that already has service accounts associated with it, they will appear in a list on this page. Click CONNECT next to the account(s) that you want to link to the CTS API. Once you have done this, you can skip ahead to step 8 to make sure that you've downloaded a JSON or P12 credential for that account.

    If your project does not yet have any service accounts, you are prompted to create one. Type a name of your choosing into the Service account name box. Your input is automatically populated in the Service account ID box. The Service account description box is optional but recommended if you plan on associating multiple service accounts with your project. Enter a brief description of the service account into this box, then click CREATE.

  7. The next page allows you to assign a role to your new service account. See the CTS IAM permissions page for full details on the available roles and the permissions allowed to each. Click on the drop-down Select a role menu and scroll down to Cloud Talent Solution. You can choose a role for this service account from the options in the right-hand column:

  8. The next page gives you the option to complete several tasks. These are not required but highly recommended. You can grant individual users access to the service account you just created by entering their email addresses. You can also create a private key for the service account. You must use a private key during the authentication process when you use the API. If you choose not take these actions now, you can generate a key and add/change individual user information at any time by accessing the service account through the IAM option in the main navigation menu.

    Click CREATE KEY:

    Choose your preferred format from the pop-up menu and click CREATE:

    A new JSON or P12 credential file is automatically downloaded. Store this file in a specific location and make a note of the file path. You will need to point the GOOGLE_APPLICATION_CREDENTIALS environment variable to this file when you go through the authentication process. This is an essential step for authenticating requests to Cloud Talent Solution.

    Once your creditial file has downloaded, click DONE:

  9. Your service account now appears on the Connect service accounts page. Click CONNECT to link it to the CTS API:

  10. The account is now connected, and you're now ready to begin integrating Cloud Talent Solution into your system:

Set your authentication environment variable

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, and [FILE_NAME] with the filename. 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/[FILE_NAME].json"

Windows

With PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="[PATH]"

For example:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\[FILE_NAME].json"

With command prompt:

set GOOGLE_APPLICATION_CREDENTIALS=[PATH]

For more information, see the GCP authentication documentation.

What's next

Install a client library or see the create jobs and companies quickstart to begin making API calls.

Was this page helpful? Let us know how we did:

Send feedback about...

Job Search documentation