مكتبات العملاء

توفّر مكتبات العملاء طرق عرض عالية المستوى والوحدات الأساسية لوظائف Google Ads API، ما يسهّل تطوير التطبيقات بسرعة. ننصحك بالبدء بواحدة إذا كنت جديدًا على واجهة برمجة التطبيقات.

مكتبة العميل المصدر التوزيع أمثلة على الرموز
Java google-ads-java Maven وtar.gz عرض على GitHub
‎.NET google-ads-dotnet nuget وtar.gz وzip عرض على GitHub
PHP google-ads-php tar.gz عرض على GitHub
Python google-ads-python tar.gz وzip عرض على GitHub
Ruby google-ads-ruby gem وtar.gz وzip عرض على GitHub
Perl google-ads-perl tar.gz وzip عرض على GitHub

مكتبات المنتدى

نحن على علم بالعديد من المكتبات التي يديرها منتدى البرامج المفتوحة المصدر. نحتفظ بهذه القائمة لمساعدة المطوّرين المهتمين في العثور عليها. نحن لا نختبر هذه المكتبات أو نساهم فيها أو نحافظ عليها، لذا يمكنك استخدامها على مسؤوليتك الخاصة. يجب توجيه أي أسئلة لديك إلى مالكي مشاريع المصادر المفتوحة.

إذا كنت تعرف مكتبة لم ندرجها، انقر على إرسال ملاحظات في أعلى الصفحة وأخبرنا بذلك.

إصدارات واجهة برمجة التطبيقات المتوافقة

يعرض الجدول مكتبات البرامج التي تعمل مع إصدارات واجهة برمجة التطبيقات.

Java

مكتبة برامج Java
v20 Min: 38.0.0
Max: -
v19 Min: 36.0.0
Max: -
v18 Min: 34.0.0
Max: -
v17 Min: 31.0.0
Max: 36.1.0

#C

مكتبة برامج لنظام ‎NET.
v20 Min: 23.0.0
Max: -
v19 Min: 22.1.0
Max: -
v18 Min: 21.1.0
Max: -
v17 Min: 20.1.0
Max: 22.2.0

PHP

مكتبة برامج للغة PHP
v20 Min: 28.0.0
Max: -
v19 Min: 26.1.0
Max: -
v18 Min: 25.0.0
Max: -
v17 Min: 23.1.0
Max: 27.2.0

Python

مكتبة برامج Python
v20 Min: 27.0.0
Max: -
v19 Min: 25.2.0
Max: -
v18 Min: 25.1.0
Max: -
v17 Min: 24.1.0
Max: 26.1.0

Ruby

مكتبة برامج Ruby
v20 Min: 34.0.0
Max: -
v19 Min: 32.0.0
Max: -
v18 Min: 31.0.0
Max: -

Perl

مكتبة برامج Perl
v20 Min: 27.0.0
Max: -
v19 Min: 26.0.0
Max: -
v18 Min: 25.0.1
Max: -

الإعداد

توفّر كل مكتبة لعميل واجهة برمجة التطبيقات في "إعلانات Google" إعدادات ضبط وطرق تحميل مختلفة يمكنك استخدامها لتخصيص سلوكها.

في ما يلي متغيّرات البيئة الشائعة في جميع مكتبات البرامج للعملاء والتي يمكن تحميلها لضبط إعدادات الضبط:

  • مكتبة العميل
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: مسار ملف الإعدادات
  • 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.
      • استبدِل GOOGLE_ADS_IMPERSONATED_EMAIL بعنوان البريد الإلكتروني للحساب الذي تريد انتحال شخصيته.
  • Google Ads API
    • استبدِل GOOGLE_ADS_DEVELOPER_TOKEN بالرمز المميز للمطوّر.
    • 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.
src ~/.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.V20.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, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            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::V20::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;
}
      

أمثلة على الرموز

اطّلِع على أمثلة الرموز البرمجية لبعض الوظائف الشائعة في Google Ads API.