Repository files navigation

NOTE: please check to see if the package you'd like to install is available in ourlist ofGoogle cloud packages first, asthese are the recommended libraries.

Reference Docs

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

License

Apache 2.0

The Google API Client Library enables you to work with Google APIs such as Gmail, 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.

For Google Cloud Platform APIs such asDatastore,Cloud Storage,Pub/Sub, andCompute Engine, we recommend using the Google Cloud client libraries. For a complete list of supported Google Cloud client libraries, seegoogleapis/google-cloud-php.

• PHP 8.0 or higher

Thedocs folder provides detailed guides for using this library.

You can useComposer or simplyDownload the Release

The preferred method is viacomposer. Follow theinstallation instructions if you do not already havecomposer installed.

Once composer is installed, execute the following command in your project root to install this library:

composer require google/apiclient

If you're facing a timeout error then either increase the timeout for composer by adding the env flag asCOMPOSER_PROCESS_TIMEOUT=600 composer install or you can put this in theconfig section of the composer schema:

{    "config": {        "process-timeout": 600    }}

Finally, be sure to include the autoloader:

require_once'/path/to/your-project/vendor/autoload.php';

This library relies ongoogle/apiclient-services. That library provides up-to-date API wrappers for a large number of Google APIs. In order that users may make use of the latest API clients, this library does not pin to a specific version ofgoogle/apiclient-services.In order to prevent the accidental installation of API wrappers with breaking changes, it is highly recommended that you pin to thelatest version yourself prior to using this library in production.

There are over 200 Google API services. The chances are good that you will notwant them all. In order to avoid shipping these dependencies with your code,you can run theGoogle\Task\Composer::cleanup task and specify the servicesyou want to keep incomposer.json:

{"require": {"google/apiclient":"^2.15.0"    },"scripts": {"pre-autoload-dump":"Google\\Task\\Composer::cleanup"    },"extra": {"google/apiclient-services": ["Drive","YouTube"        ]    }}

This example will remove all services other than "Drive" and "YouTube" whencomposer update or a freshcomposer install is run.

IMPORTANT: If you add any services back incomposer.json, you will need toremove thevendor/google/apiclient-services directory explicitly for thechange you made to have effect:

rm -r vendor/google/apiclient-servicescomposer update

NOTE: This command performs an exact match on the service name, so to keepYouTubeReporting andYouTubeAnalytics as well, you'd need to add each ofthem explicitly:

{"extra": {"google/apiclient-services": ["Drive","YouTube","YouTubeAnalytics","YouTubeReporting"        ]    }}

If you prefer not to use composer, you can download the package in its entirety. TheReleases page lists all stable versions. Download any filewith the namegoogle-api-php-client-[RELEASE_NAME].zip for a package including this library and its dependencies.

Uncompress the zip file you download, and include the autoloader in your project:

require_once'/path/to/google-api-php-client/vendor/autoload.php';

For additional installation and setup instructions, seethe documentation.

See theexamples/ directory for examples of the key client features. You canview 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).

// include your composer dependenciesrequire_once'vendor/autoload.php';$client =newGoogle\Client();$client->setApplicationName("Client_Library_Examples");$client->setDeveloperKey("YOUR_APP_KEY");$service =newGoogle\Service\Books($client);$query ='Henry David Thoreau';$optParams = ['filter' =>'free-ebooks',];$results =$service->volumes->listVolumes($query,$optParams);foreach ($results->getItems()as$item) {echo$item['volumeInfo']['title'],"<br />\n";}

An example of this can be seen inexamples/simple-file-upload.php.

1. Follow the instructions toCreate Web Application Credentials

2. Download the JSON credentials

3. Set the path to these credentials usingGoogle\Client::setAuthConfig:

   $client =newGoogle\Client();$client->setAuthConfig('/path/to/client_credentials.json');

4. Set the scopes required for the API you are going to call

   $client->addScope(Google\Service\Drive::DRIVE);

5. 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);

6. In the script handling the redirect URI, exchange the authorization code for an access token:

   if (isset($_GET['code'])) {$token =$client->fetchAccessTokenWithAuthCode($_GET['code']);}

An example of this can be seen inexamples/service-account.php.

Some APIs(such as theYouTube Data API) donot support service accounts. Check with the specific API documentation if APIcalls return unexpected 401 or 403 errors.

1. Follow the instructions toCreate a Service Account

2. Download the JSON credentials

3. Set the path to these credentials using theGOOGLE_APPLICATION_CREDENTIALS environment variable:

   putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');

4. Tell the Google client to use your service account credentials to authenticate:

   $client =newGoogle\Client();$client->useApplicationDefaultCredentials();

5. Set the scopes required for the API you are going to call

   $client->addScope(Google\Service\Drive::DRIVE);

6. 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);

If you want to a specific JSON key instead of usingGOOGLE_APPLICATION_CREDENTIALS environment variable, you can do this:

$jsonKey = ['type' =>'service_account',// ...];$client =newGoogle\Client();$client->setAuthConfig($jsonKey);

The classes used to call the API ingoogle-api-php-client-services are autogenerated. They map directly to the JSON requests and responses found in theAPIs Explorer.

A JSON request to theDatastore 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 =newGoogle\Service\Datastore($client);// build the query - this maps directly to the JSON$query =newGoogle\Service\Datastore\Query(['kind' => [        ['name' =>'Book',        ],    ],'order' => ['property' => ['name' =>'title',        ],'direction' =>'descending',    ],'limit' =>10,]);// build the request and response$request =newGoogle\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 =newGoogle\Service\Datastore($client);// build the query$request =newGoogle\Service\Datastore_RunQueryRequest();$query =newGoogle\Service\Datastore\Query();//   - set the order$order =newGoogle\Service\Datastore_PropertyOrder();$order->setDirection('descending');$property =newGoogle\Service\Datastore\PropertyReference();$property->setName('title');$order->setProperty($property);$query->setOrder([$order]);//   - set the kinds$kind =newGoogle\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, butit will be very difficult to use this library without first understanding the JSON syntax for the API, so it is recommended to look at theAPIs Explorer before using any of the services here.

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.

If you are installing this client only to authenticate your own HTTP client requests, you should usegoogle/auth instead.

Theauthorize method returns an authorizedGuzzle Client, so any request made using the client will contain the corresponding authorization.

// create the Google client$client =newGoogle\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');

It is recommended to use another caching library to improve performance. This can be done by passing aPSR-6 compatible library to the client:

useLeague\Flysystem\Adapter\Local;useLeague\Flysystem\Filesystem;useCache\Adapter\Filesystem\FilesystemCachePool;$filesystemAdapter =newLocal(__DIR__.'/');$filesystem        =newFilesystem($filesystemAdapter);$cache =newFilesystemCachePool($filesystem);$client->setCache($cache);

In this example we usePHP Cache. Add this to your project with composer:

composer require cache/filesystem-adapter

When usingRefresh Tokens orService Account Credentials, it may be useful to perform some action when a new access token is granted. To do this, pass a callable to thesetTokenCallback method on the client:

$logger =newMonolog\Logger();$tokenCallback =function ($cacheKey,$accessToken)use ($logger) {$logger->debug(sprintf('new access token received at cache key %s',$cacheKey));};$client->setTokenCallback($tokenCallback);

It is often very useful to debug your API calls by viewing the raw HTTP request. This library supports the use ofCharles Web Proxy. Download and run Charles, and then capture all HTTP traffic through Charles with the following code:

// FOR DEBUGGING ONLY$httpClient =newGuzzleHttp\Client(['proxy' =>'localhost:8888',// by default, Charles runs on localhost port 8888'verify' =>false,// otherwise HTTPS requests will fail.]);$client =newGoogle\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 toCharles > Proxy > SSL Proxying Settings and add the domain you'd like captured. In the case of the Google APIs, this is usually*.googleapis.com.

Google API Client usesGuzzle 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.

useGuzzleHttp\Client;$httpClient =newClient(['headers' => ['referer' =>'mysite.com'    ]]);$client =newGoogle\Client();$client->setHttpClient($httpClient);

Other Guzzle features such asHandlers and Middleware offer even more control.

When using OAuth2 3LO (e.g. you're a client requesting credentials from a 3rdparty, such as in thesimple file upload example),you may want to take advantage of Partial Consent.

To allow clients to only grant certain scopes in the OAuth2 screen, pass thequerystring parameter forenable_serial_consent when generating theauthorization URL:

$authUrl =$client->createAuthUrl($scope, ['enable_serial_consent' =>'true']);

Once the flow is completed, you can see which scopes were granted by callinggetGrantedScope on the OAuth2 object:

// Space-separated string of granted scopes if it exists, otherwise null.echo$client->getOAuth2Service()->getGrantedScope();

YouTube:https://github.com/youtube/api-samples/tree/master/php

Please see thecontributing page for more information. In particular, we love pull requests - but please make sure to sign the contributor license agreement.

For support with the library the best place to ask is via the google-api-php-client tag on StackOverflow:https://stackoverflow.com/questions/tagged/google-api-php-client

If there is a specific bug with the library, pleasefile an issue in the GitHub issues tracker, including an example of the failing code and any specific errors retrieved. Feature requests can also be filed, as long as they are core library requests, and not-API specific: for those, refer to the documentation for the individual APIs for the best place to file requests. Please try to provide a clear statement of the problem that the feature would address.

If X is a feature of the library, file away! If X is an example of using a specific service, the best place to go is to the teams for those specific APIs - our preference is to link to their examples rather than add them to the library, as they can then pin to specific versions of the library. If you have any examples for other APIs, let us know and we will happily add a link to the README above!

TheGoogle\Service classes are generally automatically generated from the API discovery documents:https://developers.google.com/discovery/. Sometimes new features are added to APIs with unusual names, which can cause some unexpected or non-standard style naming in the PHP classes.

Some services return XML or similar by default, rather than JSON, which is what the library supports. You can request a JSON response by adding an 'alt' argument to optional params that is normally the last argument to a method call:

$opt_params =array('alt' =>"json");

The library strips out nulls from the objects sent to the Google APIs as it is the default value of all of the uninitialized properties. To work around this, set the field you want to null toGoogle\Model::NULL_VALUE. This is a placeholder that will be replaced with a true null when sent over the wire.

Run the PHPUnit tests with PHPUnit. You can configure an API key and token in BaseTest.php to run all calls, but this will require some setup on the Google Developer Console.

phpunit tests/

To check for coding style violations, run

vendor/bin/phpcs src --standard=style/ruleset.xml -np

To automatically fix (fixable) coding style violations, run

vendor/bin/phpcbf src --standard=style/ruleset.xml