הזרמת דוחות באמצעות GoogleAdsService

כדי לאחזר ישויות ונתוני דיווח של Google Ads API, אפשר להשתמש באחת מהשיטות הבאות:

אלה ההבדלים העיקריים בין שתי השיטות:

GoogleAdsService.SearchStream GoogleAdsService.Search
מתאים לקוד ייצור כן כן
שירות GoogleAdsService GoogleAdsService
תרחיש אחזור אובייקטים ודוחות אחזור אובייקטים ודוחות
תשובה Stream של אובייקטים מסוג GoogleAdsRow דפים של אובייקטים GoogleAdsRow
השדות של התשובה רק אלה שצוינו בשאילתה רק אלה שצוינו בשאילתה
מגבלות יומיות מגבלות יומיות לפי רמות גישה מגבלות יומיות לפי רמות גישה

‫Search שולח כמה בקשות עם מספור עמודים כדי להוריד דוח שלם, אבל SearchStream שולח בקשה אחת ויוזם חיבור gRPC מתמשך ל-Google Ads API, בלי קשר לגודל הדוח.

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

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

דוגמה

בדוגמה הזו אנחנו בודקים דוח שמורכב מ-100,000 שורות. בטבלה הבאה מפורטים ההבדלים בין הבקשה לתגובה בשתי השיטות:

SearchStream חיפוש
גודל דף לא רלוונטי ‫10,000 שורות בכל דף
מספר בקשות ה-API בקשה אחת ‫10 בקשות
מספר התגובות מה-API שידור רציף אחד ‫10 תשובות

גורמים שמשפיעים על הביצועים

ברוב תרחישי השימוש, אנחנו ממליצים על SearchStream במקום על Search מהסיבות הבאות:

  • דוחות של דף אחד (פחות מ-10,000 שורות): אין הבדלים משמעותיים בביצועים בין שתי השיטות.
  • דוחות מרובי דפים: בדרך כלל SearchStream מהיר יותר כי נמנעות כמה הלוך ושוב ברשת, והקריאה או הכתיבה ממטמון הדיסק פחות משפיעות.
  • יעילות הזיכרון: כשמעבדים דוחות גדולים באמצעות SearchStream, כדאי לבצע איטרציה על חלקי הסטרימינג ולעבד את השורות כשהן מגיעות, במקום לשמור את כל השורות בזיכרון בבת אחת, כדי להימנע משגיאות של חריגה מזיכרון (OOM).
  • עמידות החיבור: מכיוון ש-SearchStream מסתמך על חיבור קבוע, שידורים ארוכים עלולים להיקטע בגלל נפילות ברשת או פסק זמן של תאריך היעד. צריך להגדיר פסק זמן מתאים ל-RPC ולהטמיע לוגיקה של ניסיון חוזר לשגיאות זמניות בסטרימינג.

הגבלות קצב

המגבלות היומיות על הפעולות בשתי השיטות תואמות למגבלות הרגילות ולרמות הגישה של הפרויקט שלכם ב-Google Cloud. שאילתת דוח לוגית אחת נספרת כפעולה אחת במכסת הפעולות היומית, בלי קשר לשאלה אם התוצאה מועברת בסטרימינג באמצעות SearchStream או מאוחזרת באמצעות Search עם page_token בכמה דפים במטמון. עם זאת, כל בקשה עם דפדוף Search עדיין נספרת כקריאת RPC נפרדת במסגרת מגבלות התדירות לטווח הקצר.

קוד לדוגמה

בדוגמת הקוד הבאה מוצג איך להריץ שאילתת דוחות בסטרימינג באמצעות ספריות הלקוח:

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

הקודם
תוויות
הבא
חלוקה לדפים