Package google.mybusiness.performance.v1

الفهرس

PerformanceService

تتيح هذه الخدمة للتجّار الحصول على تقارير الأداء الخاصة بملفّاتهم التجارية على Google.

تحاول واجهة برمجة التطبيقات اتّباع الإرشادات المتوفّرة على 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)

تعرِض هذه السمة الكلمات الرئيسية المستخدَمة في البحث للعثور على مؤسسة في "بحث Google" أو "خرائط Google". تتضمّن كل كلمة بحث رئيسية مرّات ظهور يتم تجميعها على أساس شهري.

مثال على الطلب: 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" على أجهزة الكمبيوتر المكتبي يتم احتساب مرّات الظهور المتعددة من مستخدم فريد خلال يوم واحد كمرّة ظهور واحدة.
BUSINESS_IMPRESSIONS_MOBILE_MAPS مرّات ظهور المؤسسة على "خرائط Google" على الأجهزة الجوّالة يتم احتساب مرّات الظهور المتعددة من مستخدم فريد خلال يوم واحد كمرّة ظهور واحدة.
BUSINESS_CONVERSATIONS

عدد محادثات الرسائل التي تم تلقّيها في الملف التجاري

BUSINESS_DIRECTION_REQUESTS عدد المرات التي تم فيها طلب اتجاهات الوصول إلى الموقع الجغرافي للمؤسسة
CALL_CLICKS عدد المرات التي تم فيها النقر على زر الاتصال في الملف التجاري
WEBSITE_CLICKS يشير إلى عدد المرات التي تم فيها النقر على الموقع الإلكتروني للمؤسسة في الملف التجاري.
BUSINESS_BOOKINGS عدد الحجوزات التي تم إجراؤها من الملف التجاري من خلال ميزة "الحجز عبر Google"
BUSINESS_FOOD_ORDERS

عدد طلبات الطعام التي تم تلقّيها من الملف التجاري

BUSINESS_FOOD_MENU_CLICKS يشير إلى عدد النقرات لعرض محتوى قائمة الطعام أو التفاعل معه في الملف التجاري. يتم احتساب النقرات المتعددة التي ينفّذها مستخدم فريد خلال يوم واحد على أنّها نقرة واحدة.

DailyMetricTimeSeries

تمثّل هذه السمة نقطة بيانات واحدة، حيث تكون كل نقطة بيانات عبارة عن مجموعة من القيم DailyMetric وDailySubEntityType وTimeSeries.

الحقول
daily_metric

DailyMetric

تمثّل هذه السمة مقياس DailyMetric الذي تمثّله السلسلة الزمنية.

daily_sub_entity_type

DailySubEntityType

تمثّل هذه السمة نوع الكيان الفرعي اليومي الذي تمثّله السلسلة الزمنية. لن تكون هذه السمة متوفّرة عندما لا يكون هناك تقسيم.

time_series

TimeSeries

قائمة بنقاط البيانات، حيث تكون كل نقطة بيانات عبارة عن زوج من التاريخ والقيمة.

DailyRange

نطاق زمني يشير إلى نطاق تاريخ (كلاهما شامل).

الحقول
start_date

Date

الحقل مطلوب. محتوى شامل

end_date

Date

الحقل مطلوب. محتوى شامل

DailySubEntityType

تمثّل هذه السمة جميع أنواع الكيانات الفرعية المحتملة المرتبطة بسمة DailyMetrics.

الحقول
حقل الربط Type يشير إلى أنّه يجب توفير حقل واحد فقط من حقول البروتوكول التالية. لا يتوفّر DailySubEntityType لبعض المقاييس. يمكن أن يكون التعليق Type إحدى القيم التالية فقط:
day_of_week

DayOfWeek

تمثّل هذه السمة يومًا من الأسبوع. مثلاً: الاثنين. لا تتوفّر حاليًا أي DailyMetrics.

time_of_day

TimeOfDay

تمثّل هذه السمة الوقت من اليوم بتنسيق 24 ساعة. مثال: 13:34:20 DailyMetrics = NONE.

DatedValue

تمثّل نقطة بيانات واحدة في السلسلة الزمنية، حيث تكون كل نقطة بيانات عبارة عن زوج من التاريخ والقيمة.

الحقول
date

Date

تمثّل هذه السمة التاريخ الذي تتوافق معه نقطة البيانات. يمثّل هذا الحقل قيمة الشهر إذا لم يتم ضبط حقل اليوم.

value

int64

قيمة نقطة البيانات لن يكون هذا الحقل متوفّرًا عندما تكون القيمة صفرًا.

FetchMultiDailyMetricsTimeSeriesRequest

تمثّل هذه السمة طلب FetchMultiDailyMetricsTimeSeries.

الحقول
location

string

الحقل مطلوب. الموقع الجغرافي الذي يجب جلب السلسلة الزمنية له التنسيق: locations/{location_id} حيث location_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 هو معرّف بطاقة بيانات غير مشفّر.

daily_metric

DailyMetric

الحقل مطلوب. المقياس المطلوب استرداد السلسلة الزمنية له

daily_range

DailyRange

الحقل مطلوب. النطاق الزمني الذي سيتم جلب السلسلة الزمنية له.

daily_sub_entity_type

DailySubEntityType

اختيارية: تمثّل هذه السمة نوع الكيان الفرعي ورقم تعريفه المرتبطَين بالسلسلة الزمنية. لا تتوفّر حاليًا أي DailyMetrics.

GetDailyMetricsTimeSeriesResponse

تمثّل هذه السمة الردّ على GetDailyMetricsTimeSeries.

الحقول
time_series

TimeSeries

السلسلة الزمنية اليومية

InsightsValue

تمثّل هذه السمة قيمة إحصاءات.

الحقول
حقل الربط InsightsValue يشير إلى أنّه يجب توفير حقل واحد فقط من حقول البروتوكول التالية. يمكن أن يكون التعليق InsightsValue إحدى القيم التالية فقط:
value

int64

تمثّل هذه السمة القيمة الفعلية.

threshold

int64

تمثّل هذه السمة الحدّ الذي تقلّ عنه القيمة الفعلية.

ListSearchKeywordImpressionsMonthlyRequest

تمثّل هذه السمة طلب ListSearchKeywordImpressionsMonthly.

الحقول
parent

string

الحقل مطلوب. الموقع الجغرافي الذي يجب جلب السلسلة الزمنية له التنسيق: locations/{location_id} حيث location_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) مجموع عدد المستخدمين الفريدين الذين استخدموا الكلمة الرئيسية في شهر واحد، ويتم تجميعهم لكل شهر مطلوب. ‫2) حدّ يشير إلى أنّ القيمة الفعلية أقل من هذا الحدّ.

TimeSeries

تمثّل هذه السمة سلسلة زمنية.

الحقول
dated_values[]

DatedValue

قائمة بنقاط البيانات في السلسلة الزمنية، حيث تكون كل نقطة بيانات عبارة عن زوج من التاريخ والقيمة.