googleapis / googleapis/google-api-ruby-client

Readme has incorrect info re: API keys

Open
#8,081 0 comments 2 reactions 1 assignee Claimed by @aandreassa View on GitHub
type: docs
Dominant language
Ruby
Stars
2.9k
Forks
888
Avg merge
6m
Merged PRs (30d)
218

Description

Hi! Hope you're all doing well after these two difficult years. Just want to note a small possible issue I found with the readme here.

The readme notes that this library offers `integration with the googleauth gem for authentication using OAuth, API keys, and service accounts`. However, after much experimentation, it seems like the (only) way to use an API key is directly through the service -- for instance

```ruby
service = Google::Apis::YoutubeV3::YouTubeService.new
service.key = my_api_key
```

Just want to suggest updating the readme to make that clear for future developers looking to make API calls to resources that support API key authorization. (Might also be worth making a note about the need to include a `referer` and configure that on the API key, since that took some time to figure out as well.)

Thanks!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.