Method: customers.searchAds360.search

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

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

HTTP-запрос

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

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

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

Параметры
customerId

string

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

Тело запроса

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

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

string

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

pageToken

string

Токен страницы, которую нужно получить. Если не указано, будет возвращена первая страница результатов. Используйте значение, полученное из nextPageToken в предыдущем ответе, чтобы запросить следующую страницу результатов.

pageSize

integer

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

validateOnly

boolean

Если это правда, запрос проверяется, но не выполняется.

returnTotalResultsCount

boolean

Если это правда, общее количество результатов, соответствующих запросу, игнорирующему предложение LIMIT, будет включено в ответ. По умолчанию — ложь.

summaryRowSetting

enum ( SummaryRowSetting )

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

Тело ответа

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

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

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

object ( SearchAds360Row )

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

nextPageToken

string

Токен нумерации страниц, используемый для получения следующей страницы результатов. Передайте содержимое этой строки в качестве атрибута pageToken следующего запроса. nextPageToken не возвращается для последней страницы.

totalResultsCount

string ( int64 format)

Общее количество результатов, соответствующих запросу, игнорирующему предложение LIMIT.

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 )

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

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

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

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