- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- MonthlyRange
- SearchKeywordCount
- 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.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. המיקום שעבורו יש לאחזר את סדרת הזמנים. פורמט: מיקומים/{locationId} שבהם מזהה המיקום הוא מזהה כרטיס מוצר ללא ערפול קוד (obfuscation). |
פרמטרים של שאילתה
פרמטרים | |
---|---|
monthlyRange |
חובה. טווח החודשים לצבירת חשיפות של מילות מפתח לרשת החיפוש. |
pageSize |
אפשרות. מספר התוצאות המבוקשות. גודל הדף שמוגדר כברירת מחדל הוא 100. אפשר להגדיר את גודל הדף עד 100 תמונות. |
pageToken |
אפשרות. אסימון שמציין את התוצאה הבאה של חלוקה לדפים שיש להחזיר. מחרוזת בקידוד base64. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
מייצג את התשובה עבור month.list.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג 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 |
העמודה הזו מייצגת את הסף שמתחתיו נופל הערך בפועל. |