- طلب HTTP
- مَعلمات المسار
- معامِلات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- MonthlyRange
- SearchKeywordCount
- InsightsValue
تعرض الكلمات الرئيسية للإعلان على شبكة البحث المستخدَمة للعثور على نشاط تجاري في شبكة البحث أو "خرائط Google". تصاحب كل كلمة رئيسية للإعلان على شبكة البحث عدد مرات ظهور يتم تجميعها على أساس شهري.
مثال على الطلب: 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.
مَعلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. الموقع الذي يجب استرجاع السلسلة الزمنية له. التنسيق: المواقع/{locationId} التي يكون فيها locationId معرّف بيانات غير مبهم |
معلمات طلب البحث
المَعلمات | |
---|---|
monthlyRange |
مطلوبة. النطاق بالأشهر لتجميع مرات ظهور الكلمات الرئيسية للإعلان على شبكة البحث. |
pageSize |
اختياريّ. عدد النتائج المطلوبة. حجم الصفحة التلقائي هو 100 صفحة. يمكن ضبط حجم الصفحة على 100 صفحة كحدّ أقصى. |
pageToken |
اختياريّ. رمز مميّز يشير إلى النتيجة المقسّمة التالية التي سيتم عرضها على صفحات. سلسلة بترميز base64. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
يمثّل هذا التجاوب ردًّا شهريًا.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"searchKeywordsCounts": [
{
object ( |
الحقول | |
---|---|
searchKeywordsCounts[] |
عبارات البحث التي تم استخدامها للعثور على نشاط تجاري. |
nextPageToken |
رمز مميّز يشير إلى آخر نتيجة مقسّمة على صفحات تم عرضها. يمكن استخدام هذا الإجراء من خلال الطلبات الناجحة للحصول على "الصفحة" التالية من الكلمات الرئيسية. ولن يتم عرضه إلا عندما يكون هناك المزيد من النتائج التي يمكن عرضها. سلسلة بترميز base64. |
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/business.manage
لمزيد من المعلومات، راجِع نظرة عامة على بروتوكول OAuth 2.0.
MonthlyRange
نطاق زمني يشير إلى نطاق أشهر (كلاهما).
تمثيل JSON |
---|
{ "startMonth": { object ( |
الحقول | |
---|---|
startMonth |
مطلوبة. شامل - سيتم النظر في حقول السنة والأشهر فقط |
endMonth |
مطلوبة. شامل - سيتم النظر في حقول السنة والأشهر فقط |
SearchKeywordCount
تُمثِّل هذه السمة كلمة رئيسية واحدة للبحث وقيمتها.
تمثيل JSON |
---|
{
"searchKeyword": string,
"insightsValue": {
object ( |
الحقول | |
---|---|
searchKeyword |
السلسلة ذات الأحرف الصغيرة التي أدخلها المستخدم. |
insightsValue |
أحدهما إما: 1) مجموع عدد المستخدمين الفريدين الذين استخدموا الكلمة الرئيسية في شهر، مجمّعًا لكل شهر مطلوب. 2) حد يشير إلى أن القيمة الفعلية أقل من هذا الحد. |
InsightsValue
يمثِّل قيمة الرؤى.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد InsightsValue يشير إلى ضرورة وجود حقل واحد فقط من حقول النموذج الأوّلي التالية. يمكن أن تكون السمة "InsightsValue " واحدة فقط مما يلي: |
|
value |
تمثل القيمة الفعلية. |
threshold |
تمثل الحدّ الأدنى الذي تقع القيمة الفعلية تحته. |