- HTTP-запрос
- Параметры пути
- Параметры запроса
- Тело запроса
- Тело ответа
- Области авторизации
- Ежемесячныйдиапазон
- ПоискКлючевое словоКоличество
- InsightsЦенность
Возвращает ключевые слова, используемые для поиска компании в поиске или на картах. Каждое ключевое слово поиска сопровождается показами, которые суммируются ежемесячно.
Пример запроса: GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthlyRange.start_month.year=2022&monthlyRange.start_month.month=1&monthlyRange.end_month.year=2022&monthlyRange.end_month.month=3
HTTP-запрос
GET https://businessprofileperformance.googleapis.com/v1/{parent=locations/*}/searchkeywords/impressions/monthly
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Необходимый. Местоположение, для которого следует получить временной ряд. Формат: location/{locationId}, где locationId — это незашифрованный идентификатор объявления. |
Параметры запроса
Параметры | |
---|---|
monthlyRange | Необходимый. Диапазон месяцев для агрегирования показов по поисковым ключевым словам. |
pageSize | Необязательный. Количество запрошенных результатов. Размер страницы по умолчанию — 100. Размер страницы можно установить максимум на 100. |
pageToken | Необязательный. Токен, указывающий следующий возвращаемый результат с разбивкой на страницы. Строка в кодировке Base64. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Представляет ответ для ежемесячного.списка.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"searchKeywordsCounts": [
{
object ( |
Поля | |
---|---|
searchKeywordsCounts[] | Поисковые запросы, которые использовались для поиска компании. |
nextPageToken | Токен, указывающий последний возвращенный результат с разбивкой на страницы. Это можно использовать при последующих запросах на получение следующей «страницы» ключевых слов. Он будет присутствовать только тогда, когда будет возвращено больше результатов. Строка в кодировке Base64. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/business.manage
Дополнительную информацию см. в обзоре OAuth 2.0 .
Ежемесячныйдиапазон
Временной диапазон, указывающий диапазон месяцев (оба включительно).
JSON-представление |
---|
{ "startMonth": { object ( |
Поля | |
---|---|
startMonth | Необходимый. Включительно – будут учитываться только поля года и месяца. |
endMonth | Необходимый. Включительно – будут учитываться только поля года и месяца. |
ПоискКлючевое словоКоличество
Представляет одно ключевое слово поиска и его значение.
JSON-представление |
---|
{
"searchKeyword": string,
"insightsValue": {
object ( |
Поля | |
---|---|
searchKeyword | Строка в нижнем регистре, введенная пользователем. |
insightsValue | Одно из следующих значений: 1) Сумма количества уникальных пользователей, использовавших это ключевое слово за месяц, агрегированная за каждый запрошенный месяц. 2) Порог, указывающий, что фактическое значение ниже этого порога. |
InsightsЦенность
Представляет значение аналитики.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения InsightsValue . Указывает, что должно присутствовать только одно из следующих полей прототипа. InsightsValue может иметь только одно из следующих значений: | |
value | Представляет фактическую стоимость. |
threshold | Представляет порог, ниже которого падает фактическое значение. |