Итераторы потока ответов

Метод search_stream возвращает итератор объектов SearchGoogleAdsStreamResponse.

Итерация по ответам потока

Вы можете перебирать каждый объект GoogleAdsRow в поле results каждого ответа, как показано в следующем примере кода:

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

Структура каждого объекта GoogleAdsRow определяется полями, которые вы выбираете в запросе на языке запросов Google Рекламы (GAQL). Подробнее о языке запросов Google Рекламы…

Итератор должен оставаться в области видимости

При вызове GoogleAdsService.search_stream возвращается итератор потоковой передачи ответов. Этот итератор должен оставаться в той же области действия, что и клиент GoogleAdsService, пока он используется, чтобы избежать повреждения потоков или ошибок сегментации. Это связано с тем, что базовый объект gRPC Channel удаляется сборщиком мусора, когда объект GoogleAdsService выходит из области видимости. Если объект GoogleAdsService больше не находится в области действия, когда выполняется итерация по результату search_stream, объект Channel может быть уже уничтожен, что приведет к неопределенному поведению, когда итератор попытается получить следующее значение.

В следующем примере показано неправильное использование итераторов потока:

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)

В этом коде объект GoogleAdsService создается в другой области видимости, чем та, в которой осуществляется доступ к итератору. В результате объект Channel может быть уничтожен до того, как итератор обработает весь ответ.

Вместо этого сохраняйте итератор потоковой передачи в той же области действия, что и клиент GoogleAdsService , пока он используется:

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)