- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- محدوده ماهانه
- Search Keyword Count
- InsightsValue
کلمات کلیدی جستجویی که برای یافتن یک کسب و کار در جستجو یا نقشه ها استفاده شده اند را برمی گرداند. هر کلمه کلیدی جستجو با نمایش هایی همراه است که به صورت ماهانه جمع می شوند.
درخواست مثال: 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 | مورد نیاز. مکانی که سری زمانی باید برای آن واکشی شود. قالب: مکانها/{locationId} که locationId یک شناسه فهرست بدون ابهام است. |
پارامترهای پرس و جو
پارامترها | |
---|---|
monthlyRange | مورد نیاز. محدوده در ماه ها برای جمع آوری کلمات کلیدی جستجو بر روی. |
pageSize | اختیاری. تعداد نتایج درخواستی اندازه صفحه پیش فرض 100 است. اندازه صفحه را می توان حداکثر تا 100 تنظیم کرد. |
pageToken | اختیاری. نشانه ای که نشان دهنده نتیجه صفحه بندی شده بعدی است که باید برگردانده شود. رشته ای با کد base64. |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پاسخ ماهانه.list را نشان می دهد.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"searchKeywordsCounts": [
{
object ( |
فیلدها | |
---|---|
searchKeywordsCounts[] | جستجوی عباراتی که برای یافتن یک کسب و کار استفاده شده است. |
nextPageToken | نشانه ای که آخرین نتیجه صفحه بندی شده را نشان می دهد. این را می توان با درخواست های موفق برای دریافت "صفحه" بعدی کلمات کلیدی استفاده کرد. تنها زمانی وجود خواهد داشت که نتایج بیشتری برای بازگشت وجود داشته باشد. رشته ای با کد base64. |
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/business.manage
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
محدوده ماهانه
محدوده زمانی که یک محدوده ماه را نشان می دهد (هر دو شامل).
نمایندگی JSON |
---|
{ "startMonth": { object ( |
فیلدها | |
---|---|
startMonth | مورد نیاز. فراگیر - فقط فیلدهای سال و ماه در نظر گرفته خواهند شد |
endMonth | مورد نیاز. فراگیر - فقط فیلدهای سال و ماه در نظر گرفته خواهند شد |
Search Keyword Count
یک کلمه کلیدی جستجو و ارزش آن را نشان می دهد.
نمایندگی JSON |
---|
{
"searchKeyword": string,
"insightsValue": {
object ( |
فیلدها | |
---|---|
searchKeyword | رشته ای با حروف کوچک که کاربر وارد کرده است. |
insightsValue | یکی از هر دو: 1) مجموع تعداد کاربران منحصر به فردی که از کلمه کلیدی در یک ماه استفاده کرده اند، جمع آوری شده برای هر ماه درخواستی. 2) آستانه ای که نشان می دهد مقدار واقعی زیر این آستانه است. |
InsightsValue
یک ارزش بینش را نشان می دهد.
نمایندگی JSON |
---|
{ // Union field |
فیلدها | |
---|---|
فیلد اتحادیه InsightsValue . نشان می دهد که فقط یکی از فیلدهای اولیه زیر باید وجود داشته باشد. InsightsValue می تواند تنها یکی از موارد زیر باشد: | |
value | ارزش واقعی را نشان می دهد. |
threshold | نشان دهنده آستانه ای است که مقدار واقعی از آن پایین می آید. |