Google Cloud Ruby Client

Idiomatic Ruby client for Google Cloud Platform services.

CircleCI Build Status Travis-CI Build Status AppVeyor Build Status Coverage Status Gem Version

This client supports the following Google Cloud Platform services at a General Availability (GA) quality level:

This client supports the following Google Cloud Platform services at a Beta quality level:

This client supports the following Google Cloud Platform services at an Alpha quality level:

The support for each service is distributed as a separate gem. However, for your convenience, the google-cloud gem lets you install the entire collection.

If you need support for other Google APIs, check out the Google API Ruby Client library.

Quick Start

$ gem install google-cloud

The google-cloud gem shown above provides all of the individual service gems in the google-cloud-ruby project, making it easy to explore Google Cloud Platform. To avoid unnecessary dependencies, you can also install the service gems independently.


In general, the google-cloud-ruby library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments, the Service Account credentials can be specified by providing the path to the JSON keyfile for the account (or the JSON itself) in environment variables. Additionally, Cloud SDK credentials can also be discovered automatically, but this is only recommended during development.

General instructions, environment variables, and configuration options are covered in the general Authentication guide for the google-cloud umbrella package. Specific instructions and environment variables for each individual service are linked from the README documents listed below for each service.

The preview examples below demonstrate how to provide the Project ID and Credentials JSON file path directly in code.

BigQuery (GA)

Quick Start

$ gem install google-cloud-bigquery


require "google/cloud/bigquery"

bigquery =
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"

# Create a new table to archive todos
dataset = bigquery.dataset "my-todo-archive"
table = dataset.create_table "todos",
          name: "Todos Archive",
          description: "Archive for completed TODO records"

# Load data into the table
file = "/archive/todos/completed-todos.csv"
load_job = table.load file

# Run a query for the number of completed todos by owner
count_sql = "SELECT owner, COUNT(*) AS complete_count FROM todos GROUP BY owner"
data = bigquery.query count_sql
data.each do |row|
  puts row[:name]

Cloud Datastore (GA)

Follow the activation instructions to use the Google Cloud Datastore API with your project.

Quick Start

$ gem install google-cloud-datastore


require "google/cloud/datastore"

datastore =
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"

# Create a new task to demo datastore
task = datastore.entity "Task", "sampleTask" do |t|
  t["type"] = "Personal"
  t["done"] = false
  t["priority"] = 4
  t["description"] = "Learn Cloud Datastore"

# Save the new task task

# Run a query for all completed tasks
query = datastore.query("Task").
  where("done", "=", false)
tasks = query

Stackdriver Debugger (Beta)

Quick Start

$ gem install google-cloud-debugger


require "google/cloud/debugger"

debugger =

Cloud DNS (Alpha)

Quick Start

$ gem install google-cloud-dns


require "google/cloud/dns"

dns =

# Retrieve a zone
zone = "example-com"

# Update records in the zone
change = zone.update do |tx|
  tx.add     "www", "A",  86400, ""
  tx.remove  "", "TXT"
  tx.replace "", "MX", 86400, ["10",
  tx.modify "", "CNAME" do |r|
    r.ttl = 86400 # only change the TTL

Container Engine (Alpha)

Quick Start

$ gem install google-cloud-container


require "google/cloud/container"

cluster_manager_client =
project_id_2 = project_id
zone = "us-central1-a"
response = cluster_manager_client.list_clusters(project_id_2, zone)

Cloud Dataproc (Alpha)

Quick Start

$ gem install google-cloud-dataproc


require "google/cloud/dataproc"

cluster_controller_client =
project_id_2 = project_id
region = "global"

# Iterate over all results.
cluster_controller_client.list_clusters(project_id_2, region).each do |element|
  # Process element.

# Or iterate over results one page at a time.
cluster_controller_client.list_clusters(project_id_2, region).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.

Data Loss Prevention (Alpha)

Quick Start

$ gem install google-cloud-dlp


require "google/cloud/dlp"

dlp_service_client =
min_likelihood = :POSSIBLE
inspect_config = { min_likelihood: min_likelihood }
type = "text/plain"
value = "my phone number is 215-512-1212"
items_element = { type: type, value: value }
items = [items_element]
response = dlp_service_client.inspect_content(inspect_config, items)

Stackdriver Error Reporting (Beta)

Quick Start

$ gem install google-cloud-error_reporting


require "google/cloud/error_reporting"

# Report an exception
  fail "Boom!"
rescue => exception exception

Cloud Firestore (Beta)

Quick Start

$ gem install google-cloud-firestore


require "google/cloud/firestore"

firestore =
  project_id: "my-project",
  credentials: "/path/to/keyfile.json"

city = firestore.col("cities").doc("SF")
city.set({ name: "San Francisco",
           state: "CA",
           country: "USA",
           capital: false,
           population: 860000 })

firestore.transaction do |tx|
  new_population = tx.get(city).data[:population] + 1
  tx.update(city, { population: new_population })

Stackdriver Logging (GA)

Quick Start

$ gem install google-cloud-logging


require "google/cloud/logging"

logging =

# List all log entries
logging.entries.each do |e|
  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"

# List only entries from a single log
entries = logging.entries filter: "log:syslog"

# Write a log entry
entry = logging.entry
entry.payload = "Job started."
entry.log_name = "my_app_log"
entry.resource.type = "gae_app"
entry.resource.labels[:module_id] = "1"
entry.resource.labels[:version_id] = "20150925t173233"

logging.write_entries entry

Cloud Natural Language API (Alpha)

Quick Start

$ gem install google-cloud-language


require "google/cloud/language"

language =
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"

content = "Star Wars is a great movie. The Death Star is fearsome."
document = language.document content
annotation = document.annotate

annotation.entities.count #=> 3
annotation.sentiment.score #=> 0.10000000149011612
annotation.sentiment.magnitude #=> 1.100000023841858
annotation.sentences.count #=> 2
annotation.tokens.count #=> 13

Cloud OS Login (Alpha)

Quick Start

$ gem install google-cloud-os_login

Cloud Pub/Sub (Beta)

Quick Start

$ gem install google-cloud-pubsub


require "google/cloud/pubsub"

pubsub =
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"

# Retrieve a topic
topic = pubsub.topic "my-topic"

# Publish a new message
msg = topic.publish "new-message"

# Retrieve a subscription
sub = pubsub.subscription "my-topic-sub"

# Create a subscriber to listen for available messages
subscriber = sub.listen do |received_message|
  # process message

# Start background threads that will call the block passed to listen.

# Shut down the subscriber when ready to stop receiving messages.

Cloud Resource Manager (Alpha)

Quick Start

$ gem install google-cloud-resource_manager


require "google/cloud/resource_manager"

resource_manager =

# List all projects
resource_manager.projects.each do |project|
  puts projects.project_id

# Label a project as production
project = resource_manager.project "tokyo-rain-123"
project.update do |p|
  p.labels["env"] = "production"

# List only projects with the "production" label
projects = resource_manager.projects filter: "labels.env:production"

Stackdriver Trace (Beta)

Quick Start

$ gem install google-cloud-trace


require "google/cloud/trace"

trace =

result_set = trace.list_traces - 3600,
result_set.each do |trace_record|
  puts "Retrieved trace ID: #{trace_record.trace_id}"

Cloud Spanner API (GA)

Quick Start

$ gem install google-cloud-spanner


require "google/cloud/spanner"

spanner =

db = spanner.client "my-instance", "my-database"

db.transaction do |tx|
  results = tx.execute "SELECT * FROM users"

  results.rows.each do |row|
    puts "User #{row[:id]} is #{row[:name]}"

Cloud Speech API (Alpha)

Quick Start

$ gem install google-cloud-speech


require "google/cloud/speech"

speech =

audio = "path/to/audio.raw",
                     encoding: :raw, sample_rate: 16000
results = audio.recognize

result = results.first
result.transcript #=> "how old is the Brooklyn Bridge"
result.confidence #=> 0.9826789498329163

Cloud Storage (GA)

Quick Start

$ gem install google-cloud-storage


require "google/cloud/storage"

storage =
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"

bucket = storage.bucket "task-attachments"

file = bucket.file "path/to/my-file.ext"

# Download the file to the local file system "/tasks/attachments/#{}"

# Copy the file to a backup bucket
backup = storage.bucket "task-attachment-backups"
file.copy backup,

Cloud Translation API (GA)

Quick Start

$ gem install google-cloud-translate


require "google/cloud/translate"

translate =

translation = translate.translate "Hello world!", to: "la"

puts translation #=> Salve mundi!

translation.from #=> "en"
translation.origin #=> "Hello world!" #=> "la"
translation.text #=> "Salve mundi!"

Cloud Vision API (Alpha)

Quick Start

$ gem install google-cloud-vision


require "google/cloud/vision"

vision =

image = vision.image "path/to/landmark.jpg"

landmark = image.landmark
landmark.description #=> "Mount Rushmore"

Stackdriver Monitoring API (Beta)

Quick Start

$ gem install google-cloud-monitoring


 require "google/cloud/monitoring/v3"

 MetricServiceClient = Google::Cloud::Monitoring::V3::MetricServiceClient

 metric_service_client =
 formatted_name = MetricServiceClient.project_path(project_id)

 # Iterate over all results.
 metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
   # Process element.

 # Or iterate over results one page at a time.
 metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
   # Process each page at a time.
   page.each do |element|
     # Process element.

Cloud Video Intelligence API (GA)

Quick Start

$ gem install google-cloud-video_intelligence


 require "google/cloud/video_intelligence/v1beta2"

 video_intelligence_service_client =
 input_uri = "gs://cloud-ml-sandbox/video/chicago.mp4"
 features_element = :LABEL_DETECTION
 features = [features_element]

 # Register a callback during the method call.
 operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
   raise op.results.message if op.error?
   op_results = op.results
   # Process the results.

   metadata = op.metadata
   # Process the metadata.

 # Or use the return value to register a callback.
 operation.on_done do |op|
   raise op.results.message if op.error?
   op_results = op.results
   # Process the results.

   metadata = op.metadata
   # Process the metadata.

 # Manually reload the operation.

 # Or block until the operation completes, triggering callbacks on
 # completion.

Supported Ruby Versions

google-cloud-ruby is supported on Ruby 2.0+.


This library follows Semantic Versioning.

Please note it is currently under active development. Any release versioned 0.x.y is subject to backwards incompatible changes at any time.

GA: Libraries defined at the GA (general availability) quality level are stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

Please note that the auto-generated portions of the GA libraries (the ones in modules such as v1 or v2) are considered to be of Beta quality, even if the libraries that wrap them are GA.

Beta: Libraries defined at a Beta quality level are expected to be mostly stable and we're working towards their release candidate. We will address issues and requests with a higher priority.

Alpha: Libraries defined at an Alpha quality level are still a work-in-progress and are more likely to get backwards-incompatible updates.


Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.


This library is licensed under Apache 2.0. Full license text is available in LICENSE.


Please report bugs at the project on Github. Don't hesitate to ask questions about the client or APIs on StackOverflow.