Method: customers.googleAds.searchStream

Возвращает все строки, соответствующие запросу потока поиска.

Список выброшенных ошибок: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError

HTTP-запрос

POST https://googleads.googleapis.com/v19/customers/{customerId}/googleAds:searchStream

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customerId

string

Необходимый. Идентификатор запрашиваемого клиента.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "query": string,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Поля
query

string

Необходимый. Строка запроса.

summaryRowSetting

enum ( SummaryRowSetting )

Определяет, будет ли возвращена сводная строка. По умолчанию сводная строка не возвращается. По запросу строка сводки будет отправлена ​​в ответе сама по себе после того, как будут возвращены все остальные результаты запроса.

Тело ответа

Ответное сообщение для GoogleAdsService.SearchStream .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "results": [
    {
      object (GoogleAdsRow)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "requestId": string,
  "queryResourceConsumption": string
}
Поля
results[]

object ( GoogleAdsRow )

Список строк, соответствующих запросу.

fieldMask

string ( FieldMask format)

FieldMask, указывающий, какие поля были запрошены пользователем.

Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" .

summaryRow

object ( GoogleAdsRow )

Строка сводки, содержащая сводку показателей в результатах. Сводка показателей означает агрегирование показателей по всем результатам, здесь агрегирование может быть суммой, средним значением, частотой и т. д.

requestId

string

Уникальный идентификатор запроса, который используется в целях отладки.

queryResourceConsumption

string ( int64 format)

Объем ресурсов, потребляемых для обслуживания запроса. queryResourceConsumption для строки «Сводка» и ответы, отличные от «Сводка», возвращаются отдельно в соответствующих строках. queryResourceConsumption для ответов, отличных от сводных, возвращается в финальном пакете результатов.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/adwords

Для получения дополнительной информации см.OAuth 2.0 Overview .

Настройка сводной строки

Перечисление, описывающее параметры возвращаемой сводной строки.

Перечисления
UNSPECIFIED Не указан.
UNKNOWN Представляет неизвестные значения возвращаемой итоговой строки.
NO_SUMMARY_ROW Не возвращать итоговую строку.
SUMMARY_ROW_WITH_RESULTS Возвращает сводную строку вместе с результатами. Строка сводки будет возвращена только в последнем пакете (последний пакет не будет содержать результатов).
SUMMARY_ROW_ONLY Возвращает только сводную строку и не возвращает результатов.