استفاده پایه

استفاده پایه از کتابخانه مشتری به این صورت است:

نصب

روش توصیه‌شده برای نصب کتابخانه استفاده از Bundler است. خطی به Gemfile اضافه کنید (x.y.z را با شماره نسخه‌ای که می‌خواهید استفاده کنید جایگزین کنید):

gem 'google-ads-googleads', '~> x.y.z'

سپس اجرا شود:

bundle install

این فرمان از Bundler برای به‌روزرسانی Gemfile.lock شما استفاده می‌کند و آن را روی نسخه دقیق سنگ یمانی و همه وابستگی‌های سنگ یمانی نصب‌شده قفل می‌کند. کاربر نسخه بدبینانه "~> x.y.z" تضمین می‌کند که bundle install یا bundle update فقط نسخه‌های وصله جدید را در سری x.y.* نصب می‌کند، بنابراین باید با به‌روزرسانی Gemfile خود، به‌صورت دستی نسخه‌های فرعی یا اصلی جدید را انتخاب کنید.

سایر گزینه‌های نصب

اگر از «دسته‌بند» استفاده نمی‌کنید، می‌توانید از یکی از این گزینه‌ها استفاده کنید:

1. این کتابخانه را بااستفاده از RubyGems نصب کنید:

   gem install google-ads-googleads
   

2. ‫gem را از صفحه «نسخه‌های پخش» بارگیری کنید و آن را از فایل محلی نصب کنید:

   gem install google-ads-googleads-[version].gem
   

راه‌اندازی اصالت‌سنجی

برای اصالت‌سنجی کردن تماس‌های API، فایل google_ads_config.rb را پیکربندی کنید و دستورالعمل‌های صفحه اصالت‌سنجی و صدور مجوز را دنبال کنید.

کاربرد

از google-ads-googleads نسخه ۴۱.۱.۰، این gem از Bundler autorequire (Bundler.require) پشتیبانی می‌کند. در نسخه‌های قبل‌از نسخه ۴۱.۱.۰ (یا وقتی از Bundler.require استفاده نمی‌کنید)، این gem را به‌طور صریح در کدتان الزامی کنید:

require 'google/ads/google_ads'

کارخواه را مقداردهی اولیه کنید (که پیکربندی را به‌طور پیش‌فرض از ~/google_ads_config.rb بار می‌کند) و سرویس خاصی مثل CampaignService را واکشی کنید:

# Initialize the client using ~/google_ads_config.rb.
client = Google::Ads::GoogleAds::GoogleAdsClient.new

# Fetch the CampaignService client.
campaign_service = client.service.campaign

برای نمایش دقیق‌تر نحوه استفاده از کتابخانه، مثال‌های GitHub را ببینید.

پس‌از آشنایی با نمونه‌ها، کارخانه‌ها را کاوش کنید، که مجموعه‌ای از روش‌های سطح بالا برای کار با Google Ads API ارائه می‌دهند.

مدیریت کردن خطا

همه فراخوانی‌های API موفق نیستند. اگر فراخوانی‌های API شما ناموفق باشد، سرور استثناهایی را ایجاد می‌کند. مهم است که خطاهای API را ضبط کنید و آن‌ها را به‌درستی مدیریت کنید.

وقتی خطای API رخ می‌دهد، نمونه Google::Ads::GoogleAds::Errors::GoogleAdsError ایجاد می‌شود. این تابع حاوی جزئیاتی است که به شما کمک می‌کند بفهمید چه مشکلی پیش آمده است و می‌توانید تابع کمکی را برای رسیدگی به خطاها راه‌اندازی کنید. مثالی از کنترل‌کننده خطا در GitHub را ببینید.