google-api-php-client icon indicating copy to clipboard operation
google-api-php-client copied to clipboard

Add the usage of "global HTTP batch endpoints" to the Developer Documentation?

Open kumamidori opened this issue 4 years ago • 3 comments

I'd like to send a PR if I am allowed to add the usage of "global HTTP batch endpoints" to the Developer Documentation.

On the other hand, I was concerned that not all APIs allow Batch Request, and that it is not a primary way of use. Is it necessary? Please give me your opinion.

Example:

$client = new Client();
$scopes = [
    PagespeedInsights::OPENID,
];
$client->setScopes($scopes);

$url = 'https://foo.bar.dummy.xxx.com';
$client->setDefer(true);
$client->setDeveloperKey('your-key-dummy');

$batch = new Batch($psDeferClient, false, null, 'batch/pagespeedonline/v1');

/** @var \GuzzleHttp\Psr7\Request $request */
$request = $pageSpeedDefer->pagespeedapi->runpagespeed($url);
$batch->add($request, 'foo');

$responses = $batch->execute();
foreach ($responses as $response) {
    /** @var PagespeedApiPagespeedResponseV5 $response */
    var_dump($response->getId());
}

kumamidori avatar Jul 28 '21 10:07 kumamidori

@kumamidori do you mean your PR resolve an issue about batch processing? I try to add multiple events in Google Calendar and i receive error 404 on $batch->execute();

allinfoservice avatar Jul 29 '21 15:07 allinfoservice

@allinfoservice It worked for me:

$client = new Client();
$client->setScopes(\Google\Service\Calendar::CALENDAR_READONLY);
$client->setDefer(true);
$client->setAuthConfig('/path/to/service/account/json');

$batch = new Batch($client, false, null, 'batch/calendar/v3');
$calendar = new \Google\Service\Calendar($client);
$calendarId = '[email protected]';
$request = $calendar->events->listEvents($calendarId, []);
$batch->add($request, 'foo');
$responses = $batch->execute();

ref. https://github.com/googleapis/google-api-php-client/issues/2052#issuecomment-802086060

kumamidori avatar Jul 30 '21 13:07 kumamidori

Excellent @kumamidori that works perfectly !

allinfoservice avatar Jul 31 '21 17:07 allinfoservice