ספריות לקוח

ספריות הלקוח שלנו מספקות תצוגות ברמה גבוהה ואבני בניין בסיסיות של פונקציונליות של Google Ads API שמאפשרת לפתח אפליקציות בקלות ובמהירות. ההמלצות שלנו בתחילתו של התהליך, אם זו הפעם הראשונה שאתם משתמשים ב-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

גרסאות API נתמכות

בטבלה אפשר לראות אילו ספריות לקוח פועלות עם אילו גרסאות של ממשקי API פועלות.

Java

ספריית לקוח ל-Java
v17 Min: 32.0.0
Max: –
v16 Min: 30.0.0
Max: –
v15 Min: 28.0.0
Max: 32.0.0

C#‎

ספריית לקוח ל- .NET
v17 Min: 20.1.0
Max: –
v16 Min: 18.1.0
Max: –
v15 Min: 17.1.0
Max: 20.1.0

PHP

ספריית לקוח ל-PHP
v17 Min: 23.1.0
Max: –
v16 Min: 22.1.0
Max: –
v15 Min: 21.1.0
Max: 23.1.0

Python

ספריית לקוח ל-Python
v17 Min: 24.1.0
Max: –
v16 Min: 23.1.0
Max: –
v15 Min: 22.1.0
Max: –

Ruby

ספריית לקוח ל-Ruby
v17 Min: 29.0.0
Max: –
v16 Min: 27.0.0
Max: –
v15 Min: 25.0.0
Max: –

Perl

ספריית לקוח ל-Perl
v17 Min: 23.0.0
Max: –
v16 Min: 21.0.0
Max: –
v15 Min: 19.0.0
Max: –

תצורה

כל ספריית לקוח של Ads API מספקת הגדרות תצורה שונות שיטות טעינה שבהן אפשר להשתמש כדי להתאים אישית את ההתנהגות.

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

  • ספריית לקוח
    • 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 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.
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 תוצאות בכל דף.

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

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

C#‎

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

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

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

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

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::V17::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