Method: customers.searchAds360.searchStream

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

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

HTTP-запрос

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:searchStream

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

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

Параметры
customerId

string

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

Тело запроса

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

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

string

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

batchSize

integer

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

summaryRowSetting

enum ( SummaryRowSetting )

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

Тело ответа

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

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

JSON-представление 
{
  "results": [
    {
      object (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Поля
results[]

object ( SearchAds360Row )

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

fieldMask

string ( FieldMask format)

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

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

summaryRow

object ( SearchAds360Row )

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

customColumnHeaders[]

object ( CustomColumnHeader )

Заголовки специальных столбцов в результатах.

conversionCustomMetricHeaders[]

object ( ConversionCustomMetricHeader )

Заголовки специальных показателей конверсий в результатах.

conversionCustomDimensionHeaders[]

object ( ConversionCustomDimensionHeader )

Заголовки специального параметра конверсии в результатах.

rawEventConversionMetricHeaders[]

object ( RawEventConversionMetricHeader )

Заголовки необработанных показателей конверсии событий в результатах.

rawEventConversionDimensionHeaders[]

object ( RawEventConversionDimensionHeader )

Заголовки параметров преобразования необработанных событий в результатах.

requestId

string

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

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

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

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