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

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

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

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

الإعداد

توفّر كل مكتبة من مكتبات عملاء Ads API إعدادات ضبط مختلفة و methodsتحميل يمكنك استخدامها لتخصيص سلوكها.

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

• مكتبة البرامج
  • 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). ضبط هذه القيمة إلى الرقم التعريفي للعميل لمزوّد البيانات الذي يعدِّل موارد الرقم التعريفي للعميل المحدد. يجب ضبطه بدون واصلة (-). للاطّلاع على مزيد من المعلومات عن الحسابات المرتبطة، يُرجى الانتقال إلى مركز المساعدة.

يتم عادةً تحديد متغيّرات البيئة في ملف إعدادات 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.
src ~/.bashrc

يمكن أيضًا ضبط متغيّرات البيئة في مثيل المحطة الطرفية مباشرةً من سطر الأوامر:

export GOOGLE_ADS_CLIENT_ID=1234567890

هناك بديل آخر وهو ضبط متغيّرات البيئة عند استدعاء الأمر الذي يستخدمها:

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

البحث بعدة صفحات

يتم استخدام 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());
      }
    }
  }
}
GetCampaigns.java
      

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V18.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;
    }
}
GetCampaigns.cs
      

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
        );
    }
}
GetCampaigns.php
      

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.'
            )
get_campaigns.py
      

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
get_campaigns.rb
      

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::V18::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;
}
get_campaigns.pl
      

أمثلة على الرموز البرمجية

اطلع على أمثلة التعليمات البرمجية لبعض الدوال الشائعة في Google Ads API: