- HTTP 请求
- 路径参数
- 查询参数
- 请求正文
- 响应正文
- 授权范围
- MonthlyRange
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- SearchKeywordCount
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
- InsightsValue
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表示法
返回用于在搜索或地图中查找商家的搜索关键字。每个搜索关键字都伴随着每月汇总的展示次数。
示例请求: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
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
必需。应针对其提取时序的位置。格式:locations/{locationId},其中 locationId 是未经混淆处理的商家信息 ID。 |
查询参数
参数 | |
---|---|
monthlyRange |
必需。用于汇总搜索关键字展示次数的月份范围。 |
pageSize |
可选。请求的结果数。默认页面大小为 100。页面大小最多可设置为 100。 |
pageToken |
可选。指示要返回的下一个分页结果的令牌。 使用 base64 编码的字符串。 |
请求正文
请求正文必须为空。
响应正文
表示 monthly.list 的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"searchKeywordsCounts": [
{
object ( |
字段 | |
---|---|
searchKeywordsCounts[] |
用于查找商家的搜索字词。 |
nextPageToken |
表示上次返回分页结果的令牌。此方法可供成功的请求用来获取下一个“页面”关键字。仅当有更多要返回的结果时才会显示。 使用 base64 编码的字符串。 |
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/business.manage
如需了解详情,请参阅 OAuth 2.0 概览。
MonthlyRange
表示月份范围的时间范围(含两个端点)。
JSON 表示法 |
---|
{ "startMonth": { object ( |
字段 | |
---|---|
startMonth |
必需。包容 - 只考虑年份和月份字段 |
endMonth |
必需。包容 - 只考虑年份和月份字段 |
SearchKeywordCount
表示单个搜索关键字及其值。
JSON 表示法 |
---|
{
"searchKeyword": string,
"insightsValue": {
object ( |
字段 | |
---|---|
searchKeyword |
用户输入的小写字符串。 |
insightsValue |
以下任意一项:1) 在一个月内使用相应关键字的唯一身份用户数的总和,针对所请求月份汇总。2) 表示实际值低于此阈值的阈值。 |
InsightsValue
表示数据分析值。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 InsightsValue 。表示只能包含以下 proto 字段中的一个。InsightsValue 只能是下列其中一项: |
|
value |
表示实际值。 |
threshold |
表示实际值低于的阈值。 |