返回用于在搜索或地图中查找商家的搜索关键字。每个搜索关键字都伴随着按月汇总的展示次数。
示例请求: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 |
表示实际值低于的阈值。 |