การใช้งานพื้นฐาน

การใช้งานพื้นฐานของไลบรารีของไคลเอ็นต์มีดังนี้

การติดตั้ง

วิธีที่แนะนำในการติดตั้งไลบรารีคือการใช้ Bundler เพิ่มบรรทัด ใน Gemfile (แทนที่ x.y.z ด้วยหมายเลขเวอร์ชันที่คุณต้องการใช้)

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

จากนั้นเรียกใช้คำสั่งต่อไปนี้

bundle install

คำสั่งนี้ใช้ Bundler เพื่ออัปเดต Gemfile.lock โดยล็อกเวอร์ชันที่แน่นอนของ Gem และการขึ้นต่อกันทั้งหมดของ Gem ที่ติดตั้งไว้ ตัวดำเนินการเวอร์ชันที่เข้มงวด "~> x.y.z" ช่วยให้มั่นใจได้ว่า bundle install หรือ bundle update จะติดตั้งเฉพาะเวอร์ชันแพตช์ใหม่ในซีรีส์ x.y.* เท่านั้น ดังนั้นคุณ ต้องเลือกใช้เวอร์ชันย่อยหรือเวอร์ชันหลักใหม่ด้วยตนเองโดยการอัปเดต Gemfile

ตัวเลือกการติดตั้งอื่นๆ

หากไม่ได้ใช้ Bundler คุณสามารถใช้ตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้

  1. ติดตั้งไลบรารีนี้โดยใช้ RubyGems ดังนี้

    gem install google-ads-googleads

  2. ดาวน์โหลด Gem จากหน้าผลงาน แล้วติดตั้งจากไฟล์ในเครื่องโดยทำดังนี้ 

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

ตั้งค่าการตรวจสอบสิทธิ์

หากต้องการตรวจสอบสิทธิ์การเรียก API ให้กำหนดค่าไฟล์ google_ads_config.rb และทำตามวิธีการในหน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

การใช้งาน

ตั้งแต่ google-ads-googleads v41.1.0 เป็นต้นไป Gem จะรองรับ Bundler autorequire (Bundler.require) ในเวอร์ชันก่อน v41.1.0 (หรือเมื่อไม่ได้ใช้ 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

หลังจากคุ้นเคยกับตัวอย่างแล้ว ให้สำรวจFactory ซึ่งมีชุด เมธอดระดับสูงที่สะดวกสำหรับการทำงานกับ Google Ads API

การจัดการข้อผิดพลาด

การเรียก API ไม่ได้สำเร็จทุกครั้ง เซิร์ฟเวอร์จะยกเว้นหากการเรียก API ล้มเหลว คุณควรบันทึกข้อผิดพลาดของ API และจัดการข้อผิดพลาดเหล่านั้นอย่างเหมาะสม

ระบบจะสร้างอินสแตนซ์ Google::Ads::GoogleAds::Errors::GoogleAdsError เมื่อเกิดข้อผิดพลาดของ API ซึ่งมีรายละเอียดที่จะช่วยให้คุณทราบว่าเกิดข้อผิดพลาดใด และ คุณสามารถตั้งค่าฟังก์ชันตัวช่วยเพื่อจัดการข้อผิดพลาดได้ ดูตัวอย่าง ตัวแฮนเดิลข้อผิดพลาดใน GitHub