This page shows how to get started with the Cloud Client Libraries for the Service Directory API. Read more about the client libraries for Cloud APIs in Client Libraries Explained.
Installing the client library
C#
For more information, see Setting Up a C# Development Environment.
Using PowerShell or the Visual Studio Package Manager Console:
Install-Package "Google.Cloud.ServiceDirectory.V1" -Version "1.0.0"
Using the dotnet CLI:
dotnet add package "Google.Cloud.ServiceDirectory.V1" -Version "1.0.0"
Go
For more information, see Setting Up a Go Development Environment.
go get "cloud.google.com/go/servicedirectory/apiv1beta1"
Java
For more information, see Setting Up a Java Development Environment.
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.
If you are using Gradle, add the following to your dependencies:
If you are using sbt, add the following to your dependencies:
If you're using Visual Studio Code, 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 information, see Setting Up a Node.js Development Environment.
npm install @google-cloud/service-directory
PHP
For more information, see Using PHP on Google Cloud.
composer require google/cloud-service-directory
Python
For more information, see Setting Up a Python Development Environment.
pip install google-cloud-service-directory
Ruby
For more information, see Setting Up a Ruby Development Environment.
gem install google-cloud-service_directory
Setting up authentication
To run the client library, you must first set up authentication. One way to do that is to create a service account and set an environment variable, as shown in the following steps. For other ways to authenticate, see Authenticating as a service account.
Create a service account:
In the Google Cloud console, go to the Create service account page.
In the Service account name field, enter a name. The Google Cloud console fills
in the Service account ID field based on this name.
In the Service account description field, enter a description. For example,
To provide access to your project, grant the following role(s) to your
service account: Project > Owner.
In the Select a role list, select a role.
For additional roles, click
Click Done to finish creating the service account.
Do not close your browser window. You will use it in the next step.
Create a service account key:
Console
Service account for quickstart
.
Set up authentication:
Create the service account:
Replace
Grant roles to the service account. Run the following command once for each of the
following IAM roles:
Replace the following:
Generate the key file:
Replace the following:
gcloud
gcloud iam service-accounts create NAME
NAME
with a name for the service account.
roles/owner
:
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
SERVICE_ACCOUNT_NAME
: the name of the service accountPROJECT_ID
: the project ID where you created the service accountROLE
: the role to grantgcloud iam service-accounts keys create FILE_NAME.json --iam-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
FILE_NAME
: a name for the key fileSERVICE_ACCOUNT_NAME
: the name of the service accountPROJECT_ID
: the project ID where you created the service account
Provide authentication credentials to your application code by setting the
environment variable GOOGLE_APPLICATION_CREDENTIALS
. This
variable applies only to your current shell session. If you want the variable
to apply to future shell sessions, set the variable in your shell startup file,
for example in the ~/.bashrc
or ~/.profile
file.
Linux or macOS
export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
Replace KEY_PATH
with the path of the JSON file that contains your service account key.
For example:
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
Windows
For PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH
"
Replace KEY_PATH
with the path of the JSON file that contains your service account key.
For example:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
For command prompt:
set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH
Replace KEY_PATH
with the path of the JSON file that contains your service account key.
Using the client library
The following example shows how to use the client library.
Go
To learn how to install and use the client library for Service Directory, see Service Directory client libraries. For more information, see the Service Directory Go API reference documentation.
Java
To learn how to install and use the client library for Service Directory, see Service Directory client libraries. For more information, see the Service Directory Java API reference documentation.
Node.js
To learn how to install and use the client library for Service Directory, see Service Directory client libraries. For more information, see the Service Directory Node.js API reference documentation.
PHP
To learn how to install and use the client library for Service Directory, see Service Directory client libraries. For more information, see the Service Directory PHP API reference documentation.
Python
To learn how to install and use the client library for Service Directory, see Service Directory client libraries. For more information, see the Service Directory Python API reference documentation.
Ruby
To learn how to install and use the client library for Service Directory, see Service Directory client libraries. For more information, see the Service Directory Ruby API reference documentation.
Next steps
Learn how to programmatically configure Service Directory.