LaravelでGoogleカレンダーの予定作成時に「ゲストを追加」したい（Google Calendar API Service Account Error）

Question

前提・実現したいこと

実現したいことは、LaravelでGoogleカレンダーの予定を作成する際に**「ゲストを追加」機能**を実装したいです。

LaravelでGoogleカレンダーと連携したシステムを構築しています。laravel-google-calendarというパッケージを使用し、Googleカレンダーを操作する機能を実装しています。Googleの認証にはサービスアカウントを使用しています。PostmanからLaravelにリクエストを投げて機能の検証をしています。

発生している問題・エラーメッセージ

• Googleカレンダーから予定を追加する機能は実装できた

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Spatie\GoogleCalendar\Event;
use Illuminate\Support\Carbon;

class CalendarController extends Controller
{
    public function store()
    {
        $event = new Event;
        $event->name = '検証用';
        $event->startDateTime = Carbon::now();
        $event->endDateTime = Carbon::now()->addHour();
        $event->description = "テスト説明文\nテスト説明文\nテスト説明文";
        $event->save();

        return '成功';
    }

予定を追加する機能に、「ゲストを追加」できる機能も実装したいです。そこで、laravel-google-calendarのaddAttendeeメソッドを使用するとエラーが表示されます。

    public function store()
    {
        $event = new Event;
        $event->name = '検証用';
        $event->startDateTime = Carbon::now();
        $event->endDateTime = Carbon::now()->addHour();
        $event->addAttendee(['email' => '[e-mail]']); // この一行を追加
        $event->description = "テスト説明文\nテスト説明文\nテスト説明文";
        $event->save();

        return '成功';
    }

返却されたエラー↓

Google\Service\Exception: {
    "error": {
        "errors": [
            {
                "domain": "calendar",
                "reason": "forbiddenForServiceAccounts",
                "message": "Service accounts cannot invite attendees without Domain-Wide Delegation of Authority."
            }
        ],
        "code": 403,
        "message": "Service accounts cannot invite attendees without Domain-Wide Delegation of Authority."
    }
}
 in file /var/www/vendor/google/apiclient/src/Http/REST.php on line 128

実装手順1（Google APIを利用するためのサービスアカウントの設定）

1. Google Cloud Platformへのログイン
2. プロジェクトを作成
3. Google Calendar APIの有効化.
4. サービスアカウントを作成
5. サービスアカウントでキーを作成

参考にした記事

実装手順2（サービスアカウントへのドメイン全体の権限の委任の有効化）

サービスアカウントにドメイン全体の委任を有効

1. 作成したサービスアカウントに画面遷移
2. 編集ボタンを押下
3. 「G Suite ドメイン全体の委任を有効にする」チェックボタンを押下
4. 保存

サービスアカウントにカレンダースコープを提供

1. Google Adminにログイン
2. 「セキュリティ」 → 「APIの制御」 → 「ドメイン全体の委任」に移動
3. サービスアカウントで発行されたクライアントIDを元にAPIクライアントを追加
4. 追加したスコープ　https://www.googleapis.com/auth/calendar,https://www.googleapis.com/auth/calendar.events,https://www.googleapis.com/auth/admin.directory.resource.calendar

IAMの設定

1. Google Cloud PlatformのIAMの画面にログイン
2. サービスアカウントで作成したメールをIAMにオーナー権限で追加

実装手順3（Googleカレンダーの設定）

アカウントA（[e-mail]）とアカウントB（[e-mail]）の設定

1. カレンダーの追加
2. カレンダーのアクセス設定
3. 特定のユーザーとの共有設定でサービスアカウントで発行されたメールをを設定
4. 権限は「予定の変更」
5. カレンダーIDの取得

実装手順4（Laravel）

• Composerでlaravel-google-calendar "2.2.2"をインストール
• サービスプロバイダーの設定
• config/google-calendar.phpの設定

return [

    /*
     * Path to the json file containing the credentials.
     */
    'service_account_credentials_json' => storage_path('app/google-calendar/service-account-credentials.json'),

    /*
     *  The id of the Google Calendar that will be used by default.
     */
    'calendar_id' => env('GOOGLE_CALENDAR_ID'),
];

• app/google-calendar配下にサービスアカウントでダウンロードしたファイルをservice-account-credentials.json名で保存
• ルーティングの設定

Route::resource(
    'calendar',
    'CalendarController',
    ['only' => ['index', 'store']]
);

• コントローラの設定

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Spatie\GoogleCalendar\Event;
use Illuminate\Support\Carbon;

class CalendarController extends Controller
{
    public function index()
    {
        $event = new Event;
        $events = Event::get();
        foreach ($events as $event) {
            echo $event->name . '';
        }
    }

    public function store()
    {
        $event = new Event;
        $event->name = '検証用';
        $event->startDateTime = Carbon::now();
        $event->endDateTime = Carbon::now()->addHour();
        $event->addAttendee(['email' => '[e-mail]']);
        $event->description = "テスト説明文\nテスト説明文\nテスト説明文";
        $event->save();

        return '成功';
    }

• .envの設定

GOOGLE_CALENDAR_ID=[e-mail]

補足情報（FW/ツールのバージョンなど）

Laravel 5.8.36
PHP 7.3
spatie/laravel-google-calendar 2.2.2

参考にした記事

https://stackoverflow.com/questions/60760959/google-calendar-api-service-account-error
https://issuetracker.google.com/issues/141704931
https://github.com/spatie/laravel-google-calendar/issues/125

Answer 1

「パッケージ」と「認証方法」を変更して、ゲストを追加機能を実装しました。

• パッケージは、「laravel-google-calendar」から「google-api-php-client」に変更
• 認証は、「サービスアカウント」から「Oauth」に変更
• 実装方法は、「How to Integrate Google Calendar with a Laravel Site」「INTEGRATING GOOGLE CALENDAR API IN LARAVEL」「PHP Quickstart」「create-events」の記事を参考

ゲストを追加するコード（Oauthで認証が通っているのが前提）

use Google_Client;
use Google_Service_Calendar;
use Google_Service_Calendar_Event;
use Google_Service_Calendar_EventAttendee;

private function getClient()
{
    $client = new Google_Client();
    $client->setApplicationName('Calendar integration');
    $client->setAuthConfig(storage_path('app/google-calendar/hoge.json'));
    $client->setAccessType("offline");
    $client->setIncludeGrantedScopes(true);
    $client->setApprovalPrompt('force');
    $client->setRedirectUri('http://localhost/hoge');
    $client->addScope(Google_Service_Calendar::CALENDAR);

    return $client;
}

$client = $this->getClient();
$service = new Google_Service_Calendar($client);

$calendarId = 'primary';
$event = new Google_Service_Calendar_Event([
    'summary' => '検証用の予定',
    'start' => [
        'dateTime' => Carbon::now()
    ],
    'end' => [
        'dateTime' => Carbon::now()->addHour(),
    ]
]);

$attendeeNew = new Google_Service_Calendar_EventAttendee();
$attendeeNew->setEmail('[e-mail]'); // 招待メールアドレス
$attendeeNew->setDisplayName("テスト");

$attendees = $event->getAttendees();
array_push($attendees, $attendeeNew);
$event->setAttendees($attendees);

$event = $service->events->insert($calendarId, $event);