ספריות לקוח

ספריות הלקוח של 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

ספריות קהילתיות

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

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

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

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

גרסת ספריית הלקוח המינימלית שמופיעה ברשימה מספיקה לגרסה העיקרית של Google Ads API (למשל גרסה 26). כדי לראות את הגרסה הנדרשת של ספריית הלקוח לגרסאות משניות, עיינו ביומן השינויים המקושר.

Java

יומן שינויים

ספריית לקוח ל-Java
v26 Min: 48.0.0
Max: -
v25 Min: 44.0.0
Max: -
v24 Min: 43.0.0
Max: -
v23 Min: 42.0.0
Max: -

C#‎

יומן שינויים

ספריית לקוח ל-‎ .NET
v26 Min: 27.5.0
Max: -
v25 Min: 26.1.0
Max: -
v24 Min: 25.3.0
Max: -
v23 Min: 25.1.0
Max: -

PHP

יומן שינויים

ספריית לקוח ל-PHP
v26 Min: 35.2.0
Max: -
v25 Min: 33.6.0
Max: -
v24 Min: 33.3.0
Max: -
v23 Min: 32.2.0
Max: -

Python

יומן שינויים

ספריית לקוח ל-Python
v26 Min: 34.0.0
Max: -
v25 Min: 31.2.0
Max: -
v24 Min: 30.1.0
Max: -
v23 Min: 29.2.0
Max: -

Ruby

יומן שינויים

ספריית לקוח ל-Ruby
v26 Min: 46.0.0
Max: -
v25 Min: 43.0.0
Max: -
v24 Min: 40.0.0
Max: -
v23 Min: 38.0.0
Max: -

Perl

יומן שינויים

ספריית לקוח ל-Perl
v26 Min: 36.0.0
Max: -
v25 Min: 33.0.0
Max: -
v24 Min: 32.0.0
Max: -
v23 Min: 31.0.0
Max: -

הגדרות אישיות

כל ספריית לקוח של 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: מגדירים את הערך הזה לנתיב של קובץ המפתח של OAuth2 JSON (ב-.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.V26.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::V26::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.