scottybo/laravel-google-my-business

A package for Laravel which implements the Google My Business API

Laravel Google My Business

Note: To use the Google My Business API you have to apply for access: https://docs.google.com/forms/d/1XTQc-QEjsE7YrgstyJxbFDnwmhUhBFFvpNJBw3VzuuE/viewform, _(*1)

This is a Laravel ready implementation of the Google My Business PHP Library (v4.4) as provided by Google on https://developers.google.com/my-business/samples/, _(*2)

Please refer to https://developers.google.com/my-business/reference/rest/ for information on how the Google My Business API functions - more useful links are available at the bottom of this document., _(*3)

Debugging

I'm putting this above everything else as it's extremely important. The Google My Business Client library doesn't support detailed error responses: https://developers.google.com/my-business/content/support#detailed_error_responses, _(*4)

So when something goes wrong, you get an extremely unhelpful 400 error message such as Request contains an invalid argument., _(*5)

To get more detailed error messages we need to add the HTTP header: X-GOOG-API-FORMAT-VERSION: 2 to the request and the error message that gets returned will be a lot more useful., _(*6)

There isn't a pretty way to do this, but all you need to do is open:, _(*7)

/vendor/google/apiclient/src/Google/Http/REST.php, _(*8)

And in the doExecute function modify as follows, _(*9)

      $httpHandler = HttpHandlerFactory::build($client);

      // Add the header to the request
      $request = $request->withHeader('X-GOOG-API-FORMAT-VERSION', '2');

Once you've finished debugging, remove this added line., _(*10)

Installation

Run composer require scottybo/laravel-google-my-business, _(*11)

Or to install via composer - edit your composer.json to require the package., _(*12)

"require": { "scottbo/laravel-google-my-business": "1.*" }, _(*13)

Then run composer update in your terminal to pull it in., _(*14)

Laravel

Important: It's highly recommend you use https://github.com/pulkitjalan/google-apiclient to handle the Google Client setup. The code examples further down this document assume you're using this library., _(*15)

To use this Google My Business package in a Laravel project add the following to the providers array in your config/app.php, _(*16)

Scottybo\LaravelGoogleMyBusiness\GoogleMyBusinessServiceProvider::class,

Next add the following to the aliases array in your config/app.php, _(*17)

'GoogleMyBusiness' => Scottybo\LaravelGoogleMyBusiness\GoogleMyBusiness::class

Google My Business Discovery document

The Google My Business API discovery document is a JSON document that describes the surface for a particular version of the API. You use the discovery document in conjunction with the Google API Discovery Service., _(*18)

mybusiness_google_rest_v4p4.json has been included with this project for your reference (downloaded from: https://developers.google.com/my-business/samples/), _(*19)

Tips - For a guide on Google Discovery documents see: https://developers.google.com/discovery/v1/using#discovery-doc - A useful tool for browsing this massive document is: http://jsonviewer.stack.hu/ - Join the discussion! https://support.google.com/business/community?hl=en (old platform for discussion: https://www.en.advertisercommunity.com/t5/Google-My-Business-API/bd-p/gmb-api), _(*20)

Code example

(Work in progress), _(*21)

use Google; // See: https://github.com/pulkitjalan/google-apiclient
use GoogleMyBusiness;


class MyExampleClass
{

    function authRedirect() {

        // Define the GMB scope
        $scopes = [
            'https://www.googleapis.com/auth/plus.business.manage'
        ];

        // Define any configs that overrride the /config/google.php defaults from pulkitjalan/google-apiclient
        $googleConfig = array_merge(config('google'),[
            'scopes' => $scopes,
            'redirect_uri' => config('app.callback_url').'/callback/google/mybusiness'
        ]);

        // Generate an auth request URL
        $googleClient = new Google($googleConfig);
        $loginUrl = $googleClient->createAuthUrl();

        // Send user to Google for Authorisation
        return redirect()->away($loginUrl);
    }

    function getAccountName(Google $googleClient) {
        $gmb = new GoogleMyBusiness($googleClient);
        return $gmb->getAccountName();
    }

}

Useful links

Mostly for my reference as I develop this package, but you might find them useful too!, _(*22)

• NEW COMMUNITY URL: https://support.google.com/business/community?hl=en
• https://www.en.advertisercommunity.com/t5/Google-My-Business-API/Create-Post-with-My-Business-API/td-p/1704175
• https://developers.google.com/api-client-library/php/start/get_started
• https://developers.google.com/identity/protocols/OAuth2WebServer
• https://developers.google.com/identity/protocols/googlescopes
• https://developers.google.com/my-business/reference/rest/v4/accounts
• https://developers.google.com/my-business/content/get-started
• https://github.com/google/google-auth-library-php
• https://github.com/pulkitjalan/google-apiclient/issues/23