‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

אימות והרשאה

כמו ממשקי Google API אחרים, Google Ads API משתמש בפרוטוקול OAuth 2.0 לאימות ולהרשאה. פרוטוקול OAuth 2.0 מאפשר לאפליקציית הלקוח של Google Ads API לגשת לחשבון Google Ads של המשתמש בלי לטפל בפרטי ההתחברות של המשתמש או לאחסן אותם.

הסבר על מודל הגישה של Google Ads

כדי לעבוד ביעילות עם Google Ads API, חשוב להבין איך פועל מודל הגישה של Google Ads. מדריך למודל הגישה של Google Ads

תהליכי עבודה של OAuth

יש שלושה תהליכי עבודה נפוצים כשעובדים עם Google Ads API.

תהליך של חשבון שירות

זהו תהליך העבודה המומלץ אם תהליך העבודה שלכם לא דורש אינטראקציה אנושית. תהליך העבודה הזה מחייב שלב הגדרה, שבו המשתמש מוסיף חשבון שירות לחשבון Google Ads שלו. לאחר מכן, האפליקציה יכולה להשתמש בפרטי הכניסה של חשבון השירות כדי לנהל את חשבון Google Ads של המשתמש. כדי להגדיר את זה, יוצרים ומורידים את קובץ המפתח בפורמט JSON במסוף Google Cloud, מעתיקים את google_ads_config.rb לספריית הבית ומשנים אותו כדי לציין את המיקום של קובץ המפתח של חשבון השירות (ואת כתובת האימייל האופציונלית של המשתמש שרוצים להתחזות אליו כשמשתמשים בהענקת גישה ברמת הדומיין ב-Google Workspace):

# You can also authenticate using a service account. If "keyfile" is
# specified below, then service account authentication will be assumed and
# the above authentication fields ignored. Read more about service account
# authentication here:
# https://developers.google.com/google-ads/api/docs/oauth/service-accounts
c.keyfile = 'path/to/keyfile.json'
# Optional unless using Google Workspace domain-wide delegation:
c.impersonate = 'INSERT_EMAIL_ADDRESS_TO_IMPERSONATE_HERE'

אם אתם מעדיפים לא לאחסן את המידע הזה בקובץ, אלא להשתמש במשתני סביבה, אתם יכולים להגדיר את GOOGLE_ADS_JSON_KEY_FILE_PATH (ואת GOOGLE_ADS_IMPERSONATED_EMAIL האופציונלי):

export GOOGLE_ADS_JSON_KEY_FILE_PATH="/path/to/your/service-account-key.json"
# Optional unless using Google Workspace domain-wide delegation:
export GOOGLE_ADS_IMPERSONATED_EMAIL="your_email@email.com"

אפשר גם להעביר את הנתיב של קובץ המפתח של חשבון השירות (ואת כתובת האימייל האופציונלית של ההתחזות) באופן פרוגרמטי בזמן הריצה:

require 'google/ads/google_ads'

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.keyfile = '/path/to/your/service-account-key.json'
  # Optional unless using Google Workspace domain-wide delegation:
  config.impersonate = 'INSERT_EMAIL_ADDRESS_TO_IMPERSONATE_HERE'
end

לחלופין, אתם יכולים להשתמש ב-gem‏ googleauth כדי ליצור פרטי כניסה לחשבון שירות ולהעביר את credentials.updater_proc אל config.authentication:

require 'googleauth'
require 'google/ads/google_ads'

# Path to your service account key file.
key_file = '/path/to/your/service-account-key.json'

# Define the scopes needed for the Google Ads API.
scopes = ['https://www.googleapis.com/auth/adwords']

# Create service account credentials.
credentials = File.open(key_file) do |io|
  Google::Auth::ServiceAccountCredentials.make_creds(
    json_key_io: io,
    scope: scopes
  )
end

# Initialize the Google Ads API client with these credentials.
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  # Inject the service account credential updater proc.
  config.authentication = credentials.updater_proc
end

מידע נוסף זמין במדריך לתהליך העבודה של חשבון שירות.

תהליך אימות של משתמש יחיד

אפשר להשתמש בתהליך העבודה הזה אם אתם לא יכולים להשתמש בחשבונות שירות. תהליך העבודה הזה דורש שני שלבי הגדרה:

לתת למשתמש אחד גישה לכל החשבונות שצריך לנהל באמצעות Google Ads API. גישה נפוצה היא לתת למשתמש גישה לחשבון ניהול ב-Google Ads API, ולקשר את כל חשבונות Google Ads לחשבון הניהול הזה.
המשתמש מריץ כלי של שורת הפקודה, כמו כלי שורת הפקודה של Google Cloud או דוגמת הקוד של GenerateUserCredentials, כדי לתת לאפליקציה הרשאה לנהל את כל חשבונות Google Ads שלו בשמו.

כדי להגדיר את פרטי הכניסה של OAuth 2.0 ל-Ruby, מעתיקים את הקובץ google_ads_config.rb לספריית הבית ומשנים אותו כך שיכלול את מזהה הלקוח, סוד הלקוח וטוקן הרענון:

# Authentication tells the API that you are allowed to make changes to the
# specific account you're trying to access.
# The default method of authentication is to use a refresh token, client id,
# and client secret to generate an access token.
c.client_id = 'INSERT_CLIENT_ID_HERE'
c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'

הלקוח קורא באופן אוטומטי את קובץ התצורה מספריית הבית אם הוא נוצר ללא ארגומנטים:

client = Google::Ads::GoogleAds::GoogleAdsClient.new

לחלופין, אם אתם מעדיפים לאחסן את הקובץ במקום אחר, אתם יכולים ליצור מופע של הלקוח על ידי העברת הנתיב למקום שבו אתם שומרים את הקובץ:

client = Google::Ads::GoogleAds::GoogleAdsClient.new(
  'path/to/google_ads_config.rb'
)

אם אתם מעדיפים לא לאחסן את המידע הזה בקובץ, אלא להשתמש במשתני סביבה, אתם יכולים להגדיר כל אחד מהם:

export GOOGLE_ADS_CLIENT_ID="INSERT_CLIENT_ID_HERE"
export GOOGLE_ADS_CLIENT_SECRET="INSERT_CLIENT_SECRET_HERE"
export GOOGLE_ADS_REFRESH_TOKEN="INSERT_REFRESH_TOKEN_HERE"

אפשר גם להעביר את המידע באופן פרוגרמטי בזמן הריצה:

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  config.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  config.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
end

מידע נוסף זמין במדריך לתהליך העבודה של אימות משתמש יחיד.

תהליך אימות של משתמשים מרובים

זהו תהליך העבודה המומלץ אם האפליקציה שלכם מאפשרת למשתמשים להיכנס לחשבון ולאשר לאפליקציה לנהל את חשבונות Google Ads שלהם בשמם. האפליקציה יוצרת ומנהלת את פרטי הכניסה של המשתמשים ב-OAuth 2.0. אפשר להגדיר את תהליך העבודה הזה באופן דומה לתהליך של משתמש יחיד, ולציין גם את login_customer_id.

מומלץ להשתמש בקובץ תצורה. מעתיקים את הקובץ google_ads_config.rb לספריית הבית ומשנים אותו כך שיכלול את מזהה הלקוח, סוד הלקוח, טוקן הרענון ומספר הלקוח:

# Authentication tells the API that you are allowed to make changes to the
# specific account you're trying to access.
# The default method of authentication is to use a refresh token, client id,
# and client secret to generate an access token.
c.client_id = 'INSERT_CLIENT_ID_HERE'
c.client_secret = 'INSERT_CLIENT_SECRET_HERE'
c.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. If you need to use different values for this field, then
# make sure to fetch a new copy of the service after each time you change the
# value.
c.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'

הלקוח קורא באופן אוטומטי את קובץ התצורה מספריית הבית אם הוא נוצר ללא ארגומנטים:

client = Google::Ads::GoogleAds::GoogleAdsClient.new

client = Google::Ads::GoogleAds::GoogleAdsClient.new(
  'path/to/google_ads_config.rb'
)

אם אתם מעדיפים לא לאחסן את המידע הזה בקובץ, אלא להשתמש במשתני סביבה, אתם יכולים להגדיר כל אחד מהם:

export GOOGLE_ADS_CLIENT_ID="INSERT_CLIENT_ID_HERE"
export GOOGLE_ADS_CLIENT_SECRET="INSERT_CLIENT_SECRET_HERE"
export GOOGLE_ADS_REFRESH_TOKEN="INSERT_REFRESH_TOKEN_HERE"
export GOOGLE_ADS_LOGIN_CUSTOMER_ID="INSERT_LOGIN_CUSTOMER_ID_HERE"

אפשר גם להעביר את המידע באופן פרוגרמטי בזמן הריצה:

client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.client_id = 'INSERT_CLIENT_ID_HERE'
  config.client_secret = 'INSERT_CLIENT_SECRET_HERE'
  config.refresh_token = 'INSERT_REFRESH_TOKEN_HERE'
  config.login_customer_id = 'INSERT_LOGIN_CUSTOMER_ID_HERE'
end

מידע נוסף זמין במדריך לתהליך העבודה של אימות משתמשים מרובים. ספריית הלקוח של Ruby כוללת דוגמת קוד לעיון. דוגמת הקוד של שורת הפקודה GenerateUserCredentials ממחישה איך לקבל אימות משתמש בזמן הריצה כדי לנהל את חשבונות Google Ads בשמו. אתם יכולים להשתמש בדוגמת הקוד הזו כקובץ עזר כדי ליצור אפליקציות למחשב שדורשות אימות משתמשים.

ניהול חשבונות מרובים

משתמשים רבים מנהלים יותר מחשבון Google Ads אחד, באמצעות גישה ישירה לחשבונות או באמצעות חשבון ניהול ב-Google Ads. בספריית הלקוח של Ruby יש את דוגמאות הקוד הבאות שמראות איך לטפל במקרים כאלה:

בדוגמת הקוד של GetAccountHierarchy אפשר לראות איך לאחזר את רשימת כל החשבונות שמשויכים לחשבון ניהול ב-Google Ads.
בדוגמת הקוד ב-ListAccessibleCustomers מוסבר איך לאחזר את רשימת כל החשבונות שלמשתמש יש גישה ישירה אליהם. אפשר להשתמש בחשבונות האלה כערכים תקינים להגדרה login_customer_id.

Application Default Credentials

ספריית הלקוח של Ruby (גרסה 36.1.0 ואילך) תומכת גם באימות באמצעות Application Default Credentials ‏ (ADC). היא מאפשרת להגדיר את פרטי הכניסה שמוגדרים כברירת מחדל לאפליקציה, בלי שתצטרכו להגדיר את פרטי OAuth 2.0 בהגדרות האפליקציה.

האפשרות הזו שימושית במיוחד לפיתוח מקומי או לפיתוח מול ממשקי Google API שונים, כי אפשר להשתמש שוב באותם פרטי כניסה, בתנאי שהם יכולים לגשת להיקפי ההרשאות הנדרשים של OAuth 2.0.

ב-Google Ads API, ודאו שפרטי הכניסה שמוגדרים כברירת מחדל באפליקציה יכולים לגשת להיקף ההרשאות של OAuth 2.0 ב-https://www.googleapis.com/auth/adwords.

כדי להשתמש ב-Application Default Credentials, משתמשים בכלי שורת הפקודה של Google Cloud ומבצעים אימות ל-ADC:

gcloud auth application-default login

הפקודה הזו פותחת דפדפן אינטרנט כדי להשלים את תהליך האימות של חשבון Google. אחרי האימות, פרטי הכניסה נשמרים במיקום סטנדרטי. לאחר מכן, צריך לעדכן את האפליקציה כדי להשתמש ב-ADC.

מעתיקים את הקובץ google_ads_config.rb לספריית הבית ומגדירים את use_application_default_credentials ל-true:

# You can also authenticate using Application Default Credentials (ADC).
# To understand how ADC discovers credentials in a given environment, see:
# https://developers.google.com/identity/protocols/application-default-credentials
c.use_application_default_credentials = true

אם אתם מעדיפים לא לאחסן את המידע הזה בקובץ, אלא להשתמש במשתני סביבה, אתם יכולים להגדיר את GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS:

export GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS="true"

אפשר גם להעביר את המידע באופן פרוגרמטי בזמן הריצה. כשמאתחלים את הלקוח בקוד Ruby, מגדירים את config.use_application_default_credentials = true ולא מספקים פרטי כניסה מפורשים ל-OAuth 2.0. הספרייה מזהה באופן אוטומטי את פרטי הכניסה שהוגדרו על ידי כלי שורת הפקודה של Google Cloud, ומשתמשת בהם:

# Initialize the client using Application Default Credentials.
client = Google::Ads::GoogleAds::GoogleAdsClient.new do |config|
  config.use_application_default_credentials = true

  # Optional: Specify a login customer ID if you are accessing accounts
  # through a manager account.
  # config.login_customer_id = 'YOUR_LOGIN_CUSTOMER_ID'

  # Do NOT include client_id, client_secret, or refresh_token here.
end

בדף ההגדרות מפורטות האפשרויות הזמינות להגדרת ספריית הלקוח של Ruby.