Package google.mybusiness.performance.v1

فهرست

خدمات عملکردی

این سرویس به صاحبان کسب و کار اجازه می‌دهد تا گزارش‌های عملکرد مربوط به نمایه کسب و کار خود را در گوگل دریافت کنند.

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 مراجعه کنید.

فهرستجستجوکلمه کلیدینمایش‌هاماهانه

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 مراجعه کنید.

دیلی‌متریک

تمام معیارهای روزانه موجود برای یک کسب و کار را نشان می‌دهد.

انوم‌ها
DAILY_METRIC_UNKNOWN مقدار پیش‌فرض ناشناخته را نشان می‌دهد.
BUSINESS_IMPRESSIONS_DESKTOP_MAPS تعداد نمایش‌های تجاری در نقشه‌های گوگل روی دستگاه‌های دسکتاپ. چندین نمایش توسط یک کاربر منحصر به فرد در یک روز، به عنوان یک نمایش واحد محاسبه می‌شود.
BUSINESS_IMPRESSIONS_MOBILE_MAPS تعداد نمایش‌های تجاری در نقشه‌های گوگل در دستگاه‌های تلفن همراه. چندین نمایش توسط یک کاربر منحصر به فرد در یک روز، به عنوان یک نمایش واحد محاسبه می‌شود.
BUSINESS_CONVERSATIONS

تعداد مکالمات پیام دریافتی در نمایه تجاری.

BUSINESS_DIRECTION_REQUESTS تعداد دفعاتی که درخواست راهنمایی به محل کسب و کار ارسال شده است.
CALL_CLICKS تعداد دفعاتی که روی دکمه تماس پروفایل تجاری کلیک شده است.
WEBSITE_CLICKS تعداد دفعاتی که روی وب‌سایت پروفایل تجاری کلیک شده است.
BUSINESS_BOOKINGS تعداد رزروهای انجام شده از طریق نمایه تجاری رزرو با گوگل.
BUSINESS_FOOD_ORDERS

تعداد سفارش‌های غذایی دریافت شده از نمایه تجاری.

BUSINESS_FOOD_MENU_CLICKS تعداد کلیک‌ها برای مشاهده یا تعامل با محتوای منو در پروفایل تجاری. چندین کلیک توسط یک کاربر منحصر به فرد در یک روز، ۱ کلیک محسوب می‌شود.

سری زمانی روزانه

یک نقطه داده واحد را نشان می‌دهد، که در آن هر نقطه داده یک تاپل DailyMetric-DailySubEntityType-TimeSeries است.

فیلدها
daily_metric

DailyMetric

DailyMetric که TimeSeries آن را نشان می‌دهد.

daily_sub_entity_type

DailySubEntityType

نوع داده‌ی DailySubEntityType که TimeSeries آن را نشان می‌دهد. وقتی که breakdown وجود نداشته باشد، وجود نخواهد داشت.

time_series

TimeSeries

فهرستی از نقاط داده که در آن هر نقطه داده یک جفت تاریخ-مقدار است.

دیلی رنج

محدوده زمانی که نشان‌دهنده محدوده تاریخ (هر دو شامل) است.

فیلدها
start_date

Date

الزامی. شامل

end_date

Date

الزامی. شامل

نوع زیرموجودیت روزانه

تمام انواع زیرموجودیت‌های ممکن مرتبط با DailyMetrics را نشان می‌دهد.

فیلدها
فیلد Union Type . نشان می‌دهد که فقط یکی از فیلدهای اولیه زیر باید وجود داشته باشد. DailySubEntityType برای همه معیارها در دسترس نیست. Type فقط می‌تواند یکی از موارد زیر باشد:
day_of_week

DayOfWeek

نشان دهنده روز هفته است. مثال: دوشنبه. در حال حاضر DailyMetrics پشتیبانی شده = NONE.

time_of_day

TimeOfDay

زمان روز را در قالب ۲۴ ساعته نشان می‌دهد. مثال: ۱۳:۳۴:۲۰ در حال حاضر DailyMetrics پشتیبانی می‌شود = NONE.

مقدار تاریخ‌دار

یک نقطه داده واحد را در سری زمانی نشان می‌دهد، که در آن هر نقطه داده یک جفت تاریخ-مقدار است.

فیلدها
date

Date

تاریخی که نقطه داده با آن مطابقت دارد. اگر فیلد روز تنظیم نشده باشد، این مقدار نشان‌دهنده‌ی ماه است.

value

int64

مقدار نقطه داده. این مقدار زمانی که مقدار صفر باشد، وجود نخواهد داشت.

درخواست FetchMultiDailyMetricsTimeSeries

درخواست FetchMultiDailyMetricsTimeSeries را نشان می‌دهد.

فیلدها
location

string

الزامی. مکانی که سری زمانی باید برای آن واکشی شود. قالب: locations/{location_id} که در آن location_id یک شناسه فهرست‌بندی بدون ابهام است.

daily_metrics[]

DailyMetric

الزامی. معیارهای بازیابی سری‌های زمانی برای.

daily_range

DailyRange

الزامی. بازه زمانی که سری زمانی برای آن واکشی خواهد شد.

واکشی معیارهای چندگانه روزانه، سری زمانی، پاسخ

نشان‌دهنده‌ی پاسخ برای FetchMultiDailyMetricsTimeSeries است.

فیلدها
multi_daily_metric_time_series[]

MultiDailyMetricTimeSeries

DailyMetrics و سری‌های زمانی مربوط به آنها.

درخواست GetDailyMetricsTimeSeries

درخواست GetDailyMetricsTimeSeries را نشان می‌دهد.

فیلدها
name

string

الزامی. مکانی که سری زمانی باید برای آن واکشی شود. قالب: locations/{location_id} که در آن location_id یک شناسه فهرست‌بندی بدون ابهام است.

daily_metric

DailyMetric

الزامی. معیار بازیابی سری‌های زمانی.

daily_range

DailyRange

الزامی. بازه زمانی که سری زمانی برای آن واکشی خواهد شد.

daily_sub_entity_type

DailySubEntityType

اختیاری. نوع و شناسه زیر-نهاد که سری زمانی به آن مربوط می‌شود. در حال حاضر DailyMetrics پشتیبانی شده = NONE.

GetDailyMetricsTimeSeriesResponse

نشان دهنده پاسخ GetDailyMetricsTimeSeries است.

فیلدها
time_series

TimeSeries

سری زمانی روزانه.

بینش‌هاارزش

نشان دهنده یک مقدار بینش است.

فیلدها
فیلد Union InsightsValue . نشان می‌دهد که فقط یکی از فیلدهای اولیه زیر باید وجود داشته باشد. InsightsValue فقط می‌تواند یکی از موارد زیر باشد:
value

int64

نشان دهنده مقدار واقعی است.

threshold

int64

نشان دهنده آستانه ای است که مقدار واقعی از آن کمتر می شود.

جستجوی فهرستکلمات کلیدینمایش‌هادرخواست ماهانه

درخواست ListSearchKeywordImpressionsMonthly را نشان می‌دهد.

فیلدها
parent

string

الزامی. مکانی که سری زمانی باید برای آن واکشی شود. قالب: locations/{location_id} که در آن location_id یک شناسه فهرست‌بندی بدون ابهام است.

monthly_range

MonthlyRange

الزامی. بازه زمانی بر حسب ماه برای جمع‌بندی تعداد نمایش کلمات کلیدی جستجو شده در طول آن.

page_size

int32

اختیاری. تعداد نتایج درخواستی. اندازه صفحه پیش‌فرض ۱۰۰ است. اندازه صفحه را می‌توان حداکثر روی ۱۰۰ تنظیم کرد.

page_token

bytes

اختیاری. یک توکن که نشان دهنده نتیجه صفحه بندی شده بعدی است که باید برگردانده شود.

فهرستجستجوکلمه کلیدیتعداد بازدیدهاماهانهپاسخ

نشان دهنده پاسخ برای ListSearchKeywordImpressionsMonthly است.

فیلدها
search_keywords_counts[]

SearchKeywordCount

عبارات جستجویی که برای یافتن یک کسب و کار استفاده شده‌اند.

next_page_token

bytes

یک توکن که آخرین نتیجه صفحه‌بندی شده برگشت داده شده را نشان می‌دهد. این توکن می‌تواند توسط درخواست‌های بعدی برای دریافت "صفحه" بعدی کلمات کلیدی استفاده شود. این توکن فقط زمانی نمایش داده می‌شود که نتایج بیشتری برای برگرداندن وجود داشته باشد.

محدوده ماهانه

محدوده زمانی که نشان‌دهنده محدوده ماه است (هر دو شامل).

فیلدها
start_month

Date

الزامی. شامل - فقط فیلدهای سال و ماه در نظر گرفته می‌شوند.

end_month

Date

الزامی. شامل - فقط فیلدهای سال و ماه در نظر گرفته می‌شوند.

سری زمانی چندروزه-متریک

لیستی از تاپل‌های DailyMetric-DailySubEntityType-TimeSeries را نشان می‌دهد.

فیلدها
daily_metric_time_series[]

DailyMetricTimeSeries

فهرست جفت‌های DailyMetric-TimeSeries.

تعداد کلمات کلیدی جستجو

نشان دهنده یک کلمه کلیدی جستجو و مقدار آن است.

فیلدها
search_keyword

string

رشته‌ای با حروف کوچک که کاربر وارد کرده است.

insights_value

InsightsValue

یکی از این دو مورد: ۱) مجموع تعداد کاربران منحصر به فردی که در یک ماه از کلمه کلیدی استفاده کرده‌اند، که برای هر ماه درخواست شده تجمیع شده است. ۲) آستانه‌ای که نشان می‌دهد مقدار واقعی کمتر از این آستانه است.

سری‌های زمانی

نشان دهنده یک سری زمانی است.

فیلدها
dated_values[]

DatedValue

فهرست نقاط داده در سری زمانی، که در آن هر نقطه داده یک جفت تاریخ-مقدار است.