Потоковые итераторы

Метод 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.'
            )
get_campaigns.py
      

Структура каждой GoogleAdsRow определяется полями, которые вы выбираете в запросе Google Ads Query Language (GAQL). Более подробную информацию о структуре ответа см. в разделе «Google Ads Query Language» .

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

Приведенный ниже код демонстрирует некорректное использование потоковых итераторов:

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.

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

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

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.