Iteratory strumieniowania

Metoda search_stream zwraca iterator obiektów SearchGoogleAdsStreamResponse.

Możesz iterować po każdym obiekcie GoogleAdsRow w polu results każdej odpowiedzi, jak pokazano w tym przykładzie kodu.

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

Struktura każdego obiektu GoogleAdsRow jest określana przez pola wybrane w zapytaniu w języku zapytań Google Ads (GAQL). Więcej informacji o strukturze odpowiedzi znajdziesz w dokumentacji języka zapytań Google Ads.

Gdy wywołasz metodę GoogleAdsService.search_stream, zostanie zwrócony iterator odpowiedzi strumieniowej. Aby uniknąć uszkodzenia strumieni lub błędów segmentacji, ten iterator powinien pozostać w tym samym zakresie co klient GoogleAdsService. Dzieje się tak, ponieważ obiekt gRPC Channel jest usuwany z pamięci, gdy otwarty obiekt GoogleAdsService wyjdzie poza zakres. Jeśli obiekt GoogleAdsService nie będzie już w zakresie, gdy nastąpi iteracja wyniku search_stream, obiekt Channel może zostać już zniszczony, co spowoduje nieokreślone zachowanie, gdy iterator spróbuje pobrać następną wartość.

Poniższy kod pokazuje nieprawidłowe użycie iteratorów strumieniowych:

def stream_response(client, customer_id, query):
    return client.get_service("GoogleAdsService", version="v24").search_stream(customer_id, query=query)

def main(client, customer_id):
    query = "SELECT campaign.name FROM campaign LIMIT 10"
    response = stream_response(client, customer_id, query=query)
    # Access the iterator in a different scope from where the service object was created.
    try:
        for batch in response:
            # Iterate through response, expect undefined behavior.

W tym kodzie obiekt GoogleAdsService jest tworzony w innym zakresie niż ten, w którym uzyskiwany jest dostęp do iteratora. W rezultacie obiekt Channel może zostać zniszczony, zanim iterator zużyje całą odpowiedź.

Zamiast tego iterator strumieniowy powinien pozostać w tym samym zakresie co klient GoogleAdsService tak długo, jak jest używany:

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService", version="v24")
    query = "SELECT campaign.name FROM campaign LIMIT 10"
    response = ga_service.search_stream(customer_id=customer_id, query=query)
    # Access the iterator in the same scope as where the service object was created.
    try:
        for batch in response:
            # Successfully iterate through response.