README

The Google My Business API client libraries wraps the functionality of the Google My Business API, and provide functionality common to all Google APIs, for example HTTP transport, error handling, authentication, JSON parsing, and support for protocol buffers.

This package contains the Service definition for MyBusiness and it depends on Google API PHP Client

You are welcome to contribute and ask for maintenance rights.

BIG NOTICE

Google is updating My Business API and exposing the new Service definitions in this library. https://github.com/googleapis/google-api-php-client-services. After the udpate is compleate this repository will be marked as DEPRECATED.

Requirements:

Google API PHP Client URL: https://github.com/google/google-api-php-client/releases

How to install

The easiest way to install is with composer.

composer require bronhy/google-my-business-php-client

Semantic Versioning

Do notice that google is not following semantic versioning RFC https://semver.org/ with this library. Since this package reflects the google versioning make sure that you lock to your version.

ie. composer require bronhy/google-my-business-php-client:4.8

Configure with Symfony framework

# config/services.yaml

parameters:
    app.google_credentials: '%env(json:base64:GOOGLE_CREDENTIALS)%' # exported json base64 encoded
    app.client_scope: 'https://www.googleapis.com/auth/plus.business.manage'
    app.redirect_url: '%env(GMB_REDIRECT_URI)%'

services:
    # default configuration for services in *this* file
    _defaults:
        autowire: true      # Automatically injects dependencies in your services.
        autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
    
    Google_Client:
        class: Google_Client
        calls:
            - method: setAuthConfig
              arguments:
                  - '%app.google_credentials%'
            - method: addScope
              arguments:
                  - '%app.client_scope%'
            - method: setAccessType
              arguments:
                  - 'offline'
            - method: setRedirectUri # handy for local dev ie. https://localhost:8443/index.php 
              arguments:
                  - '%app.redirect_url%'
            - method: setLogger
              arguments:
                      - '@monolog.logger'
        tags:
            - { name: monolog.logger, channel: google-api-php-client }

    Google_Service_MyBusiness:
        class: Google_Service_MyBusiness
        arguments: ['@Google_Client']

# HelloController.php
<?php

/**
 * @Route("/hello/world") name="hello_world" methods=("GET")
 *
 * @param Google_Service_MyBusiness $myBusiness

 *
 * @return JsonResponse
 */
public function helloWorld(Google_Service_MyBusiness $myBusiness)
{
    // some logic
    return JsonResponse(['HelloWorld']);
}

Detailed error responses

To enable more detailed error messages in responses, such as absent required fields, add the following additional header to your requests:

X-GOOG-API-FORMAT-VERSION: 2

For additional information on error message responses, see the ErrorCode, ErrorDetail, InternalError, and ValidationError pages in the Shared.Types section.

$client = new \Google_Client(['api_format_v2' => true]);

Or with symfony in service_dev.yaml

# config/services_dev.yaml
parameters:
    ...
    app.client_debug:
        api_format_v2: true
    ...
    Google_Client:
        class: Google_Client
        arguments: ['%app.client_debug%'] 
        calls:
    ...

Authentication script examples

Service Account

Get and include the Google_Client as described above.

# src/index.php
require dirname(__DIR__) . '/vendor/autoload.php';

$client = new \Google_Client();
$client->useApplicationDefaultCredentials();
// set the service account json file location manually
$client->setAuthConfig(__DIR__ . '/Data/service_account.json');
$client->setApplicationName("_Your_app_name_here_");
// set the scope to access GMBs
$client->setScopes([
    "https://www.googleapis.com/auth/business.manage"
]);
// if you have not enabled/ have access to GMB API you need to request it directly with Google and enable it through the project's API explorer; search for "Google My Business API"

bronhy / google-my-business-php-client

Maintainers

Details