検索またはマップでビジネスを見つけるために使用された検索キーワードを返します。各検索キーワードに関連するインプレッションは、月単位で集計されます。
リクエストの例: 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 Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。時系列を取得するロケーション。形式: locations/{locationId}。locationId は難読化されていないリスティング ID です。 |
クエリ パラメータ
パラメータ | |
---|---|
monthlyRange |
必須。検索キーワードのインプレッション数を集計する期間(月数)。 |
pageSize |
(省略可)リクエストされた結果の数。デフォルトのページサイズは 100 です。ページサイズは最大 100 に設定できます。 |
pageToken |
(省略可)返される次のページ分割された結果を示すトークン。 Base64 でエンコードされた文字列。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
month.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
1 つの検索キーワードとその値を表します。
JSON 表現 |
---|
{
"searchKeyword": string,
"insightsValue": {
object ( |
フィールド | |
---|---|
searchKeyword |
ユーザーが入力した小文字の文字列。 |
insightsValue |
次のいずれか: 1)1 か月にキーワードを使用したユニーク ユーザー数の合計(リクエストされた月ごとに集計)。2)実際の値がこのしきい値を下回っていることを示すしきい値。 |
InsightsValue
インサイトの値を表します。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド InsightsValue 。次の proto フィールドのいずれか 1 つのみが存在する必要があることを示します。InsightsValue は次のいずれかになります。 |
|
value |
実際の値を表します。 |
threshold |
実際の値がそれを下回るしきい値を表します。 |