Aby pobrać elementy i dane do raportu interfejsu Google Ads API, użyj jednej z tych metod:
Oto ogólne różnice między tymi 2 metodami:
| GoogleAdsService.SearchStream | GoogleAdsService.Search | |
|---|---|---|
| Odpowiednie do kodu produkcyjnego | Tak | Tak |
| Usługa | GoogleAdsService |
GoogleAdsService |
| Scenariusz | Pobieram obiekty i raporty | Pobieram obiekty i raporty |
| Odpowiedź | Strumień obiektów GoogleAdsRow |
Strony obiektów GoogleAdsRow |
| Pola odpowiedzi | Tylko te określone w zapytaniu | Tylko te określone w zapytaniu |
| Limity dzienne | Limity dzienne na podstawie poziomów dostępu | Limity dzienne na podstawie poziomów dostępu |
SearchStream – Search
Search wysyła wiele żądań z podziałem na strony, aby pobrać cały raport, natomiast SearchStream wysyła jedno żądanie i inicjuje trwałe połączenie gRPC z interfejsem Google Ads API niezależnie od rozmiaru raportu.
W przypadku SearchStream pakiety danych zaczynają się pobierać natychmiast w partiach po SearchGoogleAdsStreamResponse obiektów. Kod może iterować po przychodzących partiach, gdy tylko się pojawią, bez czekania na zakończenie całego strumienia.
Dzięki wyeliminowaniu czasu błądzenia w sieci, który jest potrzebny do wysłania żądania każdej strony odpowiedzi Search, SearchStream zapewnia lepszą wydajność niż stronicowanie, zwłaszcza w przypadku dużych raportów.
Przykład
W tym przykładzie analizujemy raport, który składa się z 100,000 wierszy. W tabeli poniżej znajdziesz różnice między żądaniami i odpowiedziami w obu metodach:
| SearchStream | Szukaj | |
|---|---|---|
| Rozmiar strony | Nie dotyczy | 10 000 wierszy na stronie |
| Liczba żądań do interfejsu API | 1 żądanie | 10 żądań |
| Liczba odpowiedzi interfejsu API | 1 ciągły strumień | 10 odpowiedzi |
Czynniki wpływające na skuteczność
W większości przypadków zalecamy używanie SearchStream zamiast Search z tych powodów:
- Raporty jednostronicowe (poniżej 10 000 wierszy): nie ma znaczących różnic w wydajności między tymi 2 metodami.
- Raporty wielostronicowe:
SearchStreamjest zwykle szybszy, ponieważ pozwala uniknąć wielokrotnych podróży w obie strony przez sieć, a odczyt i zapis w pamięci podręcznej na dysku mają mniejsze znaczenie. - Wydajność pamięci: podczas przetwarzania dużych raportów za pomocą
SearchStreamiteruj po fragmentach strumienia i przetwarzaj wiersze w miarę ich napływania, zamiast buforować wszystkie wiersze w pamięci naraz, aby uniknąć błędów braku pamięci (OOM). - Odporność połączenia:
SearchStreamopiera się na stałym połączeniu, więc długotrwałe strumienie mogą być przerywane przez przerwy w działaniu sieci lub przekroczenie limitu czasu. Skonfiguruj odpowiednie limity czasu RPC i zaimplementuj logikę ponawiania prób w przypadku przejściowych błędów strumienia.
Ograniczenia liczby żądań
Dzienne limity operacji dla obu metod są zgodne ze standardowymi limitami i poziomami dostępu Twojego projektu w chmurze Google Cloud. Pojedyncze logiczne zapytanie raportu jest liczone jako jedna operacja w ramach dziennego limitu operacji, niezależnie od tego, czy wynik jest przesyłany strumieniowo za pomocą SearchStream, czy pobierany z wielu stron w pamięci podręcznej za pomocą Search z page_token. Jednak każde żądanie Search z podziałem na strony nadal liczy się jako osobne wywołanie RPC w ramach krótkoterminowego ograniczania liczby żądań.
Przykładowy kod
Poniższy przykładowy kod pokazuje, jak wykonać zapytanie dotyczące raportu strumieniowego za pomocą bibliotek klienta:
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; }