استفاده پایه از کتابخانه مشتری به این صورت است:
use Google\Ads\GoogleAds\Lib\OAuth2TokenBuilder;
use Google\Ads\GoogleAds\Lib\V26\GoogleAdsClientBuilder;
// Generate a refreshable OAuth 2.0 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())
->fromFile()
->build();
// Construct a Google Ads client configured from a properties file and the
// OAuth 2.0 credentials.
$googleAdsClient = (new GoogleAdsClientBuilder())
->fromFile()
->withOAuth2Credential($oAuth2Credential)
// Replace 1234567890 with your login customer ID.
->withLoginCustomerId(1234567890)
->build();
// Create the CampaignServiceClient.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
// Make calls to CampaignServiceClient.
راهاندازی کارخواه و سرویس
برای درخواست دادن به Google Ads API، ابتدا یک نمونه کارخواه را مقداردهی اولیه کنید و سپس از آن برای ایجاد یک کارخواه سرویس استفاده کنید.
ایجاد نمونه GoogleAdsClient
مهمترین کلاس در کتابخانه Google Ads API PHP کلاس GoogleAdsClient است. این کتابخانه به شما امکان میدهد اشیای کارخواه سرویس ازپیش پیکربندیشده ایجاد کنید که میتوان از آنها برای برقراری تماسهای میانای برنامهسازی کاربردی استفاده کرد. GoogleAdsClient چندین روش برای پیکربندی و نمونهسازی آن ارائه میدهد:
- از فایل
google_ads_php.iniاستفاده کنید. - متغیرهای محیط را تنظیم کنید.
- روشهای تنظیمکننده را در
GoogleAdsClientBuilderفراخوانی کنید.
برای کسب اطلاعات بیشتر، به راهنمای پیکربندی مراجعه کنید.
برای پیکربندی شیء GoogleAdsClient با تنظیمات صریح، شیء OAuth2TokenBuilder و شیء GoogleAdsClientBuilder ایجاد کنید و روشهای تنظیمکننده مناسب را فراخوانی کنید:
// Generate a refreshable OAuth 2.0 credential for authentication.
$oAuth2Credential = (new OAuth2TokenBuilder())
->withClientId('INSERT_CLIENT_ID_HERE')
->withClientSecret('INSERT_CLIENT_SECRET_HERE')
->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
->build();
// Construct a Google Ads client configured from explicit settings and the
// OAuth 2.0 credentials.
$googleAdsClient = (new GoogleAdsClientBuilder())
->withOAuth2Credential($oAuth2Credential)
// Replace 1234567890 with your login customer ID.
->withLoginCustomerId(1234567890)
->build();
ایجاد سرویس
GoogleAdsClient یک روش گیرنده برای هر شیء کارخواه سرویس ارائه میدهد.
برای مثال، برای ایجاد نمونهای از CampaignServiceClient، روش $googleAdsClient->getCampaignServiceClient() را، همانطور که در مثال قبلی نشان داده شده است، فراخوانی کنید.
مدیریت کردن خطا
همه فراخوانیهای میانای برنامهسازی کاربردی موفقیتآمیز نیستند. اگر فراخوانیهای میانای برنامهسازی کاربردی شما به دلیلی ناموفق باشد، سرور میتواند خطا ایجاد کند. مهم است که خطاهای میانای برنامهسازی کاربردی را ضبط کنید و آنها را بهدرستی مدیریت کنید.
وقتی خطای API رخ میدهد، نمونه GoogleAdsException ایجاد میشود. این پیام حاوی جزئیاتی است که به شما کمک میکند بفهمید چه مشکلی پیش آمده است:
use Google\Ads\GoogleAds\Lib\V26\GoogleAdsException;
use Google\ApiCore\ApiException;
try {
// Make your API call here.
} catch (GoogleAdsException $googleAdsException) {
printf(
"Request with ID '%s' has failed.%sGoogle Ads failure details:%s",
$googleAdsException->getRequestId(),
PHP_EOL,
PHP_EOL
);
foreach (
$googleAdsException->getGoogleAdsFailure()->getErrors() as $error
) {
printf(
"\t%s: %s%s",
$error->getErrorCode()->getErrorCode(),
$error->getMessage(),
PHP_EOL
);
}
} catch (ApiException $apiException) {
printf(
"ApiException was thrown with message '%s'.%s",
$apiException->getMessage(),
PHP_EOL
);
}