- בקשת 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 |
חובה. המיקום שעבורו יש לאחזר את סדרת הזמנים. פורמט: locations/{locationId} כאשר locationId הוא מזהה כרטיס מוצר ללא ערפול קוד (obfuscated). |
פרמטרים של שאילתה
פרמטרים | |
---|---|
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 . מצהיר שרק אחד משדות ה-Proto הבאים חייב להיות קיים. InsightsValue יכול להיות רק אחת מהאפשרויות הבאות: |
|
value |
מייצג את הערך בפועל. |
threshold |
מייצג את הסף שממנו נמצא הערך בפועל. |