Method: locations.searchkeywords.impressions.monthly.list

検索やマップでビジネスを見つけるために使用される検索キーワードを返します。各検索キーワードには、毎月集計されるインプレッションが付加されます。

リクエストの例: 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

string

必須。時系列を取得するロケーション。形式: locations/{locationId}。locationId は難読化されていないリスティング ID です。

クエリ パラメータ

パラメータ
monthlyRange

object (MonthlyRange)

必須。検索キーワードのインプレッションを集計する期間（月数）。
pageSize

integer

省略可。リクエストされた結果の数。デフォルトのページサイズは 100 です。ページサイズは最大 100 まで設定できます。
pageToken

string (bytes format)

省略可。次に返されるページ分けされた結果を示すトークン。

Base64 でエンコードされた文字列。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

month.list のレスポンスを表します。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "searchKeywordsCounts": [
    {
      object (SearchKeywordCount)
    }
  ],
  "nextPageToken": string
}
フィールド
searchKeywordsCounts[]

object (SearchKeywordCount)

ビジネスを見つけるために使われた検索語句。
nextPageToken

string (bytes format)

最後に返された、ページ分割された結果を示すトークン。これは、次の「ページ」を取得する後続のリクエストで使用できます。できます。返される結果がもっとある場合にのみ表示されます。

Base64 でエンコードされた文字列。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/business.manage

詳しくは、OAuth 2.0 の概要をご覧ください。

MonthlyRange

月の範囲を示す期間（両端を含む）。

JSON 表現 
{
  "startMonth": {
    object (Date)
  },
  "endMonth": {
    object (Date)
  }
}
フィールド
startMonth

object (Date)

必須。包含 - 年と月のフィールドのみが考慮されます
endMonth

object (Date)

必須。包含 - 年と月のフィールドのみが考慮されます

SearchKeywordCount

1 つの検索キーワードとその値を表します。

JSON 表現 
{
  "searchKeyword": string,
  "insightsValue": {
    object (InsightsValue)
  }
}
フィールド
searchKeyword

string

ユーザーが入力した小文字の文字列。
insightsValue

object (InsightsValue)

次のいずれか: 1）1 か月間にキーワードを使用したユニーク ユーザー数の合計（リクエストされた月ごとに集計）。2）実際の値がこのしきい値を下回ることを示すしきい値。

InsightsValue

インサイトの値を表します。

JSON 表現 
{

  // Union field InsightsValue can be only one of the following:
  "value": string,
  "threshold": string
  // End of list of possible types for union field InsightsValue.
}
フィールド
共用体フィールド InsightsValue。次の proto フィールドのいずれか 1 つのみが存在する必要があることを表します。InsightsValue は次のいずれかになります。
value

string (int64 format)

実際の値を表します。
threshold

string (int64 format)

実際の値が下回るしきい値を表します。