Method: customers.searchAds360.search

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

Список возникших ошибок: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError 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

Если значение равно true, в ответ будет включено общее количество результатов, соответствующих запросу без учета условия LIMIT. Значение по умолчанию — false.

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