کتابخانه های مشتری

کتابخانه‌های مشتری ما نماهای سطح بالا و بلوک‌های اصلی عملکرد Google Ads API را ارائه می‌کنند که توسعه سریع برنامه‌ها را آسان‌تر می‌کند. اگر تازه وارد API هستید، توصیه می کنیم با یکی شروع کنید.

نسخه های API پشتیبانی شده

جدول نشان می دهد که کتابخانه های سرویس گیرنده با کدام نسخه های API کار می کنند.

پیکربندی

هر کتابخانه Ads API Client تنظیمات پیکربندی و روش‌های بارگیری مختلفی را ارائه می‌کند که می‌توانید برای سفارشی کردن رفتار آن استفاده کنید.

در اینجا متغیرهای محیطی هستند که برای همه کتابخانه های سرویس گیرنده مشترک هستند و می توانند برای تنظیم تنظیمات پیکربندی بارگذاری شوند:

• کتابخانه مشتری
  • 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 : این مقدار را روی مسیر فایل پیکربندی OAuth2 JSON تنظیم کنید.
    • 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 معمولاً در برنامه‌های تعاملی که صفحات نتایج را نمایش می‌دهند استفاده می‌شود. اندازه صفحه 10000 نتیجه در هر صفحه ثابت شده است.

کتابخانه مشتری ما وقتی نتایج را تکرار می‌کنید به‌طور خودکار صفحه‌بندی را پیاده‌سازی می‌کند تا بتوانید به‌طور متوالی همه آنها را یک‌باره دانلود و پردازش کنید، برای مثال:

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

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::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 را بررسی کنید .