Antwortstream-Iteratoren

Die Methode search_stream gibt einen Iterator von SearchGoogleAdsStreamResponse-Objekten zurück.

Streamantworten iterieren

Sie können jede GoogleAdsRow im Feld results der einzelnen Antworten iterieren, wie im folgenden Codebeispiel gezeigt:

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

Die Struktur der einzelnen GoogleAdsRow-Objekte wird durch die Felder bestimmt, die Sie in Ihrer GAQL-Abfrage (Google Ads Query Language) auswählen. Weitere Informationen zur Antwortstruktur finden Sie unter Google Ads Query Language.

Iterator im Bereich behalten

Beim Aufruf von GoogleAdsService.search_stream wird ein Iterator für die Streamingantwort zurückgegeben. Dieser Iterator muss sich im selben Bereich wie der GoogleAdsService-Client befinden, während er verwendet wird, um fehlerhafte Streams oder Segmentierungsfehler zu vermeiden. Das liegt daran, dass das zugrunde liegende gRPC-Channel-Objekt durch die automatische Speicherbereinigung gelöscht wird, sobald das offene GoogleAdsService-Objekt außerhalb des Gültigkeitsbereichs liegt. Wenn das GoogleAdsService-Objekt nicht mehr im Bereich ist, wenn die Iteration für das Ergebnis von search_stream erfolgt, ist das Channel-Objekt möglicherweise bereits zerstört. Dies führt zu einem undefinierten Verhalten, wenn der Iterator versucht, den nächsten Wert abzurufen.

Der folgende Code zeigt die falsche Verwendung von Stream-Iteratoren:

def stream_response(client, customer_id, query):
    # The GoogleAdsService instance goes out of scope when this function
    # returns.
    ga_service = client.get_service(
        "GoogleAdsService", version="v26"
    )
    return ga_service.search_stream(customer_id=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)

    # Accessing the iterator in a different scope from where the service object
    # was created results in undefined behavior.
    for batch in response:
        print(batch)

In diesem Code wird das GoogleAdsService-Objekt in einem anderen Bereich erstellt als dem, in dem auf den Iterator zugegriffen wird. Daher kann das Channel-Objekt gelöscht werden, bevor der Iterator die gesamte Antwort verarbeitet hat.

Behalten Sie den Streaming-Iterator stattdessen im selben Bereich wie den GoogleAdsService-Client, solange er verwendet wird:

def main(client, customer_id):
    ga_service = client.get_service(
        "GoogleAdsService", version="v26"
    )
    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 where the service object was
    # created.
    for batch in response:
        print(batch)