A Yii2 wrapper for the official Google API PHP Client

Installs: 2 359

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 3

Forks: 2

Open Issues: 1


1.1.0 2017-11-17 12:00 UTC

This package is auto-updated.

Last update: 2020-07-06 10:10:51 UTC


A Yii2 wrapper for the official Google API PHP Client.

Latest Stable Version Latest Unstable Version License Total Downloads

This extension comes with:

  • A console utility to generate your credentials files
  • A component that will take care of the authentication, and give you access to the service


The preferred method of installation is via Packagist and Composer. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require idk/yii2-google-apiclient


Credentials file

In order to use this extension, you will be needing a credentials file for your Google Application.

You can generate this file using the provided console utility:

  • Configure the module in config/console.php:
'bootstrap' => ['log', 'yii2gac'],
'modules' => [
    'yii2gac' => [
        'class' => 'idk\yii2\google\apiclient\Module',
  • Use the /configure sub command:
./yii yii2gac/configure <clientSecretPath> [api]

where clientSecretPath is the path to your secret JSON file obtained from the Google Console and api the api identifier (it will be prompted for if not provided).


You application may use as much Google_Service instances as you need, by adding an entry into the components index of the Yii configuration array.

Here's how to setup GMail for example, a usage sample is provided below.

    'components' => [
        // ..
        'google' => [
            'class' => 'idk\yii2\google\apiclient\components\GoogleApiClient',
            'credentialsPath' => '@runtime/google-apiclient/auth.json',
            'clientSecretPath' => '@runtime/google-apiclient/secret.json',

This will enable you to access the GMail authenticated service Yii::$app->google->getService() in your application.

Sample usage

Displaying your newest message subject on GMail

$gmail = new \Google_Service_Gmail(Yii::$app->google->getService());

$messages = $gmail->users_messages->listUsersMessages('me', [
    'maxResults' => 1,
    'labelIds' => 'INBOX',
$list = $messages->getMessages();

if (count($list) == 0) {
    echo "You have no emails in your INBOX .. how did you achieve that ??";
} else {
    $messageId = $list[0]->getId(); // Grab first Message

    $message = $gmail->users_messages->get('me', $messageId, ['format' => 'full']);

    $messagePayload = $message->getPayload();
    $headers = $messagePayload->getHeaders();

    echo "Your last email subject is: ";
    foreach ($headers as $header) {
        if ($header->name == 'Subject') {
            echo "<b>" . $header->value . "</b>";