לכל שירותי Google Ads API יש הגדרות ברירת מחדל, כולל זמנים קצובים לתפוגה שבהם נעשה שימוש בהעברה. לכל שירות של גרסה נתונה של Google Ads API יש קובץ JSON ייעודי עם הגדרות ברירת המחדל האלה ברמת השירות והשיטה. לדוגמה, הקבצים שקשורים לגרסה האחרונה של Google Ads API מופיעים כאן.
הגדרות ברירת המחדל מתאימות לרוב התרחישים לדוגמה, אבל יכול להיות שבמקרים מסוימים תצטרכו לשנות אותן. ספריית הלקוח ל-PHP תומכת בשינוי הגדרות הזמן הקצוב לתפוגה של הפעלות בסטרימינג בשרת וגם בשיחות אונריות.
אפשר להגדיר את הזמן הקצוב לתפוגה של שעתיים או יותר, אבל ה-API עדיין עשוי לגרום לפסק זמן ממושך מאוד של בקשות ממושכות, ולהחזיר את השגיאה DEADLINE_EXCEEDED.
עקיפת הזמן הקצוב לתפוגה של שיחת סטרימינג של שרת
שיטת השירות היחידה של Google Ads API שמשתמשת בסוג הקריאה הזה היא GoogleAdsService.SearchStream.
כדי לשנות את ברירת המחדל עבור הזמן הקצוב לתפוגה, צריך להוסיף פרמטר נוסף כשמפעילים את השיטה:
private static function makeServerStreamingCall(
GoogleAdsClient $googleAdsClient,
int $customerId
) {
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves all campaign IDs.
$query = 'SELECT campaign.id FROM campaign';
$output = '';
try {
// Issues a search stream request by setting a custom client timeout.
/** @var GoogleAdsServerStreamDecorator $stream */
$stream = $googleAdsServiceClient->searchStream(
SearchGoogleAdsStreamRequest::build($customerId, $query),
[
// Any server streaming call has a default timeout setting. For this
// particular call, the default setting can be found in the following file:
// https://github.com/googleads/google-ads-php/blob/master/src/Google/Ads/GoogleAds/V16/Services/resources/google_ads_service_client_config.json.
//
// When making a server streaming call, an optional argument is provided and can
// be used to override the default timeout setting with a given value.
'timeoutMillis' => self::CLIENT_TIMEOUT_MILLIS
]
);
// Iterates over all rows in all messages and collects the campaign IDs.
foreach ($stream->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$output .= ' ' . $googleAdsRow->getCampaign()->getId();
}
print 'The server streaming call completed before the timeout.' . PHP_EOL;
} catch (ApiException $exception) {
if ($exception->getStatus() === ApiStatus::DEADLINE_EXCEEDED) {
print 'The server streaming call did not complete before the timeout.' . PHP_EOL;
} else {
// Bubbles up if the exception is not about timeout.
throw $exception;
}
} finally {
print 'All campaign IDs retrieved:' . ($output ?: ' None') . PHP_EOL;
}
}
ביטול זמני קצוב לתפוגה של שיחה אונרית
רוב שיטות השירות של Google Ads API משתמשות בקריאות אונריות. דוגמאות אופייניות הן GoogleAdsService.Search ו-GoogleAdsService.Mutate.
כדי לשנות את ברירת המחדל עבור הזמן הקצוב לתפוגה, צריך להוסיף פרמטר נוסף כשמפעילים את השיטה:
private static function makeUnaryCall(GoogleAdsClient $googleAdsClient, int $customerId)
{
$googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
// Creates a query that retrieves all campaign IDs.
$query = 'SELECT campaign.id FROM campaign';
$output = '';
try {
// Issues a search request by setting a custom client timeout.
$response = $googleAdsServiceClient->search(
SearchGoogleAdsRequest::build($customerId, $query),
[
// Any unary call is retryable and has default retry settings.
// Complete information about these settings can be found here:
// https://googleapis.github.io/gax-php/master/Google/ApiCore/RetrySettings.html.
// For this particular call, the default retry settings can be found in the
// following file:
// https://github.com/googleads/google-ads-php/blob/master/src/Google/Ads/GoogleAds/V16/Services/resources/google_ads_service_client_config.json.
//
// When making an unary call, an optional argument is provided and can be
// used to override the default retry settings with given values.
'retrySettings' => [
// Sets the maximum accumulative timeout of the call, it includes all tries.
'totalTimeoutMillis' => self::CLIENT_TIMEOUT_MILLIS,
// Sets the timeout that is used for the first try to one tenth of the
// maximum accumulative timeout of the call.
// Note: This overrides the default value and can lead to
// RequestError.RPC_DEADLINE_TOO_SHORT errors when too small. We recommend
// to do it only if necessary.
'initialRpcTimeoutMillis' => self::CLIENT_TIMEOUT_MILLIS / 10,
// Sets the maximum timeout that can be used for any given try to one fifth
// of the maximum accumulative timeout of the call (two times greater than
// the timeout that is used for the first try).
'maxRpcTimeoutMillis' => self::CLIENT_TIMEOUT_MILLIS / 5
]
]
);
// Iterates over all rows in all messages and collects the campaign IDs.
foreach ($response->iterateAllElements() as $googleAdsRow) {
/** @var GoogleAdsRow $googleAdsRow */
$output .= ' ' . $googleAdsRow->getCampaign()->getId();
}
print 'The unary call completed before the timeout.' . PHP_EOL;
} catch (ApiException $exception) {
if ($exception->getStatus() === ApiStatus::DEADLINE_EXCEEDED) {
print 'The unary call did not complete before the timeout.' . PHP_EOL;
} else {
// Bubbles up if the exception is not about timeout.
throw $exception;
}
} finally {
print 'All campaign IDs retrieved:' . ($output ?: ' None') . PHP_EOL;
}
}