توفّر مكتبات عملاء Google Ads API طرق عرض عالية المستوى ووحدات إنشاء أساسية لوظائف Google Ads 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
إصدارات واجهة برمجة التطبيقات المتوافقة
يوضّح الجدول مكتبات البرامج التي تتوافق مع إصدارات واجهة برمجة التطبيقات.
إنّ الحدّ الأدنى لإصدار مكتبة البرامج المُدرَج كافٍ لإصدار Google Ads API الرئيسي (مثل الإصدار 25). للاطّلاع على إصدار مكتبة البرامج المطلوب للإصدارات الثانوية، يُرجى الرجوع إلى سجلّ التغيير المرتبط.
جافا
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. هذا الإعداد اختياري.
- وضع "بيانات الاعتماد التلقائية للتطبيق"
GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: اضبط هذه القيمة علىtrueللمصادقة باستخدام "بيانات الاعتماد التلقائية للتطبيق" (ADC). متوافق مع Javav41.1.0والإصدارات الأحدث وPythonv28.3.0والإصدارات الأحدث وRubyv36.1.0والإصدارات الأحدث (في .NETv24.1.0والإصدارات الأحدث، يقرأLoadFromEnvironmentVariables()المتغير غير المسبوقUSE_APPLICATION_DEFAULT_CREDENTIALSبدلاً من ذلك، أو اضبطUseApplicationDefaultCredentials = trueعلىGoogleAdsConfig. في PHP، يعودOAuth2TokenBuilderتلقائيًا إلى ADC عندما لا يتم ضبط أي بيانات اعتماد OAuth2 صريحة. لا تتوافق Perl مع ADC).
- وضع التطبيق
- Google Ads API
GOOGLE_ADS_DEVELOPER_TOKEN: اختياري في الإصدارات الأحدث (Javav46.0.0والإصدارات الأحدث و.NETv27.3.0والإصدارات الأحدث وPHPv35.0.0والإصدارات الأحدث وPythonv32.0.0والإصدارات الأحدث وRubyv45.0.0والإصدارات الأحدث وPerlv35.0.0والإصدارات الأحدث). تم إيقاف رموز المطوّرين المميزة نهائيًا في 9 سبتمبر 2026، وتتجاهل خوادم واجهة برمجة التطبيقات العنوانdeveloper-tokenبغض النظر عن إصدار مكتبة البرامج (إلى أن يرفضه رقم إصدار رئيسي مستقبلي من Google Ads API). لا تزال إصدارات مكتبة العملاء السابقة تتطلّب قيمة غير فارغة للتحقّق من الصحة على الجهاز المحلي من جهة العميل. راجِع دليل الإعداد لكل مكتبة للحصول على تفاصيل خاصة بالإصدار.GOOGLE_ADS_LOGIN_CUSTOMER_ID: هذا هو رقم تعريف العميل المصرّح له باستخدامه في الطلب، بدون شُرط (-).-
GOOGLE_ADS_LINKED_CUSTOMER_ID: هذا العنوان مطلوب فقط للطُرق التي تعدّل موارد كيان عند منح الإذن من خلال "الحسابات المرتبطة" في واجهة مستخدم "إعلانات Google" (الموردAccountLinkفي Google Ads API). اضبط هذه القيمة على رقم تعريف العميل الخاص بموفّر البيانات الذي يعدّل موارد رقم تعريف العميل المحدّد. يجب ضبطه بدون واصلات (-). لمزيد من المعلومات حول "الحسابات المرتبطة"، يُرجى الانتقال إلى مركز المساعدة.
يتم عادةً تحديد متغيّرات البيئة في ملف إعداد باش، مثل ملف .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 صفحة لكل صفحة.
تتولّى مكتبات البرامج تنفيذ التقسيم إلى صفحات تلقائيًا عند تكرار النتائج، ما يتيح لك تنزيلها ومعالجتها بالتسلسل دفعة واحدة.
جافا
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.