分类
API Coding

Google APIs Client Library for PHP

A PHP client library for accessing Google APIs

https://github.com/googleapis/google-api-php-client

The Google API Client Library enables you to work with Google APIs such as Google+, Drive, or YouTube on your server.

These client libraries are officially supported by Google. However, the libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

Google Cloud Platform
For Google Cloud Platform APIs such as Datastore, Cloud Storage or Pub/Sub, we recommend using GoogleCloudPlatform/google-cloud-php which is under active development.

Examples
See the examples/ directory for examples of the key client features. You can view them in your browser by running the php built-in web server.

$ php -S localhost:8000 -t examples/
And then browsing to the host and port you specified (in the above example, http://localhost:8000).

Basic Example
// include your composer dependencies
require_once ‘vendor/autoload.php’;

$client = new Google_Client();
$client->setApplicationName(“Client_Library_Examples”);
$client->setDeveloperKey(“YOUR_APP_KEY”);

$service = new Google_Service_Books($client);
$optParams = array(‘filter’ => ‘free-ebooks’);
$results = $service->volumes->listVolumes(‘Henry David Thoreau’, $optParams);

foreach ($results as $item) {
echo $item[‘volumeInfo’][‘title’], “
\n”;
}
Authentication with OAuth
An example of this can be seen in examples/simple-file-upload.php.

Follow the instructions to Create Web Application Credentials

Download the JSON credentials

Set the path to these credentials using Google_Client::setAuthConfig:

$client = new Google_Client();
$client->setAuthConfig(‘/path/to/client_credentials.json’);
Set the scopes required for the API you are going to call

$client->addScope(Google_Service_Drive::DRIVE);
Set your application’s redirect URI

// Your redirect URI can be any registered URI, but in this example
// we redirect back to this same page
$redirect_uri = ‘http://’ . $_SERVER[‘HTTP_HOST’] . $_SERVER[‘PHP_SELF’];
$client->setRedirectUri($redirect_uri);
In the script handling the redirect URI, exchange the authorization code for an access token:

if (isset($_GET[‘code’])) {
$token = $client->fetchAccessTokenWithAuthCode($_GET[‘code’]);
}
Authentication with Service Accounts
An example of this can be seen in examples/service-account.php.

Some APIs (such as the YouTube Data API) do not support service accounts. Check with the specific API documentation if API calls return unexpected 401 or 403 errors.

Follow the instructions to Create a Service Account

Download the JSON credentials

Set the path to these credentials using the GOOGLE_APPLICATION_CREDENTIALS environment variable:

putenv(‘GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json’);
Tell the Google client to use your service account credentials to authenticate:

$client = new Google_Client();
$client->useApplicationDefaultCredentials();
Set the scopes required for the API you are going to call

$client->addScope(Google_Service_Drive::DRIVE);
If you have delegated domain-wide access to the service account and you want to impersonate a user account, specify the email address of the user account using the method setSubject:

$client->setSubject($user_to_impersonate);
Making Requests
The classes used to call the API in google-api-php-client-services are autogenerated. They map directly to the JSON requests and responses found in the APIs Explorer.

A JSON request to the Datastore API would look like this:

POST https://datastore.googleapis.com/v1beta3/projects/YOUR_PROJECT_ID:runQuery?key=YOUR_API_KEY

{
“query”: {
“kind”: [{
“name”: “Book”
}],
“order”: [{
“property”: {
“name”: “title”
},
“direction”: “descending”
}],
“limit”: 10
}
}
Using this library, the same call would look something like this:

// create the datastore service class
$datastore = new Google_Service_Datastore($client);

// build the query – this maps directly to the JSON
$query = new Google_Service_Datastore_Query([
‘kind’ => [
[
‘name’ => ‘Book’,
],
],
‘order’ => [
‘property’ => [
‘name’ => ‘title’,
],
‘direction’ => ‘descending’,
],
‘limit’ => 10,
]);

// build the request and response
$request = new Google_Service_Datastore_RunQueryRequest([‘query’ => $query]);
$response = $datastore->projects->runQuery(‘YOUR_DATASET_ID’, $request);
However, as each property of the JSON API has a corresponding generated class, the above code could also be written like this:

// create the datastore service class
$datastore = new Google_Service_Datastore($client);

// build the query
$request = new Google_Service_Datastore_RunQueryRequest();
$query = new Google_Service_Datastore_Query();
// – set the order
$order = new Google_Service_Datastore_PropertyOrder();
$order->setDirection(‘descending’);
$property = new Google_Service_Datastore_PropertyReference();
$property->setName(‘title’);
$order->setProperty($property);
$query->setOrder([$order]);
// – set the kinds
$kind = new Google_Service_Datastore_KindExpression();
$kind->setName(‘Book’);
$query->setKinds([$kind]);
// – set the limit
$query->setLimit(10);

// add the query to the request and make the request
$request->setQuery($query);
$response = $datastore->projects->runQuery(‘YOUR_DATASET_ID’, $request);
The method used is a matter of preference, but it will be very difficult to use this library without first understanding the JSON syntax for the API, so it is recommended to look at the APIs Explorer before using any of the services here.

Making HTTP Requests Directly
If Google Authentication is desired for external applications, or a Google API is not available yet in this library, HTTP requests can be made directly.

The authorize method returns an authorized Guzzle Client, so any request made using the client will contain the corresponding authorization.

// create the Google client
$client = new Google_Client();

/**

  • Set your method for authentication. Depending on the API, This could be
  • directly with an access token, API key, or (recommended) using
  • Application Default Credentials.
    */
    $client->useApplicationDefaultCredentials();
    $client->addScope(Google_Service_Plus::PLUS_ME);

// returns a Guzzle HTTP Client
$httpClient = $client->authorize();

// make an HTTP request
$response = $httpClient->get(‘https://www.googleapis.com/plus/v1/people/me’);
Caching
It is recommended to use another caching library to improve performance. This can be done by passing a PSR-6 compatible library to the client:

use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use Cache\Adapter\Filesystem\FilesystemCachePool;

$filesystemAdapter = new Local(DIR.’/’);
$filesystem = new Filesystem($filesystemAdapter);

$cache = new FilesystemCachePool($filesystem);
$client->setCache($cache);
In this example we use PHP Cache. Add this to your project with composer:

composer require cache/filesystem-adapter
Updating Tokens
When using Refresh Tokens or Service Account Credentials, it may be useful to perform some action when a new access token is granted. To do this, pass a callable to the setTokenCallback method on the client:

$logger = new Monolog\Logger;
$tokenCallback = function ($cacheKey, $accessToken) use ($logger) {
$logger->debug(sprintf(‘new access token received at cache key %s’, $cacheKey));
};
$client->setTokenCallback($tokenCallback);
Debugging Your HTTP Request using Charles
It is often very useful to debug your API calls by viewing the raw HTTP request. This library supports the use of Charles Web Proxy. Download and run Charles, and then capture all HTTP traffic through Charles with the following code:

// FOR DEBUGGING ONLY
$httpClient = new GuzzleHttp\Client([
‘proxy’ => ‘localhost:8888’, // by default, Charles runs on localhost port 8888
‘verify’ => false, // otherwise HTTPS requests will fail.
]);

$client = new Google_Client();
$client->setHttpClient($httpClient);
Now all calls made by this library will appear in the Charles UI.

One additional step is required in Charles to view SSL requests. Go to Charles > Proxy > SSL Proxying Settings and add the domain you’d like captured. In the case of the Google APIs, this is usually *.googleapis.com.

Controlling HTTP Client Configuration Directly
Google API Client uses Guzzle as its default HTTP client. That means that you can control your HTTP requests in the same manner you would for any application using Guzzle.

Let’s say, for instance, we wished to apply a referrer to each request.

use GuzzleHttp\Client;

$httpClient = new Client([
‘headers’ => [
‘referer’ => ‘mysite.com’
]
]);

$client = new Google_Client();
$client->setHttpClient($httpClient);
Other Guzzle features such as Handlers and Middleware offer even more control.

发表评论

电子邮件地址不会被公开。 必填项已用*标注