Package google.mybusiness.performance.v1

インデックス

PerformanceService

このサービスを使用すると、販売者は Google のビジネス プロフィールに関するパフォーマンス レポートを取得できます。

API は、aip.dev に記載されているガイドラインに沿って動作します。

FetchMultiDailyMetricsTimeSeries

rpc FetchMultiDailyMetricsTimeSeries(FetchMultiDailyMetricsTimeSeriesRequest) returns (FetchMultiDailyMetricsTimeSeriesResponse)

特定の期間の各日付の値と、必要に応じて、特定の日次指標に関連付けられているサブエンティティ タイプを返します。

リクエストの例: GET https://businessprofileperformance.googleapis.com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。
GetDailyMetricsTimeSeries

rpc GetDailyMetricsTimeSeries(GetDailyMetricsTimeSeriesRequest) returns (GetDailyMetricsTimeSeriesResponse)

指定した期間の各日付について、特定の毎日の指標に関連付けられている値を返します。

リクエストの例: GET https://businessprofileperformance.googleapis.com/v1/locations/12345:getDailyMetricsTimeSeries?dailyMetric=WEBSITE_CLICKS&daily_range.start_date.year=2022&daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。
ListSearchKeywordImpressionsMonthly

rpc ListSearchKeywordImpressionsMonthly(ListSearchKeywordImpressionsMonthlyRequest) returns (ListSearchKeywordImpressionsMonthlyResponse)

検索またはマップでビジネスを見つけるために使用された検索キーワードを返します。各検索広告キーワードには、月単位で集計されたインプレッション数が表示されます。

リクエストの例: GET https://businessprofileperformance.googleapis.com/v1/locations/12345/searchkeywords/impressions/monthly?monthly_range.start_month.year=2022&monthly_range.start_month.month=1&monthly_range.end_month.year=2022&monthly_range.end_month.month=3

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。

DailyMetric

ビジネスで利用可能なすべての日次指標を表します。

列挙型
DAILY_METRIC_UNKNOWN デフォルトの不明な値を表します。
BUSINESS_IMPRESSIONS_DESKTOP_MAPS パソコン デバイスでの Google マップでのビジネスのインプレッション数。1 日に同じユーザーが複数回インプレッションを発生させた場合、1 回のインプレッションとしてカウントされます。
BUSINESS_IMPRESSIONS_MOBILE_MAPS モバイル デバイスの Google マップでのビジネスのインプレッション数。1 日に同じユーザーが複数回インプレッションを発生させた場合、1 回のインプレッションとしてカウントされます。
BUSINESS_CONVERSATIONS

ビジネス プロフィールで受信したメッセージの会話数。
BUSINESS_DIRECTION_REQUESTS 店舗拠点へのルート検索がリクエストされた回数。
CALL_CLICKS ビジネス プロフィールの通話ボタンがクリックされた回数。
WEBSITE_CLICKS ビジネス プロフィールのウェブサイトがクリックされた回数。
BUSINESS_BOOKINGS 「Google で予約」経由でビジネス プロフィールから行われた予約数。
BUSINESS_FOOD_ORDERS

ビジネス プロフィールから受けた料理の注文数。
BUSINESS_FOOD_MENU_CLICKS ビジネス プロフィールのメニュー コンテンツを表示または操作するためにクリックされた回数。1 日に 1 人のユーザーが複数回クリックした場合、1 回としてカウントされます。

DailyMetricTimeSeries

単一のデータポイントを表します。各データポイントは DailyMetric-DailySubEntityType-TimeSeries タプルです。

フィールド
daily_metric

DailyMetric

TimeSeries が表す DailyMetric。
daily_sub_entity_type

DailySubEntityType

TimeSeries が表す DailySubEntityType。内訳が存在しない場合は表示されません。
time_series

TimeSeries

各データポイントが日付と値のペアであるデータポイントのリスト。

DailyRange

期間を示す期間（両端を含む）。

フィールド
start_date

Date

必須。インクルーシブ
end_date

Date

必須。インクルーシブ

DailySubEntityType

DailyMetrics に関連付けられているすべての可能なサブエンティティ タイプを表します。

フィールド
共用体フィールド Type。次の proto フィールドのうち 1 つのみが存在する必要があることを表します。DailySubEntityType は、すべての指標で使用できるわけではありません。Type は次のいずれかになります。
day_of_week

DayOfWeek

曜日を表します。例: MONDAY。現在サポートされている DailyMetrics = NONE。
time_of_day

TimeOfDay

1 日の時刻を 24 時間形式で表します。例: 13:34:20 現在サポートされている DailyMetrics = NONE。

DatedValue

時系列内の単一のデータポイントを表します。各データポイントは日付と値のペアです。

フィールド
date

Date

データポイントに対応する日付。これは、日フィールドが設定されていない場合の月値を表します。
value

int64

データポイントの値。値がゼロの場合、これは存在しません。

FetchMultiDailyMetricsTimeSeriesRequest

FetchMultiDailyMetricsTimeSeries のリクエストを表します。

フィールド
location

string

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

DailyMetric

必須。時系列を取得する指標。
daily_range

DailyRange

必須。時系列が取得される期間。

FetchMultiDailyMetricsTimeSeriesResponse

FetchMultiDailyMetricsTimeSeries のレスポンスを表します。

フィールド
multi_daily_metric_time_series[]

MultiDailyMetricTimeSeries

DailyMetrics とそれに対応する時系列。

GetDailyMetricsTimeSeriesRequest

GetDailyMetricsTimeSeries のリクエストを表します。

フィールド
name

string

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

DailyMetric

必須。時系列を取得する指標。
daily_range

DailyRange

必須。時系列が取得される期間。
daily_sub_entity_type

DailySubEntityType

省略可。時系列が関連付けられているサブエンティティのタイプと ID。現在サポートされている DailyMetrics = NONE。

GetDailyMetricsTimeSeriesResponse

GetDailyMetricsTimeSeries のレスポンスを表します。

フィールド
time_series

TimeSeries

日次時系列。

InsightsValue

分析情報の値を表します。

フィールド
共用体フィールド InsightsValue。次の proto フィールドのうち 1 つのみが存在する必要があることを表します。InsightsValue は次のいずれかになります。
value

int64

実際の値を表します。
threshold

int64

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

ListSearchKeywordImpressionsMonthlyRequest

ListSearchKeywordImpressionsMonthly のリクエストを表します。

フィールド
parent

string

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

MonthlyRange

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

int32

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

bytes

省略可。返される次のページネーション結果を示すトークン。

ListSearchKeywordImpressionsMonthlyResponse

ListSearchKeywordImpressionsMonthly のレスポンスを表します。

フィールド
search_keywords_counts[]

SearchKeywordCount

ビジネスの検索に使用された検索語句。
next_page_token

bytes

返された最後のページ設定結果を示すトークン。これは、後続のリクエストでキーワードの次の「ページ」を取得するために使用できます。返される結果がさらにある場合にのみ存在します。

MonthlyRange

月単位の期間を示す期間（両端を含む）。

フィールド
start_month

Date

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

Date

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

MultiDailyMetricTimeSeries

DailyMetric-DailySubEntityType-TimeSeries のタプルのリストを表します。

フィールド
daily_metric_time_series[]

DailyMetricTimeSeries

DailyMetric-TimeSeries ペアのリスト。

SearchKeywordCount

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

フィールド
search_keyword

string

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

InsightsValue

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

TimeSeries

時系列を表します。

フィールド
dated_values[]

DatedValue

時系列のデータポイントのリスト。各データポイントは日付と値のペアです。