ספריות הלקוח של Google Ads API מספקות תצוגות ברמה גבוהה ואבני בניין בסיסיות של פונקציונליות Google Ads API, וכך מאפשרות לפתח אפליקציות במהירות. אם אתם חדשים ב-API, מומלץ להתחיל עם ספריית לקוח.
| ספריית לקוח | מקור | הפצה | דוגמאות לקוד |
|---|---|---|---|
| Java | google-ads-java | Maven, tar.gz, zip | הצגת הקוד ב-GitHub |
| .NET | google-ads-dotnet | NuGet, tar.gz, zip | הצגת הקוד ב-GitHub |
| PHP | google-ads-php | Composer, tar.gz, zip | הצגת הקוד ב-GitHub |
| Python | google-ads-python | PyPI, tar.gz, zip | הצגת הקוד ב-GitHub |
| Ruby | google-ads-ruby | RubyGems, tar.gz, zip | הצגת הקוד ב-GitHub |
| Perl | google-ads-perl | CPAN, tar.gz, zip | הצגת הקוד ב-GitHub |
ספריות קהילתיות
אנחנו מכירים כמה ספריות שמתוחזקות על ידי קהילת הקוד הפתוח. אנחנו שומרים על הרשימה הזו כדי לעזור למפתחים שמתעניינים בהם למצוא אותם. אנחנו לא בודקים את הספריות האלה, לא תורמים להן ולא מתחזקים אותן. השימוש בהן הוא על אחריותכם בלבד. אם יש לכם שאלות, עליכם לפנות לבעלים של פרויקטים בקוד פתוח.
אם אתם מכירים ספרייה שלא הוספנו, אתם יכולים ללחוץ על שליחת משוב בראש הדף ולספר לנו על כך.
- Node.js:
google-ads-apiב-npm - Go:
google-ads-pbב-GitHub
גרסאות API נתמכות
בטבלה מוצגות ספריות הלקוח שמתאימות לגרסאות ה-API השונות.
הגרסה המינימלית של ספריית הלקוח שמפורטת כאן מספיקה לגרסה העיקרית של Google Ads API (למשל, גרסה v25). כדי לראות את הגרסה הנדרשת של ספריית הלקוח לגרסאות משניות, אפשר לעיין ביומן השינויים המקושר.
Java
Google Ads API |
ספריית לקוח ל-Java |
v25 |
Min: 44.0.0Max: - |
v24 |
Min: 43.0.0Max: - |
v23 |
Min: 42.0.0Max: - |
C#
Google Ads API |
ספריית לקוח ל- .NET |
v25 |
Min: 26.1.0Max: - |
v24 |
Min: 25.3.0Max: - |
v23 |
Min: 25.1.0Max: - |
PHP
Google Ads API |
ספריית לקוח ל-PHP |
v25 |
Min: 33.6.0Max: - |
v24 |
Min: 33.3.0Max: - |
v23 |
Min: 32.2.0Max: - |
Python
Google Ads API |
ספריית לקוח ל-Python |
v25 |
Min: 31.2.0Max: - |
v24 |
Min: 30.1.0Max: - |
v23 |
Min: 29.2.0Max: - |
Ruby
Google Ads API |
ספריית לקוח ל-Ruby |
v25 |
Min: 43.0.0Max: - |
v24 |
Min: 40.0.0Max: - |
v23 |
Min: 38.0.0Max: - |
Perl
Google Ads API |
ספריית לקוח ל-Perl |
v25 |
Min: 33.0.0Max: - |
v24 |
Min: 32.0.0Max: - |
v23 |
Min: 31.0.0Max: - |
הגדרות אישיות
כל ספריית לקוח של Google Ads API מספקת הגדרות תצורה שונות ושיטות טעינה שבהן אפשר להשתמש כדי להתאים אישית את ההתנהגות שלה.
אלה משתני הסביבה הרגילים שבהם אפשר להשתמש כדי להגדיר את הספריות לקוח:
- ספריית לקוח
-
GOOGLE_ADS_CONFIGURATION_FILE_PATH: נתיב לקובץ התצורה (נקרא אוטומטית כשנטען מקובץ תצורה ללא ארגומנט נתיב מפורש ב-Java (fromPropertiesFile()), Perl (Client->new()), PHP (fromFile()), Python (load_from_storage(), נבדק גם על ידיload_from_env()) ו-Ruby (GoogleAdsClient.new). ב-.NET, טוענים את המשתנה הזה באופן מפורש באמצעותconfig.TryLoadFromEnvironmentFilePathאו טוענים קובצי תצורה באמצעותLoadFromSettingsJson,LoadFromConfigurationSectionאוLoadFromConfigurationRoot).
-
- OAuth2
- מצב אפליקציה
-
GOOGLE_ADS_CLIENT_ID: מגדירים את הערך הזה למזהה הלקוח של OAuth2. -
GOOGLE_ADS_CLIENT_SECRET: מגדירים את הערך הזה לסוד הלקוח של OAuth2. -
GOOGLE_ADS_REFRESH_TOKEN: אם רוצים לעשות שימוש חוזר בטוקנים של OAuth2, צריך להגדיר את הערך הזה לטוקן רענון של OAuth2 שנוצר מראש. ההגדרה הזו היא אופציונלית.
-
- מצב חשבון שירות
-
GOOGLE_ADS_JSON_KEY_FILE_PATH: מגדירים את הערך הזה לנתיב של קובץ מפתח JSON של OAuth2 (ב-.NET, מגדירים גם אתGOOGLE_ADS_OAUTH2_MODEל-SERVICE_ACCOUNT, כיOAuth2Modeמוגדר כברירת מחדל ל-APPLICATION; בגרסאות PHP מוקדמות יותר מ-v32.1.0או כשמשתמשים בהיקפי גישה מותאמים אישית, מגדירים גם את[OAUTH2] scopesב-google_ads_php.iniאו קוראים ל-withScopes(), כיfromEnvironmentVariables()לא קורא היקפי גישה של OAuth2 ממשתנה סביבתי). -
GOOGLE_ADS_IMPERSONATED_EMAIL: מגדירים את הערך הזה לכתובת האימייל של החשבון שמתחזים אליו כשמשתמשים בהענקת גישה ברמת הדומיין ב-Google Workspace. ההגדרה הזו היא אופציונלית.
-
- מצב Application Default Credentials
-
GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: מגדירים את הערך הזה ל-trueכדי לבצע אימות באמצעות Application Default Credentials (ADC). נתמך ב-Java מגרסהv41.1.0ואילך, ב-Python מגרסהv28.3.0ואילך וב-Ruby מגרסהv36.1.0ואילך (ב- .NET מגרסהv24.1.0ואילך,LoadFromEnvironmentVariables()קורא את המשתנהUSE_APPLICATION_DEFAULT_CREDENTIALSללא הקידומת, או מגדיר אתUseApplicationDefaultCredentials = trueב-GoogleAdsConfig; ב-PHP,OAuth2TokenBuilderעובר אוטומטית ל-ADC אם לא מוגדרים פרטי כניסה מפורשים של OAuth2; Perl לא תומך ב-ADC).
-
- מצב אפליקציה
- Google Ads API
-
GOOGLE_ADS_LOGIN_CUSTOMER_ID: מספר הלקוח המורשה שצריך להשתמש בו בבקשה, בלי מקפים (-). -
GOOGLE_ADS_LINKED_CUSTOMER_ID: הכותרת הזו נדרשת רק לשיטות שמעדכנות את המשאבים של ישות מסוימת כשההרשאה ניתנת דרך חשבונות מקושרים בממשק המשתמש של Google Ads (משאבAccountLinkב-Google Ads API). מגדירים את הערך הזה למזהה הלקוח של ספק הנתונים שמעדכן את המשאבים של מזהה הלקוח שצוין. צריך להזין אותו בלי מקפים (-). מידע נוסף על חשבונות מקושרים זמין במרכז העזרה.
-
בדרך כלל, משתני סביבה מוגדרים בקובץ תצורה של bash, כמו קובץ .bashrc או .bash_profile שנמצא בספרייה $HOME. אפשר גם להגדיר אותם באמצעות שורת הפקודה.
ריכזנו כאן כמה שלבים בסיסיים להגדרת משתנה סביבה באמצעות קובץ .bashrc באמצעות מסוף:
# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc
# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc
אפשר להגדיר משתני סביבה גם במופע הטרמינל ישירות משורת הפקודה:
export GOOGLE_ADS_CLIENT_ID=1234567890
אפשרות נוספת היא להגדיר משתני סביבה כשמפעילים את הפקודה שמשתמשת בהם:
GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php
אחזור ישויות
GoogleAdsService.SearchStream
משמש בדרך כלל לאחזור ישויות, והתוצאות מוחזרות כזרם של שורות. לחלופין, אפשר להשתמש ב-GoogleAdsService.Search כדי לאחזר ישויות דרך חיבור אינטרנט לא אמין. GoogleAdsService.Search
מחזירה תוצאות בגודל דף קבוע של 10,000 שורות בכל דף.
ספריות הלקוח מיישמות באופן אוטומטי את תכונת העמודים כשמבצעים איטרציה של התוצאות, כך שאפשר להוריד ולעבד את כולן בבת אחת.
Java
private void runExample(GoogleAdsClient googleAdsClient, long customerId) { try (GoogleAdsServiceClient googleAdsServiceClient = googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) { String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"; // Constructs the SearchGoogleAdsStreamRequest. SearchGoogleAdsStreamRequest request = SearchGoogleAdsStreamRequest.newBuilder() .setCustomerId(Long.toString(customerId)) .setQuery(query) .build(); // Creates and issues a search Google Ads stream request that will retrieve all campaigns. ServerStream<SearchGoogleAdsStreamResponse> stream = googleAdsServiceClient.searchStreamCallable().call(request); // Iterates through and prints all of the results in the stream response. for (SearchGoogleAdsStreamResponse response : stream) { for (GoogleAdsRow googleAdsRow : response.getResultsList()) { System.out.printf( "Campaign with ID %d and name '%s' was found.%n", googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName()); } } } }
C#
public void Run(GoogleAdsClient client, long customerId) { // Get the GoogleAdsService. GoogleAdsServiceClient googleAdsService = client.GetService( Services.V25.GoogleAdsService); // Create a query that will retrieve all campaigns. string query = @"SELECT campaign.id, campaign.name, campaign.network_settings.target_content_network FROM campaign ORDER BY campaign.id"; try { // Issue a search request. googleAdsService.SearchStream(customerId.ToString(), query, delegate (SearchGoogleAdsStreamResponse resp) { foreach (GoogleAdsRow googleAdsRow in resp.Results) { Console.WriteLine("Campaign with ID {0} and name '{1}' was found.", googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name); } } ); } catch (GoogleAdsException e) { Console.WriteLine("Failure:"); Console.WriteLine($"Message: {e.Message}"); Console.WriteLine($"Failure: {e.Failure}"); Console.WriteLine($"Request ID: {e.RequestId}"); throw; } }
PHP
public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId) { $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient(); // Creates a query that retrieves all campaigns. $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id'; // Issues a search stream request. /** @var GoogleAdsServerStreamDecorator $stream */ $stream = $googleAdsServiceClient->searchStream( SearchGoogleAdsStreamRequest::build($customerId, $query) ); // Iterates over all rows in all messages and prints the requested field values for // the campaign in each row. foreach ($stream->iterateAllElements() as $googleAdsRow) { /** @var GoogleAdsRow $googleAdsRow */ printf( "Campaign with ID %d and name '%s' was found.%s", $googleAdsRow->getCampaign()->getId(), $googleAdsRow->getCampaign()->getName(), PHP_EOL ); } }
Python
def main(client: GoogleAdsClient, customer_id: str) -> None: ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService") query: str = """ SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id""" # Issues a search request using streaming. stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream( customer_id=customer_id, query=query ) for batch in stream: rows: List[GoogleAdsRow] = batch.results for row in rows: print( f"Campaign with ID {row.campaign.id} and name " f'"{row.campaign.name}" was found.' )
Ruby
def get_campaigns(customer_id) # GoogleAdsClient will read a config file from # ENV['HOME']/google_ads_config.rb when called without parameters client = Google::Ads::GoogleAds::GoogleAdsClient.new responses = client.service.google_ads.search_stream( customer_id: customer_id, query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id', ) responses.each do |response| response.results.each do |row| puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found." end end end
Perl
sub get_campaigns { my ($api_client, $customer_id) = @_; # Create a search Google Ads stream request that will retrieve all campaigns. my $search_stream_request = Google::Ads::GoogleAds::V25::Services::GoogleAdsService::SearchGoogleAdsStreamRequest ->new({ customerId => $customer_id, query => "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id" }); # Get the GoogleAdsService. my $google_ads_service = $api_client->GoogleAdsService(); my $search_stream_handler = Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({ service => $google_ads_service, request => $search_stream_request }); # Issue a search request and process the stream response to print the requested # field values for the campaign in each row. $search_stream_handler->process_contents( sub { my $google_ads_row = shift; printf "Campaign with ID %d and name '%s' was found.\n", $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name}; }); return 1; }
curl
דוגמאות לקוד
כאן אפשר לעיין בדוגמאות קוד של כמה פונקציות נפוצות ב-Google Ads API.