Package google.mybusiness.v4

אינדקס

AccessControl

השירות הזה מאפשר לנהל את המשתמשים שיש להם גישה לחשבונות ולמיקומים.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

מאשר את ההזמנה שצוינה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

מזמין את המשתמש שצוין להיות מנהל מערכת בחשבון שצוין. המשתמש שהוזמן חייב לאשר את ההזמנה כדי לקבל גישה לחשבון. להצגת [קבלת ההזמנה] [google.mybusiness.v4.קבלת הזמנה] כדי לאשר הזמנה באופן פרוגרמטי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

מזמין את המשתמש שצוין להיות מנהל מערכת עבור המיקום שצוין. המשתמש שהוזמן צריך לאשר את ההזמנה כדי לקבל גישה למיקום. להצגת [קבלת ההזמנה] [google.mybusiness.v4.קבלת הזמנה] כדי לאשר הזמנה באופן פרוגרמטי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

דחיית ההזמנה שצוינה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

הסרת האדמין שצוין מהחשבון שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

מסיר את האדמין שצוין כמנהל של המיקום שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

רשימה של האדמינים של החשבון שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

בתיבת הדו-שיח הזו מפורטים הזמנות בהמתנה לחשבון שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

רשימה של כל האדמינים במיקום שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

מעדכן את האדמין של חשבון האדמין שצוין. ניתן לעדכן רק את תפקיד האדמין של האדמין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

מעדכן את האדמין עבור האדמין של המיקום שצוין. ניתן לעדכן רק את תפקיד האדמין של האדמין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

חשבונות

ה-API הזה מאפשר לנהל חשבונות עסקיים ב-Google. הוא מאפשר לנהל משאבים של Account. הוא מגדיר את מודל המשאבים הבא:

  • ה-API כולל אוסף של Account משאבים בשם accounts/*

  • לנוחותך, תוכל להשתמש במילה הנרדפת 'אני' במקום את מספר החשבון של החשבון האישי של המתקשר המאומת. דוגמאות: GET /v4/accounts/me GET /v4/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

יצירת חשבון עם השם והסוג שצוינו בהורה הנתון.

  • לא ניתן ליצור חשבונות אישיים וארגונים.
  • אי אפשר ליצור קבוצות משתמשים באמצעות חשבון אישי שמוגדר כבעלים הראשי.
  • אי אפשר ליצור קבוצות לפי מיקום רק אם הבעלים הראשי של חשבון אישי נמצא בארגון.
  • קבוצות לפי מיקום לא יכולות להיות הבעלים של קבוצות מיקומים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteNotifications

rpc DeleteNotifications(DeleteNotificationsRequest) returns (Empty)

ניקוי ההגדרות של התראות pubsub של החשבון.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GenerateAccountNumber

rpc GenerateAccountNumber(GenerateAccountNumberRequest) returns (Account)

יוצר מספר חשבון לחשבון הזה. לא מוקצה מספר חשבון בזמן יצירת חשבון. משתמשים בבקשה הזו כדי ליצור מספר חשבון במקרה הצורך.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

הפונקציה מקבלת את החשבון שצוין. הפונקציה מחזירה את הערך NOT_FOUND אם החשבון לא קיים או אם לפונקציית הקריאה אין זכויות גישה אליו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetNotifications

rpc GetNotifications(GetNotificationsRequest) returns (Notifications)

מחזירה את ההגדרות של התראות pubsub של החשבון.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

רשימה של כל החשבונות של המשתמש המאומת. הדרישה הזו כוללת את כל החשבונות שבבעלות המשתמש, וכן חשבונות שעבורם יש למשתמש זכויות ניהול.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

מעדכן את החשבון העסקי שצוין. לא ניתן לעדכן חשבונות אישיים באמצעות השיטה הזו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateNotifications

rpc UpdateNotifications(UpdateNotificationsRequest) returns (Notifications)

המדיניות הזו מגדירה את ההגדרות של התראות PubSub בחשבון, שמיידעות את 'פרופיל העסק ב-Google' לגבי איזה נושא צריך לשלוח התראות pubsub:

  • ביקורות חדשות על מיקומים שמנוהלים על ידי החשבון
  • ביקורות מעודכנות לגבי מיקומים שמנוהלים על ידי החשבון.
  • שירות GoogleUpdates חדש למיקומים שמנוהלים על ידי החשבון.

לכל חשבון יהיה רק משאב אחד של הגדרת התראות, ואפשר להגדיר רק נושא pubsub אחד.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

BusinessCategories

ה-API הזה מאפשר חשיפה של קטגוריות נתמכות של מיקומי עסקים ב-Google. אפשר לקבל רשימות בחלוקה לדפים של כל הקטגוריות העסקיות הזמינות, או לחפש לפי מונח ספציפי. למידע נוסף, עיינו בקטע הקטגוריות במאמר הזה: https://support.google.com/business/answer/3038177

BatchGetBusinessCategories

rpc BatchGetBusinessCategories(BatchGetBusinessCategoriesRequest) returns (BatchGetBusinessCategoriesResponse)

מחזירה רשימה של קטגוריות עסקיות עבור השפה ומזהי GConcept שצוינו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListBusinessCategories

rpc ListBusinessCategories(ListBusinessCategoriesRequest) returns (ListBusinessCategoriesResponse)

מחזירה רשימה של קטגוריות של עסקים. החיפוש יתאים לשם הקטגוריה, אבל לא למזהה הקטגוריה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

BusinessMessagingService

התכונה מאפשרת לעסקים לרשום את המיקומים שלהם להעברת הודעות עסקיות, כדי לאפשר ערוץ תקשורת מצרכנים שמחפשים את המיקומים שלהם. כדי להציג ולבצע פעולות בהודעות העסקיות של מיקום, עליך להיות MANAGER או OWNER של המיקום.

עוקבים

ה-API הזה חושף את ממשק ה-API לניהול של העוקבים.

GetFollowersMetadata

rpc GetFollowersMetadata(GetFollowersMetadataRequest) returns (FollowersMetadata)

לקבל את הגדרות העוקבים של מיקום מסוים.

השדה NOT_FOUND מוחזר אם החשבון או המיקום לא קיימים. הערך PREcondition_FAILED מוחזר אם המיקום לא מאומת ולא מחובר למפות Google.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

FoodMenuService

ה-API הזה מאפשר לקבל ולעדכן את תפריטי האוכל של מיקומי עסקים.

חשוב לשים לב שהפרמטר Location.PriceList מייצג גם 'תפריטים'. באחד מהסוג הזה, אבל עם שדות מוגבלים. יש לו את אותו נפח אחסון במורד הזרם של התפריט הנפתח של ה-Footתפריטs. לאחר סיום ההעברה ל-FoodתפריטService, מומלץ מאוד ללקוחות לא להשתמש ב-Location.PriceList כדי לעדכן יותר את נתוני התפריט, דבר שעלול לגרום לאובדן נתונים בלתי צפוי.

GetFoodMenus

rpc GetFoodMenus(GetFoodMenusRequest) returns (FoodMenus)

מחזירה את תפריטי האוכל של מיקום ספציפי. יש להפעיל את הפונקציה הזו רק אם הערך של location.location_state.can_have_food_menu הוא True.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateFoodMenus

rpc UpdateFoodMenus(UpdateFoodMenusRequest) returns (FoodMenus)

עדכון תפריטי האוכל של מיקום ספציפי. יש להפעיל את הפונקציה הזו רק אם הערך של location.location_state.can_have_food_menu הוא True.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GoogleLocations

ה-API הזה מאפשר גישה ל-GoogleLocation וחיפוש בה.

ListRecommendedGoogleLocations

rpc ListRecommendedGoogleLocations(ListRecommendedGoogleLocationsRequest) returns (ListRecommendedGoogleLocationsResponse)

רשימה של כל הנכסים מסוג 'GoogleLocation' שקיבלו המלצה לחשבון 'פרופיל העסק ב-Google' שצוין. ההמלצות ניתנות רק לחשבונות אישיים ולקבוצות לפי מיקום. בקשות לכל סוגי החשבונות האחרים יגרמו לשגיאה. ההמלצות לקבוצות לפי מיקום מבוססות על המיקומים בקבוצה הזו.

ההמלצות בחשבונות אישיים מבוססות על כל המיקומים שאליהם למשתמש יש גישה בפרופיל העסק (כולל מיקומים שאליהם הוא יכול לגשת דרך קבוצות לפי מיקום). ההמלצות הן קבוצת-על של כל ההמלצות שנוצרות למשתמש.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ReportGoogleLocation

rpc ReportGoogleLocation(ReportGoogleLocationRequest) returns (Empty)

דיווח על GoogleLocation.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

SearchGoogleLocations

rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse)

חיפוש בכל המיקומים האפשריים שתואמים לבקשה שצוינה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

HealthProviderAttributesService

השירות הזה מאפשר לנהל מאפיינים של ספק שירותי בריאות (למשל, ביטוח המקובל במיקום מסוים) שמקושרים למיקום.

GetHealthProviderAttributes

rpc GetHealthProviderAttributes(GetHealthProviderAttributesRequest) returns (HealthProviderAttributes)

מחזירה את המאפיינים של ספק שירותי הבריאות במיקום ספציפי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateHealthProviderAttributes

rpc UpdateHealthProviderAttributes(UpdateHealthProviderAttributesRequest) returns (HealthProviderAttributes)

עדכון המאפיינים של ספק שירותי הבריאות במיקום ספציפי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

תובנות

יוצרות דוחות שמפרטים תובנות לגבי הצרכנים לגבי כרטיס מוצר אחד או יותר בשירותי Google. אפשר לשלוח שאילתות על הנתונים הנצברים של מדדים בסיסיים בטווח של עד 18 חודשים. מדדים שתומכים בפירוט יכולים להציג נתונים נצברים בטווח הזה, בפילוח לפי יום בשבוע או שעה ביום. ניתן לדווח על בקשות לקבלת מסלול נסיעה בתמונות מצב במהלך מספר ימים נבחר.

ReportLocalPostInsights

rpc ReportLocalPostInsights(ReportLocalPostInsightsRequest) returns (ReportLocalPostInsightsResponse)

הפונקציה מחזירה תובנות לגבי קבוצה של פוסטים מקומיים שמשויכים לדף אפליקציה יחיד. אילו מדדים ואיך הם מדווחים הם האפשרויות שמפורטות בפרוטו של הבקשה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ReportLocationInsights

rpc ReportLocationInsights(ReportLocationInsightsRequest) returns (ReportLocationInsightsResponse)

מחזירה דוח שמכיל תובנות לגבי מדד אחד או יותר לפי מיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

InsuranceNetworkService

השירות הזה מאפשר לכם לקבל את כל רשתות הביטוח הנתמכות עבור מיקומים של עסקים בתחום הבריאות ב-Google.

ListInsuranceNetworks

rpc ListInsuranceNetworks(ListInsuranceNetworksRequest) returns (ListInsuranceNetworksResponse)

מחזירה רשימה של כל חברות הביטוח הנתמכות על ידי Google.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

LocalPosts

ה-API הזה חושף את ממשק ה-API לניהול של פוסטים מקומיים.

CreateLocalPost

rpc CreateLocalPost(CreateLocalPostRequest) returns (LocalPost)

יוצר פוסט מקומי חדש שמשויך למיקום שצוין ומחזיר אותו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteLocalPost

rpc DeleteLocalPost(DeleteLocalPostRequest) returns (Empty)

מוחק פוסט מקומי. הפונקציה מחזירה את הערך NOT_FOUND אם הפוסט המקומי לא קיים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetLocalPost

rpc GetLocalPost(GetLocalPostRequest) returns (LocalPost)

קבלת הפוסט המקומי שצוין. הפונקציה מחזירה את הערך NOT_FOUND אם הפוסט המקומי לא קיים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListLocalPosts

rpc ListLocalPosts(ListLocalPostsRequest) returns (ListLocalPostsResponse)

מחזירה רשימה של פוסטים מקומיים שמשויכים למיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateLocalPost

rpc UpdateLocalPost(UpdateLocalPostRequest) returns (LocalPost)

מעדכן את הפוסט המקומי שצוין ומחזיר את הפוסט המקומי המעודכן.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

מיקומים

ה-API הזה מאפשר לנהל את מיקומי העסק ב-Google. הוא מאפשר לנהל משאבים של Location. הוא מגדיר את מודל המשאבים הבא:

  • ה-API כולל אוסף של Account משאבים בשם accounts/*

  • לנוחותך, תוכל להשתמש במילה הנרדפת 'אני' במקום את מספר החשבון של החשבון האישי של המתקשר המאומת. דוגמאות: GET /v4/accounts/me GET /v4/accounts/me/locations

  • בכל Account יש אוסף של Location משאבים בשם accounts/*/locations/*

AssociateLocation

rpc AssociateLocation(AssociateLocationRequest) returns (Empty)

משייך מיקום למזהה מקום. כל שיוך קודם יוחלף. הפעולה הזו תקפה רק אם המיקום לא מאומת. השיוך חייב להיות חוקי, כלומר הוא מופיע ברשימה של FindMatchingLocations.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

BatchGetLocations

rpc BatchGetLocations(BatchGetLocationsRequest) returns (BatchGetLocationsResponse)

הפונקציה מקבלת את כל המיקומים שצוינו בחשבון הנתון.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ClearLocationAssociation

rpc ClearLocationAssociation(ClearLocationAssociationRequest) returns (Empty)

ניקוי השיוך בין מיקום לבין מזהה המקום. הפעולה הזו תקפה רק אם המיקום לא מאומת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

CreateLocation

rpc CreateLocation(CreateLocationRequest) returns (Location)

יצירה של location חדש בבעלות החשבון שצוין, ומחזירה אותו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteLocation

rpc DeleteLocation(DeleteLocationRequest) returns (Empty)

מוחק מיקום.

FindMatchingLocations

rpc FindMatchingLocations(FindMatchingLocationsRequest) returns (FindMatchingLocationsResponse)

חיפוש של כל המיקומים האפשריים שתואמים למיקום שצוין. הפעולה הזו תקפה רק אם המיקום לא מאומת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetChain

rpc GetChain(GetChainRequest) returns (Chain)

הפונקציה מקבלת את השרשרת שצוינה. הפונקציה מחזירה את הערך NOT_FOUND אם השרשרת לא קיימת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation(GetLocationRequest) returns (GoogleUpdatedLocation)

מקבל את הגרסה המעודכנת של Google של המיקום שצוין. הפונקציה מחזירה את הערך NOT_FOUND אם המיקום לא קיים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

הפונקציה מקבלת את המיקום שצוין. הפונקציה מחזירה את הערך NOT_FOUND אם המיקום לא קיים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListAttributeMetadata

rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse)

הפונקציה מחזירה את רשימת המאפיינים הזמינים שיהיו זמינים למיקום עם הקטגוריה הראשית והמדינה שצוינו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

בתיבת הדו-שיח הזו מפורטים המיקומים של החשבון שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

SearchChains

rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse)

חיפוש הרשת לפי שם הרשת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Location)

העברת מיקום מחשבון שבבעלות המשתמש לחשבון אחר שאותו משתמש מנהל. המשתמש חייב להיות הבעלים של החשבון שאליו משויך המיקום כרגע, וגם להיות מנהל של חשבון היעד לפחות. מחזיר את המיקום עם שם המשאב החדש שלו.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateLocation

rpc UpdateLocation(UpdateLocationRequest) returns (Location)

עדכון המיקום שצוין.

מותר להשתמש בתמונות רק במיקום שיש לו דף Google+.

הפונקציה מחזירה את הערך NOT_FOUND אם המיקום לא קיים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

מדיה

השירות הזה מאפשר לנהל מדיה (תמונות וסרטונים) המקושרת למיקום.

CreateMediaItem

rpc CreateMediaItem(CreateMediaItemRequest) returns (MediaItem)

יצירת פריט מדיה חדש עבור המיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteMediaItem

rpc DeleteMediaItem(DeleteMediaItemRequest) returns (Empty)

מוחק את פריט המדיה שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetCustomerMediaItem

rpc GetCustomerMediaItem(GetCustomerMediaItemRequest) returns (MediaItem)

מחזירה מטא-נתונים של פריט המדיה שהלקוח ביקש.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetMediaItem

rpc GetMediaItem(GetMediaItemRequest) returns (MediaItem)

הפונקציה מחזירה מטא-נתונים של פריט המדיה המבוקש.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListCustomerMediaItems

rpc ListCustomerMediaItems(ListCustomerMediaItemsRequest) returns (ListCustomerMediaItemsResponse)

הפונקציה מחזירה רשימה של פריטי מדיה שמשויכים למיקום שתרמו על ידי לקוחות.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListMediaItems

rpc ListMediaItems(ListMediaItemsRequest) returns (ListMediaItemsResponse)

מחזירה רשימה של פריטי מדיה שמשויכים למיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

StartUploadMediaItemData

rpc StartUploadMediaItemData(StartUploadMediaItemDataRequest) returns (MediaItemDataRef)

יוצר MediaItemDataRef להעלאה של פריט מדיה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateMediaItem

rpc UpdateMediaItem(UpdateMediaItemRequest) returns (MediaItem)

מעדכן מטא-נתונים של פריט המדיה שצוין. אפשר להשתמש באפשרות הזו רק כדי לעדכן את הקטגוריה של פריט מדיה, אלא אם הקטגוריה החדשה לא יכולה להיות COVER או PROFILE.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

QuestionsAndAnswers

השירות הזה מאפשר לנהל את השאלות והתשובות של מיקום. הפעולות של שאלות ותשובות תקפות רק למיקומים מאומתים.

CreateQuestion

rpc CreateQuestion(CreateQuestionRequest) returns (Question)

הוספת שאלה לגבי המיקום שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteAnswer

rpc DeleteAnswer(DeleteAnswerRequest) returns (Empty)

מחיקת התשובה שנכתבה על ידי המשתמש הנוכחי לשאלה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteQuestion

rpc DeleteQuestion(DeleteQuestionRequest) returns (Empty)

מחיקת שאלה ספציפית שנכתבה על ידי המשתמש הנוכחי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListAnswers

rpc ListAnswers(ListAnswersRequest) returns (ListAnswersResponse)

הפונקציה מחזירה את רשימת התשובות בחלוקה לדפים לשאלה שצוינה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListQuestions

rpc ListQuestions(ListQuestionsRequest) returns (ListQuestionsResponse)

הפונקציה מחזירה את רשימת השאלות בחלוקה לדפים, ואת חלק מהתשובות למיקום שצוין.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateQuestion

rpc UpdateQuestion(UpdateQuestionRequest) returns (Question)

מעדכן שאלה ספציפית שנכתבה על ידי המשתמש הנוכחי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpsertAnswer

rpc UpsertAnswer(UpsertAnswerRequest) returns (Answer)

יוצר תשובה או מעדכן את התשובה הקיימת שנכתבה על ידי המשתמש לשאלה שצוינה. כל משתמש יכול ליצור רק תשובה אחת לכל שאלה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ביקורות

ה-API הזה מספק פעולות CRUD לביקורות. google.mybusiness.v4.Reviews.

BatchGetReviews

rpc BatchGetReviews(BatchGetReviewsRequest) returns (BatchGetReviewsResponse)

הפונקציה מחזירה את רשימת הביקורות בחלוקה לדפים של כל המיקומים שצוינו. הפעולה הזו תקפה רק אם המיקומים שצוינו מאומתים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

DeleteReviewReply

rpc DeleteReviewReply(DeleteReviewReplyRequest) returns (Empty)

מחיקת התגובה לביקורת שצוינה. פעולה זו תקפה רק אם המיקום שצוין מאומת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

GetReview

rpc GetReview(GetReviewRequest) returns (Review)

מחזיר את הביקורת שצוינה. פעולה זו תקפה רק אם המיקום שצוין מאומת. הפונקציה מחזירה את הערך NOT_FOUND אם הביקורת לא קיימת או שנמחקה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListReviews

rpc ListReviews(ListReviewsRequest) returns (ListReviewsResponse)

הפונקציה מחזירה את רשימת הביקורות בחלוקה לדפים של המיקום שצוין. פעולה זו תקפה רק אם המיקום שצוין מאומת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateReviewReply

rpc UpdateReviewReply(UpdateReviewReplyRequest) returns (ReviewReply)

עדכון התשובה לביקורת שצוינה. אם לא קיימת תשובה, תיווצר תשובה. פעולה זו תקפה רק אם המיקום שצוין מאומת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ServiceLists

ה-API הזה מאפשר לפעולות לקבל ולעדכן ב-Google רשימת שירותים של מיקומי עסקים. רשימת שירותים כוללת רשימה של פריטי שירות שהם שירותים שהמוכרים מספקים. שירות יכול להיות תספורת, התקנת דוד חימום וכו'.

GetServiceList

rpc GetServiceList(GetServiceListRequest) returns (ServiceList)

קבלת רשימת השירותים שצוינה של מיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

UpdateServiceList

rpc UpdateServiceList(UpdateServiceListRequest) returns (ServiceList)

עדכון רשימת השירותים שצוינה של מיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

אימותים

ה-API הזה מאפשר לנהל את אימותי המיקומים ב-Google. הוא מאפשר לנהל משאבים של Verification.

בכל Location יש אוסף של Verification משאבים בשם accounts/*/locations/*/verifications/*.

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

משלים אימות PENDING.

צריך רק להשתמש בשיטות אימות שאינן AUTO. בקשת האימות של AUTO מועברת באופן מיידי VERIFIED כשיוצרים את הקובץ.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

הדוחות כוללים את כל אפשרויות האימות הכשירות לגבי מיקום מסוים בשפה מסוימת.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

רשימת אימותים של מיקום, ממוינת לפי שעת היצירה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

התחלת תהליך האימות של מיקום.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.

AcceptInvitationRequest

הודעת בקשה עבור AccessControl.AcceptPurchase.

שדות
name

string

שם ההזמנה שמתקבלת.

חשבון

חשבון הוא מאגר של מיקומי העסק שלכם. אם אתם המשתמשים היחידים שמנהלים מיקומים של העסק, תוכלו להשתמש בחשבון Google האישי שלכם. כדי לשתף את הניהול של מיקומים עם כמה משתמשים, אפשר ליצור חשבון עסקי.

שדות
name

string

שם המשאב, בפורמט accounts/{account_id}.

account_name

string

שם החשבון.

type

AccountType

פלט בלבד. המדיניות מציינת את AccountType של החשבון הזה.

role

AccountRole

פלט בלבד. המדיניות הזו מציינת את AccountRole שיש למבצע הקריאה החוזרת בחשבון הזה.

state

AccountState

פלט בלבד. מציין את AccountState של החשבון הזה.

account_number

string

מספר הסימוכין של החשבון, אם הוקצה.

permission_level

PermissionLevel

פלט בלבד. המדיניות הזו מציינת את PermissionLevel שיש למבצע הקריאה החוזרת בחשבון הזה.

organization_info

OrganizationInfo

מידע נוסף על ארגון. השדה הזה מאוכלס רק עבור חשבון ארגוני.

OrganizationInfo

מידע נוסף שנשמר לארגון.

שדות
registered_domain

string

הדומיין הרשום של החשבון.

postal_address

PostalAddress

הכתובת למשלוח דואר של החשבון.

phone_number

string

מספר הטלפון ליצירת קשר של הארגון.

AccountRole

מציין את רמת הגישה שיש למשתמש המאומת לחשבון הזה. מידע נוסף זמין במאמר במרכז העזרה.

טיפוסים בני מנייה (enum)
ACCOUNT_ROLE_UNSPECIFIED לא צוין.
OWNER המשתמש הוא הבעלים של החשבון הזה. (מוצג כ'הבעלים הראשי' בממשק המשתמש).
CO_OWNER המשתמש הוא בעלים-שותף של החשבון. (מוצג כ'בעלים' בממשק המשתמש).
MANAGER המשתמש יכול לנהל את החשבון הזה.
COMMUNITY_MANAGER המשתמש יכול לנהל דפים חברתיים (Google+ ) של החשבון. (מוצג כ'מנהל האתר' בממשק המשתמש).

AccountState

מציין את סטטוס החשבון, למשל אם החשבון אומת על ידי Google.

שדות
status

AccountStatus

אם הם מאומתים, מיקומים עתידיים שייווצרו מחוברים באופן אוטומטי למפות Google ותיצור מהם דפי Google+ ללא צורך בניהול.

AccountStatus

מציין את סטטוס האימות של החשבון.

טיפוסים בני מנייה (enum)
ACCOUNT_STATUS_UNSPECIFIED לא צוין.
VERIFIED החשבון מאומת.
UNVERIFIED חשבון שלא אומת ולא נשלחה בקשה לאימות.
VERIFICATION_REQUESTED החשבון לא אומת, אבל נשלחה בקשה לאימות.

AccountType

מציין מהו סוג החשבון: חשבון אישי, חשבון משתמש או חשבון עסקי.

טיפוסים בני מנייה (enum)
ACCOUNT_TYPE_UNSPECIFIED לא צוין.
PERSONAL חשבון של משתמש קצה.
LOCATION_GROUP קבוצה של מיקומים. מידע נוסף זמין במאמר במרכז העזרה.
USER_GROUP קבוצת משתמשים להפרדה בין אנשי צוות בארגון. מידע נוסף זמין במאמר במרכז העזרה.
ORGANIZATION ארגון שמייצג חברה מסוימת. מידע נוסף זמין במאמר במרכז העזרה.

AdWordsLocationExtensions

מידע נוסף שמוצג ב-AdWords.

שדות
ad_phone

string

מספר טלפון חלופי להצגה בתוספי מיקום של AdWords, במקום מספר הטלפון הראשי של המיקום.

AddressInput

קלט לאימות ADDRESS.

שדות
mailer_contact_name

string

שם איש הקשר שאליו יש לשלוח את האימייל.

ניהול מערכת

אדמין של Account או Location.

שדות
name

string

שם המשאב לאדמינים של חשבונות, הפורמט הזה הוא: accounts/{account_id}/admins/{admin_id}

לאדמינים של מיקומים, בפורמט הזה: accounts/{account_id}/locations/{location_id}/admins/{admin_id}

admin_name

string

השם של האדמין. כששולחים את ההזמנה הראשונית, זו כתובת האימייל של המוזמן. בשיחות עם GET, כתובת האימייל של המשתמש מוחזרת אם ההזמנה עדיין בהמתנה. אחרת, היא מכילה את השם הפרטי ואת שם המשפחה של המשתמש.

role

AdminRole

המדיניות מציינת את AdminRole שהאדמין הזה משתמש בו עם המשאב Account או Location שצוינו.

pending_invitation

bool

פלט בלבד. השדה הזה מציין אם לאדמין יש הזמנה בהמתנה למשאב שצוין.

AdminRole

מציין את רמת הגישה שיש לאדמין. מידע נוסף זמין במאמר במרכז העזרה.

טיפוסים בני מנייה (enum)
ADMIN_ROLE_UNSPECIFIED לא צוין.
OWNER לאדמין יש גישה ברמת הבעלים והוא הבעלים הראשי. (מוצג כ'הבעלים הראשי' בממשק המשתמש).
CO_OWNER לאדמין יש גישה ברמת בעלים. (מוצג כ'בעלים' בממשק המשתמש).
MANAGER לאדמין יש הרשאת גישה ניהולית.
COMMUNITY_MANAGER האדמין יכול לנהל דפים של רשתות חברתיות (Google+ ). (מוצג כ'מנהל האתר' בממשק המשתמש).

AlertType

סוג האירוע שבשבילו נוצר פוסט ההתראה.

טיפוסים בני מנייה (enum)
ALERT_TYPE_UNSPECIFIED לא הוגדרה התראה.
COVID_19 התראות שקשורות למגפת הקורונה (COVID-19). פוסטים בנושא נגיף הקורונה תומכים רק בשדה סיכום ובשדה קריאה לפעולה. כשההתראות האלה לא יהיו רלוונטיות יותר, האפשרות ליצור פוסט חדש של התראה מסוג נגיף הקורונה (COVID-19) תושבת. עם זאת, המוכר עדיין יוכל לנהל את הפוסטים הקיימים שלו בנושא נגיף הקורונה.

אלרגן

מידע על אלרגנים לגבי פריט מזון.

טיפוסים בני מנייה (enum)
ALLERGEN_UNSPECIFIED לא צוין אלרגן
DAIRY אלרגן למוצרי חלב
EGG אלרגן שקשור לביצים
FISH אלרגן שקשור לדגים
PEANUT אלרגן שקשור לבוטנים
SHELLFISH אלרגן שקשור לפירות ים
SOY אלרגן שקשור לסויה
TREE_NUT אלרגן שקשור לאגוזי עץ
WHEAT אלרגן שקשור לחיטה

תשובה

מייצג תשובה לשאלה

שדות
name

string

פלט בלבד. השם הייחודי של חשבונות התשובות/*/locations/*/questions/*/answers/*

author

Author

פלט בלבד. מחבר התשובה.

upvote_count

int32

פלט בלבד. מספר הלייקים לתשובה.

text

string

הטקסט של התשובה. היא צריכה להכיל לפחות תו אחד שהוא לא רווח לבן. האורך המקסימלי הוא 4,096 תווים.

create_time

Timestamp

פלט בלבד. חותמת הזמן של מועד כתיבת התשובה.

update_time

Timestamp

פלט בלבד. חותמת הזמן של מועד השינוי האחרון של התשובה.

AssociateLocationRequest

הודעת בקשה עבור Locations.AssociateLocationRequest.

שדות
name

string

שם המשאב של המיקום לשיוך.

place_id

string

השיוך שצריך להקים. אם היא לא מוגדרת, סימן שאין התאמה.

מאפיין

מאפיין מיקום. המאפיינים מספקים מידע נוסף על המיקום. המאפיינים שניתן להגדיר במיקום מסוים עשויים להשתנות בהתאם למאפיינים של המיקום (לדוגמה, קטגוריה). המאפיינים הזמינים נקבעים על ידי Google, ויכול להיות שיתווספו ויוסרו בלי לבצע שינויים ב-API.

שדות
attribute_id

string

המזהה של המאפיין. Google מספקת את מזהי המאפיינים.

value_type

AttributeValueType

פלט בלבד. סוג הערך שהמאפיין הזה מכיל. צריך להשתמש בו כדי לקבוע איך לפרש את הערך.

values[]

Value

הערכים של המאפיין הזה. סוג הערכים שמצוינים צריך להיות תואם לסוג הערכים הצפויים למאפיין הזה. למידע נוסף, אפשר לעיין ב-AttributeValueType. זהו שדה חוזר שבו אפשר לספק כמה ערכי מאפיינים. סוגי מאפיינים תומכים רק בערך אחד.

repeated_enum_value

RepeatedEnumAttributeValue

כשהסוג של ערך המאפיין הוא REPEATED_ENUM, הערך הזה מכיל את ערך המאפיין ושדות הערכים האחרים חייבים להיות ריקים.

url_values[]

UrlAttributeValue

כשהסוג של ערך המאפיין הוא כתובת URL, השדה הזה מכיל את הערכים של המאפיין הזה ושאר השדות של הערכים צריכים להיות ריקים.

AttributeMetadata

מטא-נתונים של מאפיין. מכיל את פרטי התצוגה של המאפיין, כולל שם שמותאם לשוק המקומי וכותרת לקיבוץ מאפיינים קשורים יחד.

שדות
attribute_id

string

המזהה של המאפיין.

value_type

AttributeValueType

סוג הערך של המאפיין. הערכים שהוגדרו ואוחזרו צריכים להיות מהסוג הזה.

display_name

string

השם המוצג של המאפיין שמותאם לשוק המקומי, אם זמין. אחרת, השם המוצג באנגלית.

group_display_name

string

השם המוצג של הקבוצה שמכילה את המאפיין הזה, אם קיים. אחרת, את שם הקבוצה באנגלית. המאפיינים הקשורים נאספים בתוך קבוצה, וצריך להציג אותם יחד מתחת לכותרת שמופיעה כאן.

is_repeatable

bool

אם True, המאפיין תומך בכמה ערכים. אם False, יש לציין רק ערך אחד.

value_metadata[]

AttributeValueMetadata

לסוגים מסוימים של מאפיינים (לדוגמה, enums) מוצגת רשימה של ערכים נתמכים ושמות מוצגים שתואמים לערכים האלה.

is_deprecated

bool

אם הערך הוא True, המאפיין הוצא משימוש ולא צריך להשתמש בו יותר. אם מוציאים את המאפיין הזה משימוש, עדכון המאפיין לא יגרום לשגיאה, אבל העדכונים לא יישמרו. בשלב מסוים אחרי שהמאפיין יצא משימוש, המאפיין יוסר לחלוטין והוא יהפוך לשגיאה.

AttributeValueMetadata

מטא-נתונים של ערכי מאפיינים נתמכים.

שדות
value

Value

ערך המאפיין.

display_name

string

השם המוצג של הערך הזה, אם הוא מותאם לשוק המקומי. אחרת, באנגלית. השם המוצג של הערך מיועד לשימוש בהקשר של השם המוצג של המאפיין.

לדוגמה, עבור רשת Wi-Fi מאפיין enum, יכול להכיל את הערך 'שולם' כדי לייצג Wi-Fi בתשלום.

AttributeValueType

סוג הערך של המאפיין.

טיפוסים בני מנייה (enum)
ATTRIBUTE_VALUE_TYPE_UNSPECIFIED לא צוין.
BOOL הערכים במאפיין הזה הם ערכים בוליאניים.
ENUM למאפיין רשימה מוגדרת מראש של ערכים זמינים שבהם אפשר להשתמש. הערכים האלה יופיעו במטא-נתונים של המאפיין הזה.
URL הערכים במאפיין הזה הם כתובות URL.
REPEATED_ENUM ערך המאפיין הוא 'טיפוסים בני מנייה (enum)' עם כמה ערכים אפשריים שאפשר להגדיר או לבטל באופן מפורש.

מחבר/ת

מייצג את המחבר של שאלה או תשובה

שדות
display_name

string

השם המוצג של המשתמש

profile_photo_url

string

כתובת ה-URL של תמונת הפרופיל של המשתמש.

type

AuthorType

סוג המשתמש שהוא המחבר.

AuthorType

דוגמאות לסוג המשתמש של המחבר.

טיפוסים בני מנייה (enum)
AUTHOR_TYPE_UNSPECIFIED אין להשתמש באפשרות הזו.
REGULAR_USER משתמש רגיל.
LOCAL_GUIDE ממליץ מקומי
MERCHANT הבעלים או המנהל של המיקום

BasicMetricsRequest

בקשה לתובנות בסיסיות על מדדים.

שדות
metric_requests[]

MetricRequest

אוסף של מדדים להחזרת ערכים, לרבות האפשרויות לאופן החזרת הנתונים.

time_range

TimeRange

הטווח שעבורו רוצים לאסוף מדדים. הטווח המקסימלי הוא 18 חודשים מתאריך הבקשה. במקרים מסוימים, הנתונים עדיין עשויים להיות חסרים בימים שקרובים לתאריך הבקשה. נתונים חסרים יצוינו metricValues בתשובה.

BatchGetBusinessCategoriesRequest

הודעה בנושא בקשה לקטגוריות של עסקים.BatchGetBusinessCategory.

שדות
language_code

string

חובה. קוד השפה של BCP 47 שבו צריך להחזיר את שמות הקטגוריות.

category_ids[]

string

חובה. יש להגדיר שם אחד לפחות. מזהי GConcept שעבורם צריך להחזיר את שמות הקטגוריות שהותאמו לשוק המקומי.

region_code

string

זה שינוי אופציונלי. קוד המדינה בפורמט ISO 3166-1 alpha-2 המשמש להסקת השפה שאינה סטנדרטית.

view

CategoryView

חובה. מציינת אילו חלקים של המשאב 'קטגוריה' יוחזרו בתשובה.

BatchGetBusinessCategoriesResponse

הודעת תגובה בנושא קטגוריות העסק.BatchGetBusiness categories.

שדות
categories[]

Category

קטגוריות שתואמות למזהי GConcept שצוינו בבקשה. הם לא יופיעו באותו סדר כמו מזהי הקטגוריות בבקשה.

BatchGetLocationsRequest

הודעה עם בקשה לקבלת מיקומים.BatchGetLocations.

שדות
name

string

שם החשבון שממנו יש לאחזר את המיקומים.

location_names[]

string

אוסף של מיקומים לאחזור, שצוינו לפי השמות שלהם.

BatchGetLocationsResponse

הודעת תגובה לגבי Locations.BatchGetLocations.

שדות
locations[]

Location

אוסף של מיקומים.

BatchGetReviewsRequest

הודעה לבקשת ביקורות.BatchGetReviews.

שדות
name

string

שם החשבון שממנו יש לאחזר רשימה של ביקורות במיקומים מרובים.

location_names[]

string

אוסף של מיקומים שעבורם רוצים לאחזר ביקורות, שצוינו לפי השמות שלהם.

page_size

int32

כמה ביקורות לאחזר בכל דף. ערך ברירת המחדל הוא 50.

page_token

string

אם צוין, הוא יאחזר את דף הביקורות הבא.

order_by

string

זה שינוי אופציונלי. מציינת את השדה שלפיו צריך למיין את הביקורות. אם לא צויין ערך, סדר הצגת הביקורות שהוחזרו יהיה update_time desc כברירת מחדל. הזמנות תקפות למיון לפי הן rating, rating desc ו-update_time desc. מערכת rating תחזיר ביקורות בסדר עולה. אין תמיכה ב-update_time(כלומר, בסדר עולה).

ignore_rating_only_reviews

bool

הגדרה שקובעת אם להתעלם מביקורות שמיועדות לדירוג בלבד.

BatchGetReviewsResponse

הודעת תגובה ל-Reviews.BatchGetReviews.

שדות
location_reviews[]

LocationReview

ביקורות שכוללות פרטי מיקום.

next_page_token

string

אם מספר הביקורות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף הביקורות הבא בקריאות הבאות. אם אין יותר ביקורות, השדה הזה לא יופיע בתשובה.

BusinessHours

מייצג את תקופות הזמן שבהן המיקום הזה פעיל. מכיל אוסף של TimePeriod מכונות.

שדות
periods[]

TimePeriod

אוסף של שעות הפעילות של המיקום הזה. כל תקופה מייצגת טווח של שעות שבהן המיקום פתוח במהלך השבוע.

CallToAction

פעולה שמבוצעת כשמשתמש לוחץ על הפוסט

שדות
action_type

ActionType

סוג הפעולה שתבוצע.

url

string

כתובת ה-URL שאליה המשתמש יופנה אחרי הלחיצה. יש להשאיר את השדה הזה לא מוגדר עבור 'קריאה לפעולה לשיחה'.

ActionType

סוג הפעולה שתבוצע.

טיפוסים בני מנייה (enum)
ACTION_TYPE_UNSPECIFIED סוג לא צוין.
BOOK בפוסט הזה רוצים שמשתמש יוכל לקבוע פגישה, טבלה וכו'.
ORDER הפוסט הזה מבקש שמשתמש יזמין משהו.
SHOP הפוסט הזה מבקש שמשתמש יעיין בקטלוג מוצרים.
LEARN_MORE פוסט זה נועד שהמשתמש יוכל לקבל מידע נוסף (באתר שלו).
SIGN_UP פוסט זה מבקש שמשתמש יירשם/יירשם/יצטרף משהו.
GET_OFFER

הוצא משימוש. כדי ליצור פוסט עם תוכן של מבצע, צריך להשתמש בOFFER בLocalPostTopicType.

CALL הפוסט הזה מבקש שמשתמש יתקשר לעסק.

קטגוריה

קטגוריה שמתארת מהו העסק הזה (לא מה הוא עושה). בכתובת categories.list תוכלו למצוא רשימה של מזהי קטגוריות חוקיים, ואת המיפויים לשמות שלהם שקריאים לאנשים.

שדות
display_name

string

הקצר הזה. התשובות שלך יעזרו לנו להשתפר. שם קריא לאנשים של הקטגוריה. ההגדרה הזו מוגדרת כשקוראים את המיקום. כשמשנים את המיקום, צריך להגדיר category_id.

הערה: השדה הזה משמש רק בתשובות. המערכת תתעלם מכל ערך שמצוין כאן בבקשה.

category_id

string

הקצר הזה. התשובות שלך יעזרו לנו להשתפר. מזהה קבוע (שסופק על ידי Google) לקטגוריה הזאת. צריך לציין את category_id כשמשנים את הקטגוריה (כשיוצרים או מעדכנים מיקום).

הערה: השדה הזה משמש רק בתשובות. המערכת תתעלם מכל ערך שמצוין כאן בבקשה.

service_types[]

ServiceType

הקצר הזה. התשובות שלך יעזרו לנו להשתפר. רשימה של כל סוגי השירותים שזמינים בקטגוריה הזו של העסק.

הערה: השדה הזה משמש רק בתשובות. המערכת תתעלם מכל ערך שמצוין כאן בבקשה.

more_hours_types[]

MoreHoursType

פלט בלבד. סוגי שעות נוספים שזמינים בקטגוריה הזו של העסק.

CategoryView

טיפוסים בני מנייה (enum) שעוזרים להגביל את כמות הנתונים שהשרת מחזיר.

טיפוסים בני מנייה (enum)
CATEGORY_VIEW_UNSPECIFIED לא צוין, שווה ערך ל-CATEGORY_metaDATA_ONLY
BASIC תגובת השרת תכלול רק את השדות display_name, category_id ו-language_code. היא משמיטה שדות שקשורים למטא-נתונים של סוגי שירות.
FULL הפונקציה מחזירה את כל השדות בתשובה.

שרשרת

רשת היא מותג שאפשר לשייך אליו את מיקומי העסק.

שדות
name

string

שם המשאב של השרשרת, בפורמט chains/{chain_place_id}.

chain_names[]

ChainName

שמות השרשרת.

websites[]

ChainUrl

אתרים של הרשת.

location_count

int32

מספר המיקומים שהם חלק מהרשת הזו.

ChainName

השם שישמש להצגת הרשת.

שדות
display_name

string

השם המוצג של הרשת הזו.

language_code

string

קוד השפה של השם ב-BCP 47.

ChainUrl

כתובת ה-URL שתשמש להצגת הרשת.

שדות
url

string

כתובת ה-URL של הרשת הזו.

ClearLocationAssociationRequest

הודעת בקשה ל-Locations.ClearLocationAssociationRequest.

שדות
name

string

שם המשאב של המיקום שרוצים לבטל את השיוך שלו.

CompleteVerificationRequest

הודעת בקשה לאימות.השלמת אימות פעולה.

שדות
name

string

שם משאב האימות שצריך להשלים.

pin

string

קוד האימות התקבל על ידי המוכר כדי להשלים את האימות.

CompleteVerificationResponse

הודעת תגובה ל-Authentications.Complete VerificationAction.

שדות
verification

Verification

האימות הושלם.

CreateAccountAdminRequest

הודעת בקשה ל-AccessControl.CreateAccountAdmin.

שדות
parent

string

שם המשאב של החשבון שבשבילו האדמין הזה נוצר.

admin

Admin

האדמין ליצור

CreateAccountRequest

הודעת בקשה ל-accounts.CreateAccount.

שדות
primary_owner

string

שם המשאב של החשבון שיהיה הבעלים הראשי של החשבון שייווצר. הוא אמור להיות בפורמט accounts/{account_id}/.

account

Account

פרטי החשבון של החשבון שברצונך ליצור. השדות המותרים היחידים הם account_name ו-type.

CreateLocalPostRequest

הודעת בקשה ל-CreateLocalPost.

שדות
parent

string

שם המיקום שבו יש ליצור את הפוסט המקומי.

local_post

LocalPost

המטא-נתונים של הפוסט המקומי החדש.

CreateLocationAdminRequest

הודעת בקשה ל-AccessControl.CreateLocationAdmin.

שדות
parent

string

שם המשאב של המיקום שבשבילו האדמין הזה נוצר.

admin

Admin

האדמין ליצור

CreateLocationRequest

הודעת בקשה עבור Locations.CreateLocation.

שדות
parent

string

שם החשבון שבו יש ליצור את המיקום הזה.

location

Location

המטא-נתונים של המיקום החדש.

validate_only

bool

אם True, הבקשה מאומתת בלי ליצור את המיקום בפועל.

request_id

string

מזהה בקשה ייחודי שיאפשר לשרת לזהות בקשות כפולות. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID). האורך המרבי הוא 50 תווים.

CreateMediaItemRequest

הודעת בקשה עבור Media.CreateMediaItem.

שדות
parent

string

שם המשאב של המיקום שבו פריט המדיה הזה ייווצר.

media_item

MediaItem

פריט המדיה שיש ליצור.

CreateQuestionRequest

הודעת בקשה ל-QuestionAndAnswers.CreateQuestion

שדות
parent

string

שם המיקום שעליו רוצים לכתוב שאלה.

question

Question

השאלה החדשה.

DeclineInvitationRequest

הודעת בקשה עבור AccessControl.Declinela.

שדות
name

string

שם הזמנת החשבון שנדחתה.

DeleteAccountAdminRequest

הודעת בקשה בנושא AccessControl.DeleteAccountAdmin.

שדות
name

string

שם המשאב של האדמין להסרה מהחשבון.

DeleteAnswerRequest

בקשה לקבלת הודעה לגבי שאלותAndAnswers.DeleteAnswer

שדות
parent

string

שם השאלה שעבורה רוצים למחוק תשובה.

DeleteLocalPostRequest

הודעת בקשה ל-DeleteLocalPost.

שדות
name

string

שם הפוסט המקומי שרוצים למחוק.

DeleteLocationAdminRequest

הודעת בקשה ל-AccessControl.DeleteLocationAdmin.

שדות
name

string

שם המשאב של האדמין להסרה מהמיקום.

DeleteLocationRequest

שליחת הודעה לגבי Locations.DeleteLocation.

שדות
name

string

שם המיקום שרוצים למחוק.

DeleteMediaItemRequest

הודעת בקשה עבור Media.DeleteMediaItem.

שדות
name

string

השם של פריט המדיה שרוצים למחוק.

DeleteNotificationsRequest

הודעת בקשה ל-Accounts.DeleteNotifications.

שדות
name

string

שם המשאב שצריך למחוק את הגדרת ההתראות.

DeleteQuestionRequest

הודעת בקשה ל-QuestionAndAnswers.DeleteQuestion

שדות
name

string

שם השאלה שרוצים למחוק.

DeleteReviewReplyRequest

הודעת בקשה ל-Reviews.DeleteReviewReply.

שדות
name

string

שם הביקורת שרוצים למחוק.

DietaryRestriction

מידע תזונתי של פריט מזון.

טיפוסים בני מנייה (enum)
DIETARY_RESTRICTION_UNSPECIFIED לא צוין סוג תזונתי
HALAL ציון האוכל כמנה עם הכשר חלאל.
KOSHER ציון האוכל כמנה כשרה.
ORGANIC ציון האוכל כמנה אורגנית.
VEGAN ציון האוכל כמנה טבעונית.
VEGETARIAN ציון האוכל כמנה צמחונית.

DimensionalMetricValue

ערך של מדד יחיד עם מאפיין זמן נתון.

שדות
metric_option

MetricOption

האפשרות שביקשה את הערך המימדי הזה.

time_dimension

TimeDimension

המאפיין של הערך.

value

Int64Value

הערך. אם לא מוגדר ערך, הנתונים המבוקשים חסרים.

TimeDimension

המאפיין שעבורו הנתונים מחולקים.

שדות
day_of_week

DayOfWeek

היום בשבוע ('יום שני' עד 'יום ראשון') תואם לערך הזה. מוגדר לאפשרות breakDOWN_DAY_OF_WEEK.

time_of_day

TimeOfDay

השעה ביום (0 עד 23) שהערך הזה תואם לה. מוגדר לאפשרות breakDOWN_HOUR_OF_DAY.

time_range

TimeRange

טווח הזמן שנכלל בערך הזה. מוגדר לאפשרויות AGGREGATED_TOTAL ו-AGGREGATED_DAILY.

DrivingDirectionMetricsRequest

בקשה לקבלת תובנות לגבי מסלולי נסיעה.

שדות
num_days

NumDays

מספר הימים שלגביו עליך לצבור נתונים. התוצאות שהוחזרו יהיו זמינות נתונים לגבי מספר הימים האחרונים המבוקשים. הערכים החוקיים הם 7, 30 ו-90.

language_code

string

את קוד BCP 47 של השפה. אם לא תספקו קוד שפה, ברירת המחדל תהיה אנגלית.

NumDays

מספר הימים שבהם הבקשה הזו יכולה לתמוך.

טיפוסים בני מנייה (enum)
SEVEN 7 ימים. זהו ערך ברירת המחדל.
THIRTY 30 ימים.
NINETY 90 ימים.

EmailInput

קלט לאימות באימייל.

שדות
email_address

string

כתובת האימייל שאליה צריך לשלוח את קוד האימות.

כתובת אימייל תתקבל רק אם היא אחת מהכתובות שסופקו על ידי FetchAuthenticationOptions. אם ב-EmailVerificationData מוגדר הערך True, הלקוח יכול לציין שם משתמש אחר (local-part) אבל חייב להתאים לשם הדומיין.

ErrorDetail

מציג פרטים על שגיאה שגרמה לאימות או לכשל פנימי.

שדות
code

int32

קוד הסטטוס, שצריך להיות ערך enum של ErrorCode.

field

string

נתיב שמוביל לשדה בגוף הבקשה. הערך הזה הוא רצף של מזהים המופרדים באמצעות נקודות שמזהים שדה של מאגר נתונים זמני של פרוטוקול. לדוגמה, 'error_details.field' יזהה את השדה הזה.

message

string

תיאור של הסיבה לכשל בשדה. ההודעה כתובה באנגלית ויכול להיות שלא מתאימה להצגה למשתמשים.

value

string

הערך שנכשל עם הבקשה.

field_index

int32

אם שדה הבקשה שיצר את השגיאה הזו חוזר על עצמו, הוא יכיל את האינדקס מבוסס האפס של הערך בשדה הזה, שהאימות נכשל.

ErrorCode

קודי שגיאה עבור ErrorDetail:

  • 1 עד 199: קודי שגיאה נפוצים שחלים על כל השדות.
  • 1000 עד 1099: קודי שגיאה הקשורים לתמונות.
  • 1100 עד 1199: קודי שגיאה הקשורים לכתובת ולקו אורך/רוחב.
  • 1200 עד 1299: קודי שגיאה הקשורים לקטגוריה.
  • 1300 עד 1399: קודי שגיאה הקשורים לפעולה.

טיפוסים בני מנייה (enum)
ERROR_CODE_UNSPECIFIED קוד שגיאה כולל.
MISSING_VALUE לא צוין ערך נדרש.
INVALID_VALUE סופק ערך לא חוקי.
INVALID_CHARACTERS נמצאו תווים לא חוקיים.
TOO_MANY_ITEMS בשדה חוזר צוין מספר פריטים גדול יותר מהמספר המקסימלי המותר.
READ_ONLY אי אפשר לשנות שדה לקריאה בלבד.
OVERLAPPING_RANGES פריטים בשדה חוזר הם טווחים שחופפים זה לזה.
INVERTED_RANGE הטווח שצוין הפוך. התנאי הזה חל גם על טווח ריק.
VALUE_OUTSIDE_ALLOWED_RANGE הערך שצוין נמצא מחוץ לטווח המותר.
MISSING_DEPENDENT_FIELD שדה תלוי נדרש לא קיים.
FIELD_HAS_DEPENDENCIES שדה הנדרש על ידי שדה תלוי ואי אפשר להסיר אותו.
UNSUPPORTED_VALUE הערך שצוין, אם כי ייתכן שהוא תקין, לא נתמך בגלל אילוצים אחרים.
EXPIRED_VALUE פג התוקף של הערך שהוזן, והוא לא תקף יותר.
PHOTO_FETCH_FAILED לא הצלחנו לאחזר את התמונה מכתובת ה-URL שצוינה.
PHOTO_UPLOAD_FAILED העלאת התמונה מכתובת ה-URL שצוינה נכשלה.
GEOCODE_ERROR אירעה שגיאה בקביעה אוטומטית של קו הרוחב/אורך.
LAT_LNG_OUTSIDE_COUNTRY קו הרוחב/קו האורך שצוינו לא רלוונטיים למדינה שצוינה.
LAT_LNG_REQUIRED יש לציין קו רוחב וקו אורך.
LAT_LNG_TOO_FAR_FROM_ADDRESS הצמד של קו הרוחב/קו האורך והכתובת רחוק מדי זה מזה.
CATEGORY_NOT_VERIFIED הקטגוריה שצוינה לא מאומתת.
OPERATION_EXECUTION_ERROR הייתה שגיאת ביצוע כללית של הפעולה.
OPERATION_UNSUPPORTED_UNDER_ACCOUNT_CONDITION הפעולה אינה נתמכת עקב מצב החשבון.
LOCATION_DISABLED_FOR_LOCAL_POST_API המיקום מושבת ב-Local Post API.

FetchVerificationOptionsRequest

בקשה להודעה לאימותs.FetchAuthenticationOptions.

שדות
name

string

שם המשאב של המיקום לאימות.

language_code

string

קוד השפה BCP 47 שמייצג את השפה שבה יש להשתמש בתהליך האימות. האפשרויות הזמינות משתנות בהתאם לשפה.

context

ServiceBusinessContext

מידע נוסף בהקשר לאימות עסקים שמספקים שירותים. חובה עבור המיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. הפונקציה INVALID_ARGUMENT תופיע אם היא מוגדרת לסוגי עסקים אחרים של מיקומים.

FetchVerificationOptionsResponse

הודעת תגובה לגבי verifications.FetchAuthenticationOptions.

שדות
options[]

VerificationOption

אפשרויות האימות הזמינות.

FindMatchingLocationsRequest

שליחת הודעה לגבי Locations.FindMatchingLocations

שדות
name

string

שם המשאב של המיקום כדי לחפש התאמות.

language_code

string

השפה המועדפת למיקום התואם (בפורמט BCP-47).

num_results

int32

מספר ההתאמות שיש להחזיר. ערך ברירת המחדל הוא 3, והערך המקסימלי הוא 10. חשוב לזכור שזמן האחזור יכול להתארך אם תישלח בקשה נוספת. אין חלוקה לדפים.

max_cache_duration

Duration

הוצא משימוש. המערכת מתעלמת מהשדה הזה בכל הבקשות.

FindMatchingLocationsResponse

הודעת תגובה לגבי Locations.FindMatchingLocations (מיקומים).

שדות
matched_locations[]

MatchedLocation

אוסף של מיקומים שעשויים להיות התאמות פוטנציאליות למיקום שצוין, בחלוקה לפי סדר מהטוב ביותר לנמוך ביותר. אם קיימת התאמה מדויקת, היא תופיע במיקום הראשון.

match_time

Timestamp

מתי בוצע אלגוריתם ההתאמה האחרון עבור המיקום הזה.

FollowersMetadata

מטא-נתונים של עוקב אחר מיקום.

שדות
name

string

שם המשאב של השדה הזה. accounts/{account_id}/locations/{location_id}/followers/metadata

count

uint64

המספר הכולל של עוקבים במיקום.

FoodMenu

תפריט של עסק שמגישים בו מנות.

שדות
labels[]

MenuLabel

חובה. תוויות עם תיוג לפי שפה של התפריט. לדוגמה "תפריט", "ארוחת צהריים מיוחדת". השמות המוצגים צריכים להיות באורך 140 תווים לכל היותר, ובאורך של 1,000 תווים לכל היותר. נדרשת לפחות קבוצה אחת של תוויות.

source_url

string

זה שינוי אופציונלי. כתובת ה-URL של המקור של התפריט, אם יש דף אינטרנט שאליו צריך לעבור.

sections[]

FoodMenuSection

חובה. קטעים בתפריט.

cuisines[]

Cuisine

זה שינוי אופציונלי. מידע על המטבח בתפריט האוכל. מומלץ מאוד לספק את השדה הזה.

סוג מטבח

מידע על סוג המטבח של מסעדה מסוימת.

טיפוסים בני מנייה (enum)
CUISINE_UNSPECIFIED לא צוין מטבח
AMERICAN אוכל אמריקאי
ASIAN אוכל אסיאתי
BRAZILIAN אוכל ברזילאי
BREAK_FAST ארוחת בוקר
BRUNCH בראנץ'
CHICKEN עוף
CHINESE אוכל סיני
FAMILY מטבח בסגנון משפחתי
FAST_FOOD מזון מהיר
FRENCH אוכל צרפתי
GREEK אוכל יווני
GERMAN אוכל גרמני
HAMBURGER המבורגר
INDIAN אוכל הודי
INDONESIAN אוכל אינדונזי
ITALIAN אוכל איטלקי
JAPANESE אוכל יפני
KOREAN אוכל קוריאני
LATIN_AMERICAN אוכל מאמריקה הלטינית
MEDITERRANEAN אוכל ים-תיכוני
MEXICAN אוכל מקסיקני
PAKISTANI אוכל פקיסטני
PIZZA פיצה
SEAFOOD מאכלי ים
SPANISH אוכל ספרדי
SUSHI סושי
THAI אוכל תאילנדי
TURKISH אוכל טורקי
VEGETARIAN אוכל צמחוני
VIETNAMESE אוכל וייטנאמי
OTHER_CUISINE מטבח אחר

FoodMenuItem

פריט של סעיף. זו יכולה להיות המנה עצמה, או שהיא יכולה לכלול כמה אפשרויות מזון ומשקאות.

שדות
labels[]

MenuLabel

חובה. תוויות מתויגות בשפה של האפשרות הזו בתפריט. השמות המוצגים צריכים להיות באורך 140 תווים לכל היותר, ובאורך של 1,000 תווים לכל היותר. נדרשת לפחות קבוצה אחת של תוויות.

attributes

FoodMenuItemAttributes

חובה. מאפיינים מפורטים של הפריט. כשמציינים אפשרויות פריט, זה נחשב כמאפייני הבסיס ומאוכלסים בכל אחת מהאפשרויות.

options[]

FoodMenuItemOption

זה שינוי אופציונלי. הערך הזה הוא פריט שזמין בכמה אפשרויות שונות, והמשתמשים נדרשים לבחור את האפשרויות הרצויות. לדוגמה "רגיל" לעומת 'גדול' פיצה. כשמציינים אפשרויות, תוויות ומאפיינים ברמת הפריט יהפכו באופן אוטומטי לתוויות ולמאפיינים של האפשרות הראשונה. הלקוחות צריכים לציין רק אפשרויות אחרות של מזון בשדה הזה.

FoodMenuItemAttributes

מאפיינים של פריט אוכל/מנה.

שדות
price

Money

חובה. המחיר של מנת האוכל.

spiciness

Spiciness

זה שינוי אופציונלי. רמת החריפות של מנת האוכל.

allergen[]

Allergen

זה שינוי אופציונלי. אלרגנים הקשורים למנה האוכל. מומלץ מאוד לספק את השדה הזה.

dietary_restriction[]

DietaryRestriction

זה שינוי אופציונלי. מידע תזונתי של המנה. מומלץ מאוד לספק את השדה הזה.

nutrition_facts

NutritionFacts

זה שינוי אופציונלי. ערכים תזונתיים של אפשרות המנה. מומלץ מאוד לספק את השדה הזה.

ingredients[]

Ingredient

זה שינוי אופציונלי. המרכיבים של אפשרות המנה.

serves_num_people

int32

זה שינוי אופציונלי. מספר האנשים שאפשר לקבל ממנות האוכל האלה.

preparation_methods[]

PreparationMethod

זה שינוי אופציונלי. שיטות להכנה של מנות האוכל.

portion_size

PortionSize

זה שינוי אופציונלי. גודל ההזמנה, מיוצג ביחידות של פריטים. (למשל: 4 "שיפודים", 6 "חתיכות")

media_keys[]

string

זה שינוי אופציונלי. מקשי המדיה של המדיה שמשויכת למנה. יש תמיכה רק במדיה של תמונות. אם משויכות כמה תמונות, התמונה הראשונה תיחשב כתמונה המועדפת.

מרכיב

ההודעה הזו מציינת מידע על המרכיבים במנה אוכל.

שדות
labels[]

MenuLabel

חובה. תוויות לתיאור הרכיב. השמות המוצגים צריכים להיות באורך 140 תווים לכל היותר, ובאורך של 1,000 תווים לכל היותר. נדרשת לפחות קבוצה אחת של תוויות.

PortionSize

גודל המנה של מנה אוכל.

שדות
quantity

int32

חובה. מספר החלק.

unit[]

MenuLabel

חובה. השדה name_info החוזר מיועד ליחידה במספר שפות.

FoodMenuItemOption

אפשרות של פריט. נדרשת בחירה מפורשת של המשתמש.

שדות
labels[]

MenuLabel

חובה. תוויות מתויגות בשפה של האפשרות הזו בתפריט. E.g.: "beef pad thai", "veggie pad thai", "small פיצה", "large פיצה". השמות המוצגים צריכים להיות באורך 140 תווים לכל היותר, ובאורך של 1,000 תווים לכל היותר. נדרשת לפחות קבוצה אחת של תוויות.

attributes

FoodMenuItemAttributes

חובה. מאפיינים מפורטים של אפשרות הפריט. מאפיינים ספציפיים שלא צוינו יעברו בירושה מההרשאות ברמת הפריט בתור הבסיס.

FoodMenuSection

קטע בתפריט. הוא יכול להכיל כמה פריטים/מנות.

שדות
labels[]

MenuLabel

חובה. תוויות מתויגות בשפה של הקטע הזה בתפריט. השמות המוצגים צריכים להיות באורך 140 תווים לכל היותר, ובאורך של 1,000 תווים לכל היותר. נדרשת לפחות קבוצה אחת של תוויות.

items[]

FoodMenuItem

חובה. פריטים בקטע. כל קטע חייב להכיל פריט לפחות.

FoodMenus

תפריטים של עסק שמגישים בו מנות.

שדות
name

string

חובה. מזהה Google של המיקום הזה בטופס: accounts/{account_id}/locations/{location_id}/foodMenus

menus[]

FoodMenu

זה שינוי אופציונלי. אוסף של תפריטי אוכל.

GenerateAccountNumberRequest

הודעת בקשה עבור Accounts.GenerateAccountNumber.

שדות
name

string

שם החשבון שעבורו רוצים ליצור מספר חשבון.

GetAccountRequest

הודעת בקשה עבור Accounts.GetAccount.

שדות
name

string

שם החשבון שברצונך לאחזר.

GetChainRequest

הודעת בקשה עבור Locations.GetChain.

שדות
name

string

שם המשאב של השרשרת, בפורמט chains/{chain_place_id}.

GetCustomerMediaItemRequest

הודעת בקשה עבור Media.GetCustomerMediaItem.

שדות
name

string

שם המשאב של פריט המדיה של הלקוח המבוקש.

GetFollowersMetadataRequest

בקשו לשלוח הודעה כדי לקבל את המטא-נתונים של האנשים שעוקבים אחרי המיקום שלכם.

שדות
name

string

שם המשאב של המטא-נתונים של העוקבים של המיקום. accounts/{account_id}/locations/{location_id}/followers/metadata

GetFoodMenusRequest

בקשה להצגת הודעה לגבי Foodmenus.GetFoodמופעs

שדות
name

string

חובה. מזהה Google של המיקום הזה בטופס: accounts/{account_id}/locations/{location_id}/foodMenus

read_mask

FieldMask

זה שינוי אופציונלי. השדות הספציפיים שצריך להחזיר. אם לא צוינה מסכה, אז היא מחזירה את תפריט המזון המלא (כמו '*'). לא ניתן לציין בנפרד פריטים חוזרים בשדה. לדוגמה: "שם" ו'תפריטים' הן מסכות תקינות, בעוד ש-'menus.sections' לא חוקי.

GetHealthProviderAttributesRequest

הודעת בקשה ל-HealthProviderAttributes.GetHealthProviderAttributes

שדות
name

string

חובה. מזהה Google של המיקום הזה בפורמט: accounts/{account_id}/locations/{location_id}/healthProviderAttributes

language_code

string

זה שינוי אופציונלי. את קוד BCP 47 של השפה. אם לא תספקו קוד שפה, ברירת המחדל תהיה אנגלית. כרגע רק en נתמך.

GetLocalPostRequest

הודעת בקשה ל-LocalPost.GetLocalPost.

שדות
name

string

שם הפוסט המקומי לאחזר.

GetLocationRequest

שליחת הודעה לגבי Locations.GetLocation.

שדות
name

string

שם המיקום שרוצים לאחזר.

GetMediaItemRequest

הודעת בקשה עבור Media.GetMediaItem.

שדות
name

string

השם של פריט המדיה המבוקש.

GetNotificationsRequest

הודעת בקשה עבור Accounts.GetNotifications.

שדות
name

string

שם המשאב של הגדרת ההתראות.

GetReviewRequest

הודעה לבקשת ביקורות.GetReview.

שדות
name

string

שם הביקורת שצריך לאחזר.

GetServiceListRequest

קבלת הודעה עם בקשה לרשימת שירותים.

שדות
name

string

חובה. מזהה Google של המיקום הזה בטופס: accounts/{account_id}/locations/{location_id}/servicelist

GoogleLocation

מייצג Location שנמצא ב-Google. מיקום זה יכול להיות מיקום שכבר תבע עליו בעלות, על ידי מישהו אחר או על מיקום שלא נתבעה עליו בעלות.

שדות
name

string

שם המשאב של המיקום הזה ב-GoogleLocation, בפורמט googleLocations/{googleLocationId}.

location

Location

המידע המאוכלס בדלילות: Location. אפשר לעשות שימוש חוזר בשדה הזה ב-CreateLocation, אם המשתמש לא תבע עליו בעלות כרגע.

request_admin_rights_url

string

כתובת URL שתפנה את המשתמשים לממשק המשתמש של הרשאות האדמין של הבקשה. השדה הזה מוצג רק אם משתמש כלשהו, כולל המשתמש הנוכחי, כבר תבע בעלות על המיקום.

GoogleUpdatedLocation

מייצג מיקום ששונה על ידי Google.

שדות
location

Location

הגרסה המעודכנת של המיקום הזה על ידי Google.

diff_mask

FieldMask

השדות ש-Google עדכנה.

HealthProviderAttributes

המאפיינים של ספק שירותי הבריאות שמקושרים למיקום הזה.

שדות
name

string

חובה. מזהה Google של המיקום הזה בטופס: accounts/{account_id}/locations/{location_id}/healthProviderAttributes

insurance_networks[]

InsuranceNetwork

זה שינוי אופציונלי. רשימה של חברות ביטוח שנכללות במיקום הזה.

InsuranceNetwork

רשת ביטוח אחת. המזהה הבא: 5

שדות
network_id

string

חובה. המזהה של רשת הביטוח הזו שנוצרה על ידי Google.

network_names

map<string, string>

פלט בלבד. מפה של השמות המוצגים של הרשתות בשפות מבוקשות, שבהן השפה היא המפתח והשם המוצג המותאם לשוק המקומי הוא הערך. השם המוצג באנגלית מוגדר כברירת מחדל.

payer_names

map<string, string>

פלט בלבד. מפת השמות המוצגים של המשלם בשפות מבוקשות שבהן השפה היא המפתח והשם המוצג המותאם לשוק המקומי הוא הערך. השם המוצג באנגלית מוגדר כברירת מחדל.

state

NetworkState

פלט בלבד. המצב של רשת הביטוח הזו.

InternalError

תיאור כשלים פנימיים.

שדות
error_details[]

ErrorDetail

פירוט של כשלים בודדים.

הזמנה

פלט בלבד. מייצג הזמנה בהמתנה.

שדות
name

string

שם המשאב של ההזמנה.

role

AdminRole

התפקיד שהוזמן בחשבון.

שדה איחוד target. מציין את היעד עבור ההזמנה הזו. target יכול להיות רק אחת מהאפשרויות הבאות:
target_account

Account

החשבון המאוכלס בדלילות שההזמנה הזו מיועדת אליו.

target_location

TargetLocation

מיקום היעד הגיאוגרפי להזמנה הזו.

TargetLocation

מייצג מיקום יעד להזמנה בהמתנה.

שדות
location_name

string

שם המיקום שאליו המשתמש מוזמן.

location_address

string

הכתובת של המיקום שאליו המשתמש מוזמן.

ListAccountAdminsRequest

הודעת בקשה בנושא AccessControl.ListAccountAdmins.

שדות
parent

string

שם החשבון שממנו יש לאחזר את רשימת האדמינים.

ListAccountAdminsResponse

הודעת תגובה לגבי AccessControl.ListAccountAdmins.

שדות
admins[]

Admin

אוסף של Admin מופעים.

ListAccountsRequest

הודעת בקשה לחשבונות.חשבונות.

שדות
page_size

int32

כמה חשבונות לאחזר בכל דף. ברירת המחדל היא 20, המינימום הוא 2 וגודל הדף המקסימלי הוא 20.

page_token

string

אם צוין, דף החשבונות הבא יאוחזר. הערך pageToken מוחזר כאשר קריאה אל accounts.list מחזירה תוצאות רבות יותר ממה שיכולות להתאים לגודל הדף המבוקש.

name

string

שם המשאב של החשבון שעבורו יש לאחזר את רשימת החשבונות שניתן לגשת אליהם ישירות. הכלל הזה מתאים רק לארגונים ולקבוצות משתמשים. אם השדה ריק, הפונקציה תחזיר את הערך ListAccounts עבור המשתמש המאומת.

filter

string

מסנן שמגביל את החשבונות להחזרה. התשובה כוללת רק רשומות שתואמות למסנן. אם השדה filter ריק, לא יחולו אילוצים וכל החשבונות (החלוקה לדפים) מאוחזרים לחשבון המבוקש.

לדוגמה, בקשה עם המסנן type=USER_GROUP תחזיר רק קבוצות משתמשים.

ListAccountsResponse

הודעת תשובה לגבי Accounts.ListAccounts.

שדות
accounts[]

Account

אוסף של חשבונות למשתמש יש גישה אליהם. החשבון האישי של המשתמש שמבצע את השאילתה יהיה תמיד הפריט הראשון של התוצאה, אלא אם הוא לא יסוונן.

next_page_token

string

אם מספר החשבונות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף החשבונות הבא בקריאה מאוחרת יותר ל-accounts.list. אם אין חשבונות נוספים, השדה הזה לא יופיע בתשובה.

ListAnswersRequest

בקשה להצגת הודעה בנושא שאלותAndAnswers.ListAnswers

שדות
parent

string

שם השאלה שעבורה רוצים לאחזר את התשובות.

page_size

int32

כמה תשובות לאחזר בכל דף. ערכי ברירת המחדל והמקסימום של page_size הם 10.

page_token

string

אם צוין, דף התשובות הבא יאוחזר.

order_by

string

הסדר להחזרת התשובות. האפשרויות החוקיות כוללות 'update_time desc' ו-'upvote_count desc', שיחזיר את התשובות בסדר יורד לפי השדה המבוקש. סדר המיון שמוגדר כברירת מחדל הוא 'update_time desc'.

ListAnswersResponse

הודעת תגובה ל-QuestionAndAnswers.ListAnswers

שדות
answers[]

Answer

התשובות הנדרשות.

total_size

int32

המספר הכולל של תשובות שפורסמו לשאלה הזו בכל הדפים.

next_page_token

string

אם מספר התשובות חורג מגודל הדף המקסימלי המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף התשובות הבא בקריאה הבאה. אם אין תשובות נוספות, השדה הזה לא יופיע בתשובה.

ListAttributeMetadataRequest

הודעת בקשה עבור Locations.ListAttributeMetadata. אם צוין שם של משאב מיקום, המיקום הזה ישמש לאכלוס שאר הקריטריונים. אם המאפיין לא קיים, יש לציין את הקטגוריה והמדינה.

שדות
name

string

שם המשאב של המיקום לחיפוש מאפיינים זמינים.

category_id

string

המזהה היציב של הקטגוריה הראשית, שבו אפשר למצוא את המאפיינים הזמינים.

country

string

קוד מדינה בפורמט ISO 3166-1 alpha-2 כדי למצוא מאפיינים זמינים.

language_code

string

קוד השפה של BCP 47 שצריך לקבל בו את השמות המוצגים של המאפיינים. אם השפה הזו לא זמינה, הם יסופקו באנגלית.

page_size

int32

מספר המאפיינים שצריך לכלול בכל דף. ברירת המחדל היא 200, המינימום הוא 1.

page_token

string

אם צוין, הדף הבא של המטא-נתונים של המאפיין יאוחזר. הערך pageToken מוחזר כאשר קריאה אל attributes.list מחזירה תוצאות רבות יותר ממה שיכולות להתאים לגודל הדף המבוקש.

ListAttributeMetadataResponse

הודעת תגובה ל-Locations.ListAttributeMetadata.

שדות
attributes[]

AttributeMetadata

אוסף של מטא-נתונים של מאפיינים שזמינים.

next_page_token

string

אם מספר המאפיינים חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף המאפיינים הבא בקריאה הבאה לפעולה attributes.list. אם אין עוד מאפיינים, השדה הזה לא יופיע בתשובה.

ListBusinessCategoriesRequest

שדות
region_code

string

קוד מדינה בפורמט ISO 3166-1 alpha-2.

language_code

string

קוד השפה של BCP 47. אם השפה לא זמינה, ברירת המחדל תהיה אנגלית.

search_term

string

מחרוזת סינון אופציונלית מהמשתמש.

page_size

int32

כמה קטגוריות לאחזר בכל דף. ברירת המחדל היא 100, המינימום הוא 1 וגודל הדף המקסימלי הוא 100.

page_token

string

אם צוין, הדף הבא של הקטגוריות יאוחזר.

view

CategoryView

זה שינוי אופציונלי. מציינת אילו חלקים של המשאב 'קטגוריה' יוחזרו בתשובה.

ListBusinessCategoriesResponse

שדות
categories[]

Category

הקטגוריות. הקטגוריות הן תצוגת BASIC. הם לא מכילים מידע על ServiceType.

total_category_count

int32

המספר הכולל של הקטגוריות לפרמטרים של הבקשה.

next_page_token

string

אם מספר הקטגוריות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף הקטגוריות הבא בקריאה הבאה ל-ListBusinessCategories.

ListCustomerMediaItemsRequest

הודעת בקשה עבור Media.ListCustomerMediaItems.

שדות
parent

string

שם המיקום שפריטי המדיה של הלקוח שלו יופיעו.

page_size

int32

מספר פריטי מדיה שצריך להחזיר בכל דף. ערך ברירת המחדל הוא 100. גודל הדף המקסימלי הנתמך הוא 200.

page_token

string

אם צוין, החזרת הדף הבא של פריטי מדיה.

ListCustomerMediaItemsResponse

הודעת תגובה לגבי Media.ListCustomerMediaItems.

שדות
media_items[]

MediaItem

הרשימה שהוחזרה של פריטי מדיה.

total_media_item_count

int32

המספר הכולל של פריטי מדיה במיקום הזה, ללא קשר לחלוקה לדפים. המספר הזה משוער, במיוחד כשיש כמה דפים של תוצאות.

next_page_token

string

אם יש יותר פריטי מדיה מהגודל המבוקש של הדף, השדה הזה יאוכלס באסימון כדי לאחזר את הדף הבא של פריטי מדיה בקריאה לאחר מכן ל-ListCustomerMediaItems.

ListInsuranceNetworksRequest

הודעת בקשה עבור InsuranceNetworkService.ListInsurance Networks

שדות
parent

string

חובה. שם המיקום שרשתות הביטוח שלו יופיעו ברשימה. השם מופיע בתבנית: accounts/{account_id}/locations/{location_id}

language_code

string

זה שינוי אופציונלי. את קוד BCP 47 של השפה. אם לא תספקו קוד שפה, ברירת המחדל תהיה אנגלית. כרגע רק en נתמך.

page_size

int32

מספר חברות הביטוח שצריך להחזיר בכל דף. ערך ברירת המחדל הוא 5,000. גודל הדף המקסימלי הוא 10,000.

page_token

string

אם צוין, מחזירה את הדף הבא של חברות הביטוח.

ListInsuranceNetworksResponse

הודעת תגובה לגבי InsuranceNetworkService.ListInsurance Networks

שדות
networks[]

InsuranceNetwork

רשימה של חברות ביטוח ש-Google תומכת בהן.

next_page_token

string

אם יש יותר חברות ביטוח מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את הדף הבא של חברות הביטוח בקריאה הבאה ל-ListInsurance Networks.

ListInvitationsRequest

הודעת בקשה עבור AccessControl.ListOrders.

שדות
parent

string

שם החשבון שממנו מאוחזרת רשימת ההזמנות.

target_type

TargetType

ההגדרה קובעת אילו סוגי יעדים יופיעו בתשובה.

TargetType

סוג הטירגוט שאליו שייכת הזמנה מסוימת.

טיפוסים בני מנייה (enum)
ALL הצגת רשימה של הזמנות לכל סוגי היעדים. (זוהי ברירת המחדל)
ACCOUNTS_ONLY הצגת רשימה של הזמנות רק ליעדים מסוג 'חשבון'.
LOCATIONS_ONLY הצגת רשימה של הזמנות רק לטירגוטים מסוג 'מיקום'.

ListInvitationsResponse

הודעת תגובה ל-AccessControl.List שמחs.

שדות
invitations[]

Invitation

אוסף של הזמנות למיקום שממתינות לחשבון. מספר ההזמנות שמופיע כאן לא יכול לחרוג מ-1,000.

ListLocalPostsRequest

הודעת בקשה ל-ListLocalPost

שדות
parent

string

שם המיקום שהפוסטים המקומיים שלו יהיו רשומים.

page_size

int32

מספר הפוסטים המקומיים שצריך להחזיר בכל דף. ברירת המחדל היא 20. המינימום הוא 1 וגודל הדף המקסימלי הוא 100.

page_token

string

אם צוין, החזרת הדף הבא של פוסטים מקומיים.

ListLocalPostsResponse

הודעת תגובה לגבי ListLocalPost

שדות
local_posts[]

LocalPost

הרשימה שהוחזרה של פוסטים מקומיים.

next_page_token

string

אם יש יותר פוסטים מקומיים מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את הדף הבא של פוסטים מקומיים בקריאה לאחר מכן ל-ListLocalPosts.

ListLocationAdminsRequest

הודעת בקשה עבור AccessControl.ListLocationAdmins.

שדות
parent

string

שם המיקום שצריך לרשום בחשבון את האדמינים שלו.

ListLocationAdminsResponse

הודעת תגובה עבור AccessControl.ListLocationAdmins.

שדות
admins[]

Admin

אוסף של Admin מופעים.

ListLocationsRequest

הודעת בקשה לגבי Locations.ListLocations.

שדות
parent

string

שם החשבון שממנו יש לאחזר את המיקומים. אם הערך של Account הוא AccountType אישי, מוחזרים רק מיקומים שנמצאים בבעלותו הישירה של החשבון. אחרת, הוא יחזיר את כל המיקומים שהיו נגישים מהחשבון, באופן ישיר או עקיף.

page_size

int32

כמה מיקומים צריך לאחזר בכל דף. ברירת המחדל היא 100, המינימום הוא 1 וגודל הדף המקסימלי הוא 100.

page_token

string

אם צוין, נאחזר את page המיקומים הבאים. אסימון הדף מוחזר על ידי קריאות קודמות ל-ListLocations כאשר היו יותר מיקומים ממה שהתאפשר לגודל הדף המבוקש.

filter

string

מסנן שמגביל את המיקומים להחזרה. התשובה כוללת רק רשומות שתואמות למסנן. אם השדה filter ריק, יחולו האילוצים וכל המיקומים (עם חלוקה לדפים) מאוחזרים בחשבון המבוקש.

מידע נוסף על שדות חוקיים ושימוש לדוגמה זמין במדריך לעבודה עם נתוני מיקום.

language_code
(deprecated)

string

קוד השפה של BCP 47 שבו יש להציג את מאפייני המיקום לתצוגה. אם השפה הזו לא זמינה, היא תסופק בשפת המיקום. אם אף אחת מהאפשרויות האלה לא זמינה, הן יסופקו באנגלית.

הוצא משימוש. אחרי 15 באוגוסט 2020, השדה הזה לא יהיה זמין יותר. תמיד ייעשה שימוש בשפה של המיקום.

order_by

string

סדר המיון של הבקשה. אם יש מספר שדות, צריך להפריד ביניהם באמצעות פסיקים, בהתאם לתחביר של SQL. ברירת המחדל של סדר המיון היא בסדר עולה. כדי לציין סדר יורד, צריך להוסיף סיומת " סדר יורד" יש להוסיף. השדות החוקיים למיון לפי order_by הם location_name ו-store_code. לדוגמה: 'location_name, store_code desc' או 'location_name' או 'store_code desc'

ListLocationsResponse

הודעת תגובה לגבי Locations.ListLocations.

שדות
locations[]

Location

המיקומים.

next_page_token

string

אם מספר המיקומים חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף המיקומים הבא בקריאה הבאה ל-ListLocations. אם אין מיקומים נוספים, השדה הזה לא יופיע בתשובה.

total_size

int32

המספר המשוער של המיקומים ברשימה, ללא קשר לחלוקה לדפים.

ListMediaItemsRequest

הודעת בקשה עבור Media.ListMediaItems.

שדות
parent

string

שם המיקום שפריטי המדיה שלו יופיעו.

page_size

int32

מספר פריטי מדיה שצריך להחזיר בכל דף. ערך ברירת המחדל הוא 100, שהוא גם המספר הנתמך המקסימלי של פריטי מדיה שאפשר להוסיף למיקום באמצעות Google My Business API. גודל הדף המקסימלי הוא 2,500.

page_token

string

אם צוין, החזרת הדף הבא של פריטי מדיה.

ListMediaItemsResponse

הודעת תגובה לגבי Media.ListMediaItems.

שדות
media_items[]

MediaItem

הרשימה שהוחזרה של פריטי מדיה.

total_media_item_count

int32

המספר הכולל של פריטי מדיה במיקום הזה, ללא קשר לחלוקה לדפים.

next_page_token

string

אם יש יותר פריטי מדיה מהגודל המבוקש של הדף, השדה הזה יאוכלס באסימון כדי לאחזר את הדף הבא של פריטי מדיה בקריאה הבאה ל-ListMediaItems.

ListQuestionsRequest

הודעת בקשה לגבי שאלותAndAnswers.ListQuestions

שדות
parent

string

שם המיקום שלגביו רוצים לאחזר את השאלות.

page_size

int32

כמה שאלות לאחזר בכל דף. ערכי ברירת המחדל והמקסימום של page_size הם 10.

page_token

string

אם צוין, דף השאלות הבא יאוחזר.

answers_per_question

int32

כמה תשובות לאחזר לכל שאלה. ערכי ברירת המחדל והמקסימום של answers_per_question הם 10.

filter

string

מסנן שמגביל את השאלות להחזרה. המסנן היחיד שנתמך כרגע הוא 'ignore_answered=true'

order_by

string

הסדר להחזרת השאלות. האפשרויות החוקיות כוללות 'update_time desc' ו-'upvote_count desc', יחזיר את השאלות במיון יורד לפי השדה המבוקש. סדר המיון שמוגדר כברירת מחדל הוא 'update_time desc'.

ListQuestionsResponse

הודעת תגובה ל-QuestionAndAnswers.ListQuestions

שדות
questions[]

Question

השאלות שהתבקשו,

total_size

int32

המספר הכולל של שאלות שפורסמו לגבי המיקום הזה בכל הדפים.

next_page_token

string

אם מספר השאלות חורג מגודל הדף המקסימלי המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף השאלות הבא בקריאה הבאה. אם אין שאלות נוספות, השדה הזה לא יופיע בתשובה.

ListRecommendedGoogleLocationsRequest

בקשה להצגת הודעה עם רשימה של מיקומים מומלצים לחשבון ב'פרופיל העסק ב-Google'.

שדות
name

string

השם של משאב החשבון שאליו יש לאחזר את המיקומים המומלצים של Google.

page_size

int32

כמה מיקומים צריך לאחזר בכל דף. ברירת המחדל היא 25, המינימום הוא 1 וגודל הדף המקסימלי הוא 100.

page_token

string

אם צוין, דף המיקומים הבא יאוחזר.

ListRecommendedGoogleLocationsResponse

הודעת תגובה לגבי GoogleLocations.ListRecommendedGoogleLocations.

הוא מכיל גם מיקומים מסוימים שמשתמשים אחרים ב'פרופיל העסק ב-Google' תבעו עליהם בעלות מאז הפעם האחרונה שבה הומלץ להם בחשבון 'פרופיל העסק ב-Google'.

שדות
google_locations[]

GoogleLocation

המיקומים המומלצים לחשבון ב'פרופיל העסק ב-Google'. כל אחת מהאפשרויות האלה מייצגת GoogleLocation שנמצא במפות Google. המיקומים ממוינים בסדר יורד לפי רלוונטיות לחשבון 'פרופיל העסק ב-Google'.

total_size

int32

המספר הכולל של מיקומים מומלצים לחשבון ב'פרופיל העסק ב-Google', ללא קשר לחלוקה לדפים.

next_page_token

string

במהלך החלוקה לדפים, אם יש מיקומים נוספים זמינים לאחזור בדף הבא, השדה הזה יאוכלס באסימון כדי לאחזר את דף המיקומים הבא בקריאה הבאה. אם אין עוד מיקומים לאחזור, השדה הזה לא יופיע בתשובה.

ListReviewsRequest

הודעת בקשה ל-Reviews.ListReviews.

שדות
parent

string

שם המיקום שלגביו רוצים לאחזר ביקורות.

page_size

int32

כמה ביקורות לאחזר בכל דף. המספר המקסימלי של page_size הוא 50.

page_token

string

אם צוין, הוא יאחזר את דף הביקורות הבא.

order_by

string

מציינת את השדה שלפיו צריך למיין את הביקורות. אם לא צויין ערך, סדר הצגת הביקורות שהוחזרו יהיה update_time desc כברירת מחדל. הזמנות תקפות למיון לפי הן rating, rating desc ו-update_time desc.

ListReviewsResponse

הודעת תגובה ל-Reviews.ListReviews.

שדות
reviews[]

Review

הביקורות.

average_rating

double

דירוג הכוכבים הממוצע של כל הביקורות על המיקום הזה בסולם של 1 עד 5. 5 הוא הדירוג הגבוה ביותר.

total_review_count

int32

המספר הכולל של ביקורות על המיקום הזה.

next_page_token

string

אם מספר הביקורות חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף הביקורות הבא בקריאה הבאה ל-ListReviews. אם אין יותר ביקורות, השדה הזה לא יופיע בתשובה.

ListVerificationsRequest

הודעת בקשה לאימות (attestations.List authentications).

שדות
parent

string

שם המשאב של המיקום שאליו שייכות בקשות האימות.

page_size

int32

כמה ערכי אימות צריך לכלול בכל דף. אם היא לא מוגדרת, מחזירים את הכול.

page_token

string

אם צוין, הפונקציה מחזירה את דף האימות הבא.

ListVerificationsResponse

הודעת תגובה ל-Verifys.List Verifications.

שדות
verifications[]

Verification

רשימת האימותים.

next_page_token

string

אם מספר האימותים חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון כדי לאחזר את דף האימות הבא בקריאה הבאה. אם אין עוד מאפיינים, השדה הזה לא יופיע בתשובה.

LocalPost

מייצג פוסט מקומי עבור מיקום.

שדות
name

string

פלט בלבד. מזהה Google של הפוסט המקומי הזה בטופס: accounts/{account_id}/locations/{location_id}/localPosts/{local_post_id}

language_code

string

השפה של הפוסט המקומי.

summary

string

התיאור/גוף הפוסט המקומי.

call_to_action

CallToAction

כתובת ה-URL שאליה המשתמשים נשלחים כשהם לוחצים על נכס קידום המכירות. המערכת התעלמה מסוג הנושא OFFER.

create_time

Timestamp

פלט בלבד. מועד יצירת הפוסט.

update_time

Timestamp

פלט בלבד. מועד השינוי האחרון של הפוסט שהמשתמש ביצע.

event

LocalPostEvent

פרטי האירוע. חובה לסוגי הנושאים EVENT ו-OFFER.

state

LocalPostState

פלט בלבד. המצב של הפוסט, שמציין באיזה חלק של מחזור החיים שלו הוא נמצא.

media[]

MediaItem

המדיה שמשויכת לפוסט. source_url הוא שדה הנתונים היחיד שנתמך עבור LocalPost MediaItem.

search_url

string

פלט בלבד. הקישור לפוסט המקומי בחיפוש Google. אפשר להשתמש בקישור הזה כדי לשתף את הפוסט ברשתות החברתיות, באימייל, בהודעת טקסט וכו'.

topic_type

LocalPostTopicType

חובה. סוג הנושא של הפוסט: רגיל, אירוע, מבצע או התראה.

alert_type

AlertType

סוג ההתראה שבשבילה הפוסט נוצר. השדה הזה חל רק על פוסטים של topic_type Alert, והוא פועל כתת-סוג של התראות.

offer

LocalPostOffer

נתונים נוספים לפוסטים על מבצעים. יש להגדיר זאת רק כאשר topic_type הוא OFFER.

LocalPostState

מציין באיזה מצב נמצא הפוסט

טיפוסים בני מנייה (enum)
LOCAL_POST_STATE_UNSPECIFIED המצב לא צוין.
REJECTED הפוסט הזה נדחה בגלל הפרה של מדיניות התוכן.
LIVE הפוסט הזה פורסם ומופיע כרגע בתוצאות חיפוש.
PROCESSING הפוסט הזה מעובד והוא לא מופיע בתוצאות החיפוש.

LocalPostEvent

כל המידע שקשור לאירוע שמוצג בפוסט מקומי.

שדות
title

string

שם האירוע.

schedule

TimeInterval

תאריכי ההתחלה והסיום של האירועים.

LocalPostMetrics

כל המדדים המבוקשים לגבי פוסט מקומי.

שדות
local_post_name

string

metric_values[]

MetricValue

רשימת ערכים עבור המדדים המבוקשים.

LocalPostOffer

שדות ספציפיים לפוסטים של מבצעים.

שדות
coupon_code

string

זה שינוי אופציונלי. קוד מבצע שאפשר להשתמש בו בחנות או באינטרנט.

redeem_online_url

string

זה שינוי אופציונלי. קישור למימוש המבצע.

terms_conditions

string

זה שינוי אופציונלי. התנאים וההגבלות של המבצע.

LocalPostTopicType

סוג הנושא של הפוסט המקומי, המשמש לבחירת תבניות שונות ליצירה ולעיבוד של פוסט.

טיפוסים בני מנייה (enum)
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED לא צוין סוג פוסט.
STANDARD הפוסט מכיל מידע בסיסי, כמו סיכום ותמונות.
EVENT הפוסט מכיל מידע בסיסי ואירוע.
OFFER הפוסט מכיל מידע בסיסי, אירוע ותוכן שקשור למבצע (למשל, קוד שובר)
ALERT הודעות בעדיפות גבוהה והודעות מתוזמנות שקשורות לאירוע מתמשך. לא תמיד אפשר ליצור פוסטים מהסוגים האלה.

מיקום

מיקום. תיאור מפורט של השדות האלה זמין במאמר הזה במרכז העזרה. כדי לקבל רשימה של קטגוריות עסקיות תקינות, אפשר לעיין בנקודת הקצה של הקטגוריה.

שדות
name

string

מזהה Google של המיקום הזה בטופס: accounts/{account_id}/locations/{location_id}

בהקשר של התאמות, השדה הזה לא יאוכלס.

language_code

string

השפה של המיקום. מוגדר במהלך היצירה ולא ניתן לעדכון.

store_code

string

מזהה חיצוני של המיקום הזה, והוא חייב להיות ייחודי בחשבון נתון. זהו אמצעי לשייך את המיקום לרשומות שלכם.

location_name

string

שם המיקום צריך לשקף את השם של העסק בעולם האמיתי, כפי שהוא מוצג באופן עקבי בחזית החנות, באתר ובנייר המכתבים של העסק, וכפי שהוא מוכר ללקוחות. מידע נוסף, במקרים הרלוונטיים, ייכלל בשדות אחרים של המשאב (לדוגמה, Address, Categories). אל תוסיף מידע מיותר לשם שלך (לדוגמה, עדיף להשתמש במילה "Google" על פני "Google Inc. - Mountain View Corporate Headquarters"). אין לכלול תיאורים שיווקיים, קודי חנויות, תווים מיוחדים, שעות פעילות או סטטוס פתיחה/סגירה, מספרי טלפון, כתובות של אתרים, פרטי שירות/מוצר, מיקום/כתובת או מסלול הגעה, או מידע על מקום מארח (לדוגמה: "Chase ATM in Duane Reade").

primary_phone

string

מספר טלפון שמקושר למיקום של העסק הספציפי בצורה ישירה ככל האפשר. כשהדבר אפשרי, השתמשו במספר טלפון בעסק, במקום במספר של מוקד טלפוני.

additional_phones[]

string

עד שני מספרי טלפון (ניידים או קוויים, ללא פקס) שבאמצעותם ניתן להתקשר לעסק, בנוסף למספר הטלפון הראשי.

address

PostalAddress

כתובת מדויקת ומדויקת לתיאור מיקום העסק. אין לציין תאי דואר או תאי דואר במיקומים מרוחקים. בשלב זה ניתן לציין עד חמישה ערכים של address_lines בכתובת.

primary_category

Category

הקטגוריה שמתארת בצורה הטובה ביותר את העסק העיקרי שבו המיקום הזה עוסק.

additional_categories[]

Category

קטגוריות נוספות לתיאור העסק. קטגוריות עוזרות ללקוחות למצוא תוצאות מדויקות וספציפיות לשירותים שמעניינים אותם. כדי לשמור על דיוק ועדכניות פרטי העסק, חשוב להקפיד להשתמש בכמה שפחות קטגוריות כדי לתאר את הפעילות העיקרית של העסק. בחרו קטגוריות ספציפיות ככל האפשר, אך מייצגות את העסק העיקרי שלכם.

website_url

string

כתובת URL של העסק הזה. אם אפשר, כדאי להשתמש בכתובת URL שמייצגת את המיקום הספציפי של העסק, במקום בכתובת URL כללית או בכתובת URL כללית שמייצגת את כל המיקומים או את המותג.

regular_hours

BusinessHours

שעות הפעילות של העסק.

special_hours

SpecialHours

שעות פתיחה מיוחדות לעסק. שעות הפתיחה בחגים כוללות בדרך כלל שעות פתיחה בחגים ושעות אחרות מחוץ לשעות הפעילות הרגילות. השעות האלה מבטלות את שעות הפעילות הרגילות.

service_area

ServiceAreaBusiness

נותני שירות באזור מוגדר (SAB) מספקים את השירות במיקום של הלקוח. אם העסק הזה נותן שירות באזור מוגדר(SAB), בשדה הזה מתוארים האזורים שבהם העסק נותן שירות.

location_key

LocationKey

אוסף של מפתחות שמקשרים את העסק הזה לנכסי Google אחרים, כגון דף Google+ ומקומות במפות Google.

labels[]

string

אוסף של מחרוזות חופשיות שמאפשרות לתייג את העסק. התוויות האלה לא מוצגות למשתמשים. רק אתה יכול לראות אותם. מוגבלת ל-255 תווים (לכל תווית).

ad_words_location_extensions

AdWordsLocationExtensions

מידע נוסף שמוצג ב-AdWords.

latlng

LatLng

קו רוחב וקו אורך שסופקו על ידי המשתמש. כשיוצרים מיקום, המערכת מתעלמת מהשדה הזה אם הכתובת שסופקה קואורדינטות (geocoding) בהצלחה. השדה הזה מוחזר רק בבקשות לקבלת נתונים אם הערך של latlng שסופק על ידי המשתמש התקבל במהלך היצירה, או אם הערך של latlng עודכן דרך האתר של פרופיל העסק ב-Google. לא ניתן לעדכן את השדה הזה.

open_info

OpenInfo

דגל שמציין אם המיקום פתוח עכשיו ופעיל.

location_state

LocationState

פלט בלבד. קבוצה של ערכים בוליאניים שמשקפת את המצב של מיקום.

attributes[]

Attribute

מאפיינים עבור המיקום הזה.

metadata

Metadata

פלט בלבד. מידע נוסף שהמשתמשים לא יכולים לערוך.

price_lists[]
(deprecated)

PriceList

הוצא משימוש: פרטי מחירון למיקום הזה.

profile

Profile

מתאר את העסק בקול שלך ומשתף עם המשתמשים את הסיפור הייחודי של העסק והמבצעים שלך.

relationship_data

RelationshipData

כל המיקומים והרשתות שקשורים למיקום הזה.

more_hours[]

MoreHours

שעות פעילות נוספות עבור מחלקות שונות או לקוחות ספציפיים של העסק.

מטא-נתונים

מידע נוסף על המיקום שהמשתמשים לא יכולים לערוך.

שדות
duplicate
(deprecated)

Duplicate

מידע על המיקום שבו המיקום הזה משוכפל. מוצג רק אם הערך של location_state.is_duplicate הוא True. הוצא משימוש: אנחנו כבר לא תומכים במידע מפורט על כפילויות.

maps_url

string

קישור למיקום במפות Google.

new_review_url

string

קישור לדף בחיפוש Google שבו לקוח יכול לכתוב ביקורת על המיקום.

שכפול

מידע על המיקום שבו המיקום הזה משוכפל.

שדות
location_name

string

שם המשאב של המיקום שנעשה בו שכפול. השדה הזה מאוכלס רק אם למשתמש המאומת יש הרשאות גישה למיקום הזה והמיקום הזה לא נמחק.

place_id

string

מזהה המקום של המיקום הרלוונטי.

access

Access

מציין אם למשתמש יש גישה למיקום שהוא שכפול.

גישה

רמת הגישה של המשתמש למיקום שצוין בשכפול. השדה הזה מחליף את הבעלות, וצריך להשתמש בו במקום זאת.

טיפוסים בני מנייה (enum)
ACCESS_UNSPECIFIED לא צוין.
ACCESS_UNKNOWN לא ניתן לקבוע אם למשתמש יש גישה למיקום שהוא שכפול.
ALLOWED למשתמש יש גישה למיקום שהוא לשכפל.
INSUFFICIENT למשתמש אין גישה למיקום שהוא לשכפל.

RelationshipData

מידע על כל המיקומים של ההורה והצאצא שקשורים למיקום הזה.

שדות
parent_chain

string

שם המשאב בשרשרת שאליה משויך המיקום הזה. How to find Chain ID

LocationDrivingDirectionMetrics

מיקום שנוסף לאינדקס עם האזורים שמהם אנשים בדרך כלל מגיעים. הנתון הזה מתועד על ידי ספירת מספר הבקשות לקבלת מסלול נסיעה למיקום הזה שהתקבלו מכל אזור.

שדות
location_name

string

השם של משאב המיקום שאליו שייך הערך של המדד.

top_direction_sources[]

TopDirectionSources

בקשות לקבלת מסלול נסיעה לפי אזור המקור. לפי המוסכמה, הם ממוינים לפי ספירה עם 10 תוצאות לכל היותר.

time_zone

string

אזור הזמן (מזהי אזור זמן של IANA, לדוגמה, 'אירופה/לונדון') של המיקום.

TopDirectionSources

האזורים המובילים שמהם הגיעו בקשות לקבלת מסלול נסיעה.

שדות
day_count

int32

הנתונים במשך מספר הימים נצברים.

region_counts[]

RegionCount

האזורים ממוינים בסדר יורד לפי ספירה.

RegionCount

אזור עם מספר הבקשות שמשויכות אליו.

שדות
latlng

LatLng

מרכז האזור.

label

string

תווית האזורית שניתנת לקריאה על ידי אנשים.

count

int64

מספר הבקשות לקבלת מסלול נסיעה מהאזור הזה.

LocationKey

החלפה או החלפת הפניות של מפתח מיקום.

שדות
plus_page_id

string

פלט בלבד. אם למיקום הזה משויך דף Google+, הערך הזה יאוכלס במזהה דף Google+ של המיקום הזה.

place_id

string

אם המיקום הזה אומת והוא מחובר אל מפות Google או מופיע במפות Google, השדה הזה יאוכלס במזהה המקום של המיקום. אפשר להשתמש במזהה הזה במגוון ממשקי API של מקומות.

אם המיקום הזה לא מאומת, יכול להיות שהשדה הזה יאוכלס אם המיקום שויך למקום שמופיע במפות Google.

אפשר להגדיר את השדה הזה במהלך 'יצירת שיחה', אבל לא בשדה 'עדכון'.

הבוליאני הנוסף explicit_no_place_id קובע אם מזהה מקום לא מוגדר הוא מכוון או לא.

explicit_no_place_id

bool

פלט בלבד. הערך True מציין שמזהה מקום לא מוגדר הוא מכוון, והוא שונה מזה שעדיין לא בוצע שיוך.

request_id

string

פלט בלבד. המיקום הזה נוצר על ידי request_id. השדה הזה יכול להיות ריק אם המיקום הזה נוצר מחוץ ל-Google My Business API או למיקומים של 'פרופיל העסק ב-Google'.

LocationMetrics

סדרת מדדים ו-BrakdownMetrics שמשויכים למיקום לאורך טווח זמן מסוים.

שדות
location_name

string

השם של משאב המיקום שאליו שייכים הערכים.

time_zone

string

אזור הזמן IANA של המיקום.

metric_values[]

MetricValue

רשימת ערכים עבור המדדים המבוקשים.

LocationReview

מייצג ביקורת עם פרטי מיקום.

שדות
name

string

השם של משאב המיקום.

review

Review

ביקורת על המיקום.

LocationState

מכיל קבוצה של בוליאניים שמשקפים את מצב המיקום.

שדות
is_google_updated

bool

פלט בלבד. מציין אם יש עדכונים למזהה המקום שמשויך למיקום הזה.

is_duplicate

bool

פלט בלבד. מציין אם המיקום הוא כפילות של מיקום אחר.

is_suspended

bool

פלט בלבד. מציינת אם המיקום מושעה. המיקומים המושעים לא גלויים למשתמשי קצה במוצרי Google. אם לדעתך מדובר בטעות, אפשר לעיין במאמר במרכז העזרה.

can_update

bool

פלט בלבד. מציינת אם ניתן לעדכן את המיקום.

can_delete

bool

פלט בלבד. בעמודה הזו מציינים אם ניתן למחוק את המיקום באמצעות Google My Business API.

is_verified

bool

פלט בלבד. מציין אם המיקום מאומת.

needs_reverification

bool

פלט בלבד. מציין אם המיקום דורש אימות חוזר.

is_pending_review

bool

פלט בלבד. מציין אם הבדיקה של המיקום בהמתנה.

is_disabled

bool

פלט בלבד. מציין אם המיקום מושבת.

is_published

bool

פלט בלבד. מציין אם המיקום פורסם.

is_disconnected

bool

פלט בלבד. מציין אם המיקום מנותק ממקום במפות Google.

is_local_post_api_disabled

bool

פלט בלבד. מציינת אם המיקום accounts.locations.localPosts מושבת במיקום הזה.

can_modify_service_list

bool

פלט בלבד. שדה זה מציין אם הדף העסקי יכול לשנות רשימת ServiceList.

can_have_food_menus

bool

פלט בלבד. מציינת אם כרטיס המוצר עומד בדרישות להצגת תפריט אוכל.

has_pending_edits

bool

פלט בלבד. מציין אם מאפיינים כלשהם של המיקום נמצאים במצב המתנה לעריכה.

has_pending_verification

bool

פלט בלבד. מציין אם למיקום יש בקשות אימות בהמתנה.

can_operate_health_data

bool

פלט בלבד. מציינת אם המיקום יכול לפעול על נתוני בריאות.

can_operate_lodging_data

bool

פלט בלבד. מציינת אם המיקום יכול לפעול על נתונים של לינה.

MatchedLocation

מייצג התאמה אפשרית למיקום.

שדות
location

Location

המיקום המאוכלס בדלילות שאפשר להתאים לו. שדות שלא מאוכלסים כוללים, בין היתר: שם (לא ניתן לאחזר את המיקום התואם דרך GetLocation או BatchGetLocations); store_code; פרטים על אזור הכיסוי של service_area; labels; ad_words_location_extensions; photos

is_exact_match

bool

האם זו התאמה מדויקת?

MediaItem

פריט מדיה יחיד.

שדות
name

string

שם המשאב של פריט המדיה הזה. accounts/{account_id}/locations/{location_id}/media/{media_key}

media_format

MediaFormat

הפורמט של פריט המדיה הזה. יש להגדיר אותו בזמן יצירת פריט המדיה, והוא זמין לקריאה בלבד בכל הבקשות האחרות. לא ניתן לעדכן.

location_association

LocationAssociation

נדרש בעת התקשרות אל CreatePhoto. תיאור האופן שבו פריט המדיה הזה מקושר למיקום שלו. הערך צריך להיות קטגוריה (לדוגמה, EXTERIOR) או מזהה של פריט מחירון.

הפעולה הזו נדרשת כשמוסיפים מדיה חדשה למיקום באמצעות CreateMediaItem. סוגי מדיה אחרים, כמו תמונות בפוסטים מקומיים, לא יהיו זמינים.

google_url

string

פלט בלבד. כתובת URL של פריט המדיה הזה שמתארחת ב-Google. כתובת ה-URL הזו לא סטטית, מכיוון שהיא עשויה להשתנות עם הזמן. בסרטון, זוהי תמונת תצוגה מקדימה עם סמל הפעלה בשכבת-על.

thumbnail_url

string

פלט בלבד. אם צוינה כתובת ה-URL של תמונה ממוזערת לפריט המדיה הזה,

create_time

Timestamp

פלט בלבד. מועד היצירה של פריט המדיה הזה.

dimensions

Dimensions

פלט בלבד. המימדים (רוחב וגובה) בפיקסלים.

insights

MediaInsights

פלט בלבד. נתונים סטטיסטיים עבור פריט המדיה הזה.

attribution

Attribution

פלט בלבד. נתוני שיוך (Attribution) של פריטי מדיה של לקוחות. עליכם להציג את השיוך הזה כפי שהוא מוצג למשתמשים, ואסור למחוק או לשנות אותו.

description

string

התיאור של פריט המדיה הזה. אי אפשר לשנות תיאורים באמצעות Google My Business API, אבל אפשר להגדיר אותם כשיוצרים פריט מדיה חדש שאינו תמונת שער.

שדה איחוד data. מקור הנתונים של פריט המדיה. כשיוצרים פריט מדיה חדש, יש לספק כתובת URL או קובץ עזר של נתונים.

למעט הקטגוריה PROFILE ו-COVER, כל התמונות צריכות להיות בגודל של לפחות 250 פיקסלים בקצה הקצר, וגודל הקובץ חייב להיות לפחות 10,240 בייטים.

כל התמונות שמעלים צריכות לעמוד בדרישות ההנחיות לגבי תמונות בפרופיל העסק. data יכול להיות רק אחת מהאפשרויות הבאות:

source_url

string

כתובת URL נגישה לכולם שממנה ניתן לאחזר את פריט המדיה.

כשיוצרים את אחד המקטעים האלה או את הפרמטר data_ref, יש להגדיר את הפרמטר data_ref כדי לציין את המקור של פריט המדיה.

אם נעשה שימוש ב-source_url כשיצרתם פריט מדיה, הוא יאוכלס בכתובת ה-URL של המקור הזה כשהפריט יאוחזר.

לא ניתן לעדכן את השדה הזה.

data_ref

MediaItemDataRef

קלט בלבד. הפניה לנתונים בינאריים של פריט מדיה כפי שהתקבלו באמצעות השיטה StartUploadMediaItemData.

כשיוצרים פריט מדיה,

sourceUrl

או

dataRef

חייב להגדיר.

שיוך (Attribution)

פרטי השיוך (Attribution) של פריטי מדיה של לקוחות, כמו השם ותמונת הפרופיל של השותף ביצירת התוכן.

שדות
profile_name

string

שם המשתמש שאליו רוצים לשייך את פריט המדיה.

profile_photo_url

string

כתובת ה-URL של התמונה הממוזערת של תמונת הפרופיל של המשתמש המשויך.

takedown_url

string

כתובת ה-URL של דף ההסרה, שבו אפשר לדווח על פריט המדיה אם הוא בלתי הולם.

profile_url

string

כתובת ה-URL של דף הפרופיל של המשתמש המשויך במפות Google.

מידות

המידות של פריט המדיה.

שדות
width_pixels

int32

הרוחב של פריט המדיה, בפיקסלים.

height_pixels

int32

הגובה של פריט המדיה, בפיקסלים.

LocationAssociation

איך פריט המדיה משויך למיקום שלו.

שדות
שדה איחוד location_attachment_type. המדיה של המיקום צריכה לכלול קטגוריה או מזהה של פריט מחירון שאליו היא משויכת. מדיה שלא מבוססת על מיקום (למשל, תמונות בפוסט מקומי) לא יכולה לכלול אף תמונה. location_attachment_type יכול להיות רק אחת מהאפשרויות הבאות:
category

Category

הקטגוריה שאליה שייכת תמונת המיקום הזו.

price_list_item_id

string

המזהה של פריט מחירון שאליו משויכת תמונת המיקום הזו.

קטגוריה

דוגמאות לקטגוריית פריט מדיה.

טיפוסים בני מנייה (enum)
CATEGORY_UNSPECIFIED הקטגוריה לא צוינה.
COVER תמונת השער. למיקום יש רק תמונת שער אחת.
PROFILE תמונת פרופיל. למיקום יש רק תמונת פרופיל אחת.
EXTERIOR מדיה חיצונית.
INTERIOR מדיה פנימית.
PRODUCT מדיה של המוצר.
AT_WORK 'בעבודה' מדיה.
FOOD_AND_DRINK מדיה בנושא מזון ומשקאות.
MENU מדיה בתפריט.
COMMON_AREA מדיה באזור ציבורי.
ROOMS מדיה של חדרים.
TEAMS מדיה בצוותים.
ADDITIONAL מדיה נוספת, ללא שיוך לקטגוריה.

MediaFormat

טיפוסים בני מנייה (enum) לפורמט מדיה.

טיפוסים בני מנייה (enum)
MEDIA_FORMAT_UNSPECIFIED הפורמט לא צוין.
PHOTO פריט המדיה הוא תמונה. בגרסה הזו יש תמיכה רק בתמונות.
VIDEO פריט המדיה הוא סרטון.

MediaInsights

תובנות ונתונים סטטיסטיים לגבי פריט המדיה.

שדות
view_count

int64

פלט בלבד. מספר הצפיות בפריט המדיה.

MediaItemDataRef

הפניה לנתונים הבינאריים של תמונות של MediaItem שהועלו באמצעות Google My Business API.

יוצרים קובץ עזר של נתונים באמצעות StartUploadMediaItemData, ומשתמשים בהפניה הזו כשמעלים בייטים ל-[UpdateMedia] ואז שולחים קריאה ל-CreateMediaItem.

שדות
resource_name

string

המזהה הייחודי של הנתונים הבינאריים של פריט המדיה הזה. הנתונים משמשים להעלאה של נתוני התמונות באמצעות [UpdateMedia] וליצירת פריט מדיה חדש מהבייטים האלה באמצעות CreateMediaItem.

דוגמה להעלאה של בייטים: curl -X POST -T{path_to_file} "http://mybusiness.googleapis.com/upload/v1/media/{resource_name}?upload_type=media"

לשיחות CreateMediaItem, צריך להגדיר את האפשרות הזו כ-data_ref MediaItem.

תווית שתשמש להצגת התפריט ורכיבי המשנה השונים שלו.

שדות
display_name

string

חובה. השם המוצג של הרכיב.

description

string

זה שינוי אופציונלי. מידע משלים על הרכיב.

language_code

string

זה שינוי אופציונלי. קוד השפה של BCP 47. אם השפה לא זמינה, ברירת המחדל תהיה אנגלית.

מדד

מדד של נתונים לגבי משאב.

טיפוסים בני מנייה (enum)
METRIC_UNSPECIFIED לא צוין מדד.
ALL קיצור דרך לבקשת כל המדדים הזמינים. אילו מדדים נכללים ב'כל המדדים' משתנים ותלויים במקור המידע שלגביו מבקשים תובנות.
QUERIES_DIRECT מספר הפעמים שהמשאב הוצג בחיפוש ישיר של המיקום.
QUERIES_INDIRECT מספר הפעמים שהמשאב הוצג כתוצאה מחיפוש לפי קטגוריות (למשל, מסעדה).
QUERIES_CHAIN מספר הפעמים שמשאב הוצג כתוצאה מחיפוש של הרשת שאליה הוא שייך או של מותג שהוא מוכר. לדוגמה, Starbucks, Adidas. זוהי קבוצת משנה של QUERIES_NVDA.
VIEWS_MAPS מספר הפעמים שבהן המשאב נצפה במפות Google.
ACTIONS_WEBSITE מספר הקליקים על אתר.
ACTIONS_PHONE מספר הפעמים שבוצעו קליקים על מספר הטלפון.
ACTIONS_DRIVING_DIRECTIONS מספר הפעמים שנשלחו בקשות למסלול נסיעה.
PHOTOS_VIEWS_MERCHANT מספר הצפיות בפריטי מדיה שהמוכר העלה.
PHOTOS_VIEWS_CUSTOMERS מספר הצפיות בפריטי מדיה שלקוחות העלו.
PHOTOS_COUNT_MERCHANT המספר הכולל של פריטי מדיה פעילים כרגע שהועלו על ידי המוכר.
PHOTOS_COUNT_CUSTOMERS המספר הכולל של פריטי מדיה שנמצאים כרגע במצב פעיל שהועלו על ידי לקוחות.
LOCAL_POST_VIEWS_SEARCH מספר הצפיות בפוסט המקומי בחיפוש Google.
LOCAL_POST_ACTIONS_CALL_TO_ACTION מספר הפעמים שמשתמשים לחצו על לחצן הקריאה לפעולה ב-Google.

MetricOption

אפשרות לציין איך הנתונים יוצגו בתשובה.

טיפוסים בני מנייה (enum)
METRIC_OPTION_UNSPECIFIED לא צוינה אפשרות של מדד. כברירת מחדל, הבקשה תהיה AGGREGATED_TOTAL.
AGGREGATED_TOTAL הערכים המוחזרים יצטברו במהלך כל מסגרת הזמן. זהו ערך ברירת המחדל.
AGGREGATED_DAILY הפונקציה מחזירה ערכים יומיים עם חותמות זמן בטווח הזמן.
BREAKDOWN_DAY_OF_WEEK הערכים יוחזרו כפירוט לפי יום בשבוע. בתוקף רק עבור ACTIONS_PHONE.
BREAKDOWN_HOUR_OF_DAY הערכים יוחזרו כפירוט לפי השעה ביום. בתוקף רק עבור ACTIONS_PHONE.

MetricRequest

בקשה להחזרת ערכים למדד אחד והאפשרויות לאופן החזרת הערכים האלה.

שדות
metric

Metric

המדד המבוקש.

options[]

MetricOption

איך הערכים יופיעו כשהם מוחזרים.

MetricValue

ערך של מדד יחיד ממועד ההתחלה.

שדות
metric

Metric

המדד שעליו חל הערך.

total_value

DimensionalMetricValue

הערך המצטבר הכולל של המדד הזה. מוגדר לאפשרות AGGREGATED_TOTAL.

dimensional_values[]

DimensionalMetricValue

ערכים מימדים של המדד הזה.

MoreHours

התקופות שבמהלכן המיקום פתוח לסוגים מסוימים של עסקים.

שדות
hours_type_id

string

חובה. סוג השעות. על הלקוחות להתקשר אל {#link business categories:BatchGet} כדי לקבל את סוגי השעות הנתמכות בקטגוריות של המיקומים שלהם.

periods[]

TimePeriod

חובה. אוסף של השעות שבהן המיקום הזה פתוח. כל תקופה מייצגת טווח של שעות שבהן המיקום פתוח במהלך השבוע.

MoreHoursType

עוד סוגים של שעות פעילות שהעסק יכול להציע, בנוסף לשעות הפעילות הרגילות.

שדות
hours_type_id

string

פלט בלבד. מזהה קבוע ש-Google סיפקה לשעות מהסוג הזה.

display_name

string

פלט בלבד. השם המוצג באנגלית של סוג השעות, קריא לאנשים.

localized_display_name

string

פלט בלבד. השם המוצג של סוג השעות, קריא לאנשים שמותאם לשוק המקומי.

NetworkState

המצב של רשת ביטוח לגבי המיקום הזה.

טיפוסים בני מנייה (enum)
NETWORK_STATE_UNSPECIFIED ערך ברירת המחדל.
ACCEPTED הרשת הזו מתקבלת במיקום הזה.
PENDING_ADD יש בקשה בהמתנה להוספת הרשת הזו לרשימת הרשתות שאושרו.
PENDING_DELETE יש בקשה בהמתנה להסרת הרשת הזו מרשימת הרשתות שאושרו.
NOT_ACCEPTED הרשת הזו לא נתמכת במיקום הזה.

NotificationType

סוג ההתראה שנשלחה לנושא Cloud Pub/Sub.

טיפוסים בני מנייה (enum)
NOTIFICATION_TYPE_UNSPECIFIED אין סוג התראה. לא יימצאו התאמות לאף התראה.
GOOGLE_UPDATE למיקום יש עדכונים של Google לבדיקה. השדה location_name בהתראה יציג את שם המשאב של המיקום יחד עם העדכונים של Google.
NEW_REVIEW ביקורת חדשה נוספה למיקום. בשדה review_name בהודעה יצוין שם המשאב של הביקורת שנוספה, ובשדה location_name יופיע שם המשאב של המיקום.
UPDATED_REVIEW ביקורת על המיקום עודכנה. בשדה review_name בהודעה יצוין שם המשאב של הביקורת שנוספה, ובשדה location_name יופיע שם המשאב של המיקום.
NEW_CUSTOMER_MEDIA פריט מדיה חדש נוסף למיקום על ידי משתמש במפות Google. בהתראה יצוין שם המשאב של פריט המדיה החדש.
NEW_QUESTION שאלה חדשה מתווספת למיקום. בהודעה יופיע שם מקור המידע של השאלה.
UPDATED_QUESTION שאלה לגבי המיקום מתעדכנת. בהודעה יופיע שם מקור המידע של השאלה.
NEW_ANSWER תשובה חדשה מתווספת למיקום. בהודעה יופיע שם מקור המידע של השאלה והתשובה.
UPDATED_ANSWER תשובה לגבי המיקום תתעדכן. בהודעה יופיע שם מקור המידע של השאלה והתשובה.
UPDATED_LOCATION_STATE מצב המיקום של המיקום עודכן. ההתראה תכלול את מסכת השדות של שדות ה-LocationState המעודכנים.

התראות

נושא ב-Google Cloud Pub/Sub שבו אפשר לפרסם התראות כשמתעדכן מיקום או כשמתבצעת בדיקה חדשה. יהיה רק משאב אחד של הגדרות התראות לכל חשבון.

שדות
name

string

פלט בלבד. השם של משאב ההתראות.

topic_name

string

הנושא Google Cloud Pub/Sub שיקבל התראות כשנעדכן את המיקומים שמנוהלים על ידי החשבון הזה. אם המדיניות לא מוגדרת, לא יפורסמו התראות.

לחשבון mybusiness-api-pubsub@system.gserviceaccount.com צריכות להיות לפחות הרשאות פרסום בנושא Cloud Pub/Sub.

notification_types[]

NotificationType

סוגי ההתראות שיישלחו לנושא Cloud Pub/Sub. יש לציין לפחות אחד מהם. כדי להפסיק לקבל התראות, אפשר להשתמש בDeleteNotifications.

NutritionFacts

ההודעה הזו מייצגת ערכים תזונתיים של מנה אוכל.

שדות
calories

CaloriesFact

זה שינוי אופציונלי. הקלוריות של המנה.

total_fat

NutritionFact

זה שינוי אופציונלי. מידע על אחוזי השומן במנת אוכל נתונה.

cholesterol

NutritionFact

זה שינוי אופציונלי. מידע על כולסטרול במנה מזון נתונה.

sodium

NutritionFact

זה שינוי אופציונלי. מידע על נתרן במנה מזון נתונה.

total_carbohydrate

NutritionFact

זה שינוי אופציונלי. מידע על כמות הפחמימות במנה מסוימת של אוכל.

protein

NutritionFact

זה שינוי אופציונלי. מידע על חלבון במנת אוכל נתונה.

CaloriesFact

ההודעה הזו מציינת פרטי קלוריות עם גבול עליון וטווח תחתון. יש לציין סכום נמוך יותר. גם הסכומים הנמוכים וגם העליונים הם מספרים לא שליליים.

שדות
lower_amount

int32

חובה. כמות קלוריות נמוכה יותר

upper_amount

int32

זה שינוי אופציונלי. כמות קלוריות גבוהה

unit

EnergyUnit

חובה. יחידת כמות הקלוריות הנתונה.

EnergyUnit

יחידות אפשריות של אנרגיה ממזון (קלוריות).

טיפוסים בני מנייה (enum)
ENERGY_UNIT_UNSPECIFIED יחידת האנרגיה לא צוינה
CALORIE קלוריות
JOULE Joule

MassUnit

יחידות מסה אפשריות.

טיפוסים בני מנייה (enum)
MASS_UNIT_UNSPECIFIED לא צוינה יחידת מסה
GRAM Gram
MILLIGRAM מיליגרם

NutritionFact

ההודעה הזו מציינת מידע תזונתי עם טווח גבול עליון וגבול תחתון, ואפשר לייצג אותה באמצעות יחידת מסה. יש לציין סכום נמוך יותר. גם הסכומים הנמוכים וגם העליונים הם מספרים לא שליליים.

שדות
lower_amount

double

חובה. תזונה נמוכה יותר

upper_amount

double

זה שינוי אופציונלי. ערכים תזונתיים גבוהים

unit

MassUnit

חובה. היחידה של המידע התזונתי הנתון.

OpenInfo

מידע שקשור למצב הפתיחה של העסק.

שדות
status

OpenForBusiness

מציין אם המיקום פתוח עכשיו ופעיל או לא. כל המיקומים פתוחים כברירת מחדל, אלא אם הם עודכנו כסגורים.

can_reopen

bool

פלט בלבד. בעמודה הזו מציינים אם העסק עומד בדרישות לפתיחה מחדש.

opening_date

Date

התאריך שבו המיקום נפתח לראשונה. אם היום המדויק לא ידוע, אפשר לציין רק חודש ושנה. התאריך חייב להיות בעבר או לא יותר משנה אחת בעתיד.

OpenForBusiness

סטטוס של מיקום.

טיפוסים בני מנייה (enum)
OPEN_FOR_BUSINESS_UNSPECIFIED לא צוין.
OPEN מציין שהמיקום פתוח.
CLOSED_PERMANENTLY מציין שהמיקום נסגר לצמיתות.
CLOSED_TEMPORARILY מציין שהמיקום נסגר באופן זמני. ניתן להחיל את הערך הזה רק על מיקומים שפורסמו (למשל, location_state.is_published = true). כשמעדכנים את שדה הסטטוס לערך הזה, הלקוחות נדרשים להגדיר את update_mask באופן מפורש ל-open_info.status. אי אפשר להגדיר מסכות עדכון נוספות במהלך שיחת העדכון הזו. זו הגבלה זמנית שתוסר בקרוב.

PermissionLevel

מציין את רמת הגישה שיש למשתמש המאומת לחשבון הזה.

טיפוסים בני מנייה (enum)
PERMISSION_LEVEL_UNSPECIFIED לא צוין.
OWNER_LEVEL למשתמש יש הרשאה ברמת הבעלים.
MEMBER_LEVEL למשתמש יש הרשאה ברמת חבר.

PhoneInput

קלט לאימות באמצעות PHONE_CALL/SMS.

שדות
phone_number

string

מספר הטלפון שאליו צריך להתקשר או לשלוח SMS. המספר חייב להיות אחד ממספרי הטלפון הזמינים באפשרויות המתאימות.

PlaceInfo

מגדיר אזור שמיוצג על ידי מזהה מקום.

שדות
name

string

השם המותאם לשוק המקומי. לדוגמה, Scottsdale, AZ.

place_id

string

המזהה של המקום. חייב להתאים לאזור.

מקומות

מגדיר את האיחוד של אזורים המיוצגים על ידי קבוצת מקומות.

שדות
place_infos[]

PlaceInfo

האזורים שמיוצגים על ידי מזהי מקומות. מוגבל ל-20 מקומות לכל היותר.

PointRadius

רדיוס סביב נקודה מסוימת (קו רוחב/אורך).

שדות
latlng

LatLng

קו הרוחב/קו האורך שמציין את מרכז האזור המוגדר על ידי הרדיוס.

radius_km

float

המרחק בקילומטרים מהאזור סביב הנקודה.

PreparationMethod

שיטת הכנה של מנת אוכל.

טיפוסים בני מנייה (enum)
PREPARATION_METHOD_UNSPECIFIED שיטת ההכנה לא צוינה
BAKED שיטת האפייה
BARBECUED שיטת צלייה
BASTED שיטת הסינון
BLANCHED שיטה מוסתרת
BOILED שיטה מבושלת
BRAISED שיטת מיון
CODDLED שיטת קידוד
FERMENTED שיטה התססה
FRIED שיטה מטוגנת
GRILLED שיטת הגריל
KNEADED שיטת לישה
MARINATED שיטת מרינדה
PAN_FRIED שיטת טיגון מטוגן
PICKLED שיטת איסוף
PRESSURE_COOKED שיטת בישול בלחץ
ROASTED שיטת הקלייה
SAUTEED שיטת בישול
SEARED שיטת הסינון
SIMMERED שיטת סימולציה
SMOKED שיטה לעישון
STEAMED שיטת אידוי
STEEPED שיטה צפופה
STIR_FRIED שיטת הקפצה בטיגון
OTHER_METHOD שיטה אחרת

PriceList

הוצא משימוש: רשימה של מידע על מחירי הפריט. רשימות המחירים בנויות מרשימות מחירים אחת או יותר, שבכל אחת מהן יש קטע אחד או יותר עם פריט אחד או יותר. לדוגמה, רשימות של מחירי אוכל עשויות לייצג תפריטי ארוחת בוקר/צהריים/ארוחת ערב, עם חלקים להמבורגרים/סטייק/מאכלי ים.

שדות
price_list_id

string

חובה. המזהה של המחירון. לא ניתן לשכפל את רשימת המחירים, את מזהי הקטע ואת מזהי הפריטים במיקום הזה.

labels[]

Label

חובה. תוויות עם תיוג בשפה של מחירון.

source_url

string

כתובת URL אופציונלית של המקור שממנו אוחזרה רשימת המחירים. לדוגמה, זו יכולה להיות כתובת ה-URL של הדף שהועתקו אוטומטית לצורך אכלוס פרטי התפריט.

sections[]

Section

חובה. סעיפים עבור מחירון זה. כל מחירון צריך להכיל לפחות קטע אחד.

תווית

תווית שתשמש להצגת המחירון, החלק או הפריט.

שדות
display_name

string

חובה. השם המוצג של מחירון, החלק או הפריט.

description

string

זה שינוי אופציונלי. תיאור של מחירון, קטע או פריט.

language_code

string

זה שינוי אופציונלי. קוד השפה BCP-47 שעליו חלות המחרוזות האלה. ניתן להגדיר רק קבוצה אחת של תוויות לכל שפה.

קטע

קטע ברשימת המחירים שמכיל פריט אחד או יותר.

שדות
section_id

string

חובה. המזהה של הקטע. לא ניתן לשכפל את רשימת המחירים, את מזהי הקטע ואת מזהי הפריטים במיקום הזה.

labels[]

Label

חובה. תוויות עם תיוג לפי שפה של הקטע. מומלץ שהשמות והתיאורים של הקטעים יהיו באורך של עד 140 תווים. נדרשת לפחות קבוצה אחת של תוויות.

section_type

SectionType

זה שינוי אופציונלי. סוג הקטע הנוכחי של המחירון. ערך ברירת המחדל הוא FOOD.

items[]

Item

פריטים שנכללים בקטע הזה של מחירון.

פריט

פריט יחיד ברשימה. לכל וריאציה של פריט ברשימת המחירים צריך להיות פריט נפרד עם נתוני מחירים משלה.

שדות
item_id

string

חובה. המזהה של הפריט. לא ניתן לשכפל את רשימת המחירים, את מזהי הקטע ואת מזהי הפריטים במיקום הזה.

labels[]

Label

חובה. תוויות של הפריט שתויגו בשפה. מומלץ שהשמות של הפריטים יהיו באורך של 140 תווים לכל היותר, ובאורך של 250 תווים לכל היותר. נדרשת לפחות קבוצה אחת של תוויות.

price

Money

זה שינוי אופציונלי. מחיר הפריט.

SectionType

סוג הקטע.

טיפוסים בני מנייה (enum)
SECTION_TYPE_UNSPECIFIED לא צוין.
FOOD המקטע מכיל פריטים שמייצגים אוכל.
SERVICES הקטע מכיל פריטים שמייצגים שירותים.

פרופיל

כל המידע שקשור לפרופיל של המיקום.

שדות
description

string

תיאור של המיקום בקול שלכם. אנשים אחרים לא יכולים לערוך אותו.

שאלה

מייצג שאלה אחת וחלק מהתשובות שלה.

שדות
name

string

פלט בלבד. השם הייחודי של השאלה. accounts/*/locations/*/questions/*

author

Author

פלט בלבד. מחבר השאלה.

upvote_count

int32

פלט בלבד. מספר הלייקים לשאלה.

text

string

הטקסט של השאלה. השם צריך לכלול לפחות שלוש מילים, והאורך הכולל שלו צריך להיות 10 תווים לכל היותר. האורך המקסימלי הוא 4,096 תווים.

create_time

Timestamp

פלט בלבד. חותמת הזמן של מועד כתיבת השאלה.

update_time

Timestamp

פלט בלבד. חותמת הזמן של מועד השינוי האחרון של השאלה.

top_answers[]

Answer

פלט בלבד. רשימה של תשובות לשאלה, ממוינות לפי לייקים. יכול להיות שזו רשימה חלקית של תשובות, בהתאם לפרמטרים של הבקשה (answers_per_question)

total_answer_count

int32

פלט בלבד. המספר הכולל של תשובות שפורסמו לשאלה הזו.

RepeatedEnumAttributeValue

ערכי מאפיין עם value_type של REPEATED_ENUM. המערכת מורכבת משתי רשימות של מזהים של ערכים: אלו שמוגדרים (true) ומזהים לא מוגדרים (false). ערכים שחסרים נחשבים לא ידועים. יש לציין לפחות ערך אחד.

שדות
set_values[]

string

ערכי ה-Enum שהוגדרו.

unset_values[]

string

ערכים של מספרים שלא הוגדרו.

ReportGoogleLocationRequest

הודעת בקשה לדיווח על GoogleLocation.

שדות
name

string

שם המשאב של [GoogleLocation], בפורמט googleLocations/{googleLocationId}.

location_group_name

string

זה שינוי אופציונלי. שם המשאב של קבוצת המיקומים שעבורה מתבצע הדיווח על המיקום הזה ב-Google, בפורמט accounts/{account_id}.

report_reason_elaboration

string

זה שינוי אופציונלי. רשומת טקסט עם הסבר על הסיבה שבגללה המשתמש מדווח על המיקום הזה. האורך המקסימלי הוא 512 תווים.

report_reason_language_code

string

זה שינוי אופציונלי. קוד השפה של BCP 47 שנעשה בו שימוש בreport_reason_elaboration.

שדה איחוד report_reason. הסיבה לדיווח על המיקום הזה. חובה לציין סיבה. report_reason יכול להיות רק אחת מהאפשרויות הבאות:
report_reason_bad_location

BadLocationReason

הסיבה שבגללה המשתמש מדווח על המיקום הזה כאשר הבעיה היא במיקום עצמו.

report_reason_bad_recommendation

BadRecommendationReason

הסיבה שבגללה המשתמש מדווח על המיקום הזה כאשר הבעיה היא בהמלצה. הדוח הזה שימושי אם הומלץ על המיקום לחשבון 'פרופיל העסק ב-Google'.

BadLocationReason

קבוצה של סיבות אפשריות לדיווח על מיקום כשיש בעיה באיכות הנתונים במיקום עצמו.

טיפוסים בני מנייה (enum)
BAD_LOCATION_REASON_UNSPECIFIED לא צוין.
NOT_A_LOCATION המיקום המומלץ אינו מיקום ממשי.
PERMANENTLY_CLOSED המיקום המומלץ נסגר לצמיתות.
DOES_NOT_EXIST המיקום המומלץ לא קיים.
SPAM המיקום המומלץ הוא ספאם, מזויף או פוגעני.
NOT_A_BUSINESS המיקום המומלץ הוא מקום או בית פרטי.
MOVED

המיקום המומלץ עבר למיקום חדש.

צריך לציין יחד איתו גם את report_reason_elaboration, שמציין את הכתובת החדשה.

DUPLICATE המיקום המומלץ הוא כפילות של מיקום אחר.

BadRecommendationReason

רשימה של סיבות אפשריות לדיווח על מיקום כאשר יש בעיה באיכות ההמלצה (כאשר המיקום הזה מומלץ למשתמש).

טיפוסים בני מנייה (enum)
BAD_RECOMMENDATION_REASON_UNSPECIFIED לא צוין.
NOT_A_STORE_FRONT המיקום המומלץ הוא לא חזית של חנות.
NOT_PART_OF_SUGGESTED_CHAIN

המיקום המומלץ לא שייך לרשת שהוצעה ב-chain_display_name במיקום שהוחזר.

יש לציין יחד איתו גם report_reason_elaboration, שמציין את השם של הרשת הנכונה.

IRRELEVANT

המיקום המומלץ לא רלוונטי למשתמש.

יש לציין יחד עם report_reason_elaboration את הסיבה לכך שההמלצה לא רלוונטית.

ReportLocalPostInsightsRequest

הודעת בקשה לקבלת תובנות.ReportLocalPostInsights

שדות
name

string

חובה. שם המיקום שעבורו רוצים לאחזר תובנות.

local_post_names[]

string

חובה. רשימת הפוסטים שעבורם מאחזרים נתוני תובנות. כל הפוסטים צריכים להשתייך למיקום ששמו צוין בשדה name.

basic_request

BasicMetricsRequest

בקשה לכלול תובנות בסיסיות לגבי מדדים בדוח. הבקשה הזו חלה על כל הפוסטים המבוקשים.

ReportLocalPostInsightsResponse

הודעת תגובה לגבי Insights.ReportLocalPostInsights

שדות
name

string

local_post_metrics[]

LocalPostMetrics

רשומה אחת לכל פוסט מבוקש, שתואמת למיקום הזה.

time_zone

string

אזור זמן (מזהי אזור זמן IANA, למשל, 'אירופה/לונדון') של המיקום.

ReportLocationInsightsRequest

בקשה של הודעת בקשה ל-Insights.ReportLocationInsights.

שדות
name

string

השם של משאב החשבון.

location_names[]

string

אוסף של מיקומים שעבורם אפשר לאחזר תובנות, שצוינו לפי השמות שלהם.

basic_request

BasicMetricsRequest

בקשה לכלול תובנות בסיסיות לגבי מדדים בדוח.

driving_directions_request

DrivingDirectionMetricsRequest

בקשה לכלול בדוח תובנות לגבי בקשות לקבלת מסלול נסיעה.

ReportLocationInsightsResponse

הודעת תשובה עבור Insights.ReportLocationInsights.

שדות
location_metrics[]

LocationMetrics

אוסף של ערכי מדדים לפי מיקום.

location_driving_direction_metrics[]

LocationDrivingDirectionMetrics

אוסף של ערכים הקשורים למסלולי נסיעה.

בדיקה

פלט בלבד. מייצג ביקורת על מיקום.

שדות
name

string

שם המשאב לבדיקה מדובר בפורמט accounts/{account_id}/locations/{location_id}/reviews/{review_id}

review_id

string

המזהה הייחודי המוצפן.

reviewer

Reviewer

מחבר הביקורת.

star_rating

StarRating

דירוג הכוכבים של הביקורת.

comment

string

גוף הביקורת כטקסט פשוט עם תגי עיצוב.

create_time

Timestamp

חותמת הזמן של מועד כתיבת הביקורת.

update_time

Timestamp

חותמת הזמן של מועד השינוי האחרון של הביקורת.

review_reply

ReviewReply

התשובה של הבעלים/המנהל של המיקום הזה לביקורת הזו.

כותב הביקורת

מייצג את המחבר של הביקורת.

שדות
profile_photo_url

string

הקישור לתמונת הפרופיל של כותב הביקורת. השדה מאוכלס רק אם הערך של is_anonymous הוא False.

display_name

string

השם של כותב הביקורת. השדה הזה מאוכלס רק בשם האמיתי של כותב הביקורת אם הערך של is_anonymous הוא False.

is_anonymous

bool

מציין אם כותב הביקורת בחר להישאר אנונימי.

StarRating

דירוג הכוכבים מתוך חמישה, כאשר 5 הוא הדירוג הגבוה ביותר.

טיפוסים בני מנייה (enum)
STAR_RATING_UNSPECIFIED לא צוין.
ONE כוכב אחד מתוך חמישה.
TWO שני כוכבים מתוך חמישה כוכבים לכל היותר.
THREE שלושה כוכבים מתוך חמישה כוכבים לכל היותר.
FOUR ארבעה כוכבים מתוך חמישה כוכבים לכל היותר.
FIVE דירוג הכוכבים המקסימלי.

ReviewReply

מייצג את התשובה של הבעלים או המנהל של המיקום לביקורת.

שדות
comment

string

גוף התשובה כטקסט פשוט עם תגי עיצוב. האורך המקסימלי הוא 4,096 בייטים.

update_time

Timestamp

פלט בלבד. חותמת הזמן של מועד השינוי האחרון של התשובה.

SearchChainsRequest

הודעת בקשה עבור Locations.SearchChains.

שדות
chain_display_name

string

מחפשים רשת לפי השם שלה. יש תמיכה בשאילתות מדויקות/חלקיות/מטושטשות או קשורות. דוגמאות: "walmart" , "wal-mart" , "walmmmart" , "沃尔玛"

result_count

int32

המספר המקסימלי של שרשראות תואמות שצריך להחזיר מהשאילתה הזו. ערך ברירת המחדל הוא 10. הערך המקסימלי האפשרי הוא 500.

SearchChainsResponse

הודעת תגובה ל-Locations.SearchChains.

שדות
chains[]

Chain

רשתות שתואמות ל-שרשרת_display_name שהשאילתה מבקשת ב-SearchChainsRequest. אם אין התאמות, השדה הזה יהיה ריק. התוצאות מוצגות לפי סדר הרלוונטיות שלהן.

SearchGoogleLocationsRequest

הודעת בקשה עבור GoogleLocations.SearchGoogleLocations.

שדות
result_count

int32

מספר ההתאמות שיש להחזיר. ערך ברירת המחדל הוא 3, והערך המקסימלי הוא 10. חשוב לזכור שזמן האחזור יכול להתארך אם תישלח בקשה נוספת. אין חלוקה לדפים.

שדה איחוד search_query. שאילתת חיפוש. אפשר לספק אותו כאובייקט מיקום או כשאילתת מחרוזת. search_query יכול להיות רק אחת מהאפשרויות הבאות:
location

Location

המיקום שצריך לחפש. אם תספקו כתובת, המערכת תמצא מיקומים שתואמים לפרטי המיקום שסופקו.

query

string

שאילתת טקסט לחיפוש. תוצאות החיפוש ממחרוזת שאילתה יהיו פחות מדויקות מאשר אם תספקו מיקום מדויק, אבל יכולות לספק יותר התאמות לא מדויקות.

SearchGoogleLocationsResponse

הודעת תגובה לגבי GoogleLocations.SearchGoogleLocations.

שדות
google_locations[]

GoogleLocation

אוסף של מיקומים של Google שהם התאמות פוטנציאליות לבקשה שצוינה, בסדר יורד, מהגבוה לנמוך.

ServiceAreaBusiness

נותני שירות באזור מוגדר (SAB) מספקים את השירות במיקום שבו הלקוח נמצא (לדוגמה, מנעולנים או שרברבים).

שדות
business_type

BusinessType

מציין את type של העסק שנותן שירות באזור מוגדר (SAB).

שדה איחוד coverageArea. מציין את אזור הכיסוי שבו העסק מציע שירות. coverageArea יכול להיות רק אחת מהאפשרויות הבאות:
radius

PointRadius

פלט בלבד. האזור שהעסק הזה מספק שירות מתמקד סביב נקודה מסוימת.

places

Places

האזור שבו העסק הזה פועל מוגדר באמצעות קבוצה של מקומות.

BusinessType

מציין אם העסק מציע שירותים במיקום פיזי של הלקוח (למשל, גרר) או גם בכתובת וגם באתר (למשל, פיצרייה עם פינת אוכל, שאפשר לבצע בה גם משלוחים ללקוחות).

טיפוסים בני מנייה (enum)
BUSINESS_TYPE_UNSPECIFIED פלט בלבד. לא צוין.
CUSTOMER_LOCATION_ONLY העסק מציע שירות רק באזור שמסביב (לא בכתובת העסק).
CUSTOMER_AND_BUSINESS_LOCATION מציע שירות בכתובת העסק ובאזור שמסביב.

ServiceBusinessContext

נתונים נוספים לאימות העסק שמספק שירותים.

שדות
address

PostalAddress

הכתובת לאימות של המיקום. הוא משמש להפעלת אפשרויות אימות נוספות או לשליחת גלויה.

ServiceList

רשימת שירותים שמכילה פריט שירות אחד או יותר.

שדות
name

string

חובה. מזהה Google של המיקום הזה בטופס: accounts/{account_id}/locations/{location_id}/serviceList

service_items[]

ServiceItem

פריטי שירות שכלולים ברשימת השירותים הזו. פריטי שירות ששוכפלו יוסרו באופן אוטומטי.

ServiceItem

הודעה שמתארת פריט שירות אחד. היא משמשת לתיאור סוג השירות שהמוכר מספק. לדוגמה, תספורת יכולה להיות שירות.

שדות
is_offered

bool

זה שינוי אופציונלי. השדה הזה קובע אם המוכר מציע את שירות הקלט.

price

Money

זה שינוי אופציונלי. מייצג את המחיר הכספי של פריט השירות. מומלץ להגדיר את ערכי currency_code והיחידות כשכוללים מחיר.

שדה איחוד service_item_info. צריך תמיד להגדיר אחד מהשדות הבאים. service_item_info יכול להיות רק אחת מהאפשרויות הבאות:
structured_service_item

StructuredServiceItem

השדה הזה יוגדר בתור אותיות רישיות בנתוני שירותים מובְנים.

free_form_service_item

FreeFormServiceItem

בשדה הזה תוגדר אותיות רישיות של נתוני שירותים בפריסה גמישה.

FreeFormServiceItem

מייצג שירות בפריסה גמישה שמוצע על ידי המוכר. אלו שירותים שלא נחשפים כחלק מנתוני השירותים המבנה שלנו. המוכר מזין באופן ידני את השמות של שירותים כאלה דרך פלטפורמה של מוכר גיאוגרפי.

שדות
category_id

string

חובה. category_id ו-service_type_id צריכים להתאים לשילובים האפשריים שצוינו בהודעה Category.

label

Label

חובה. תוויות של הפריט שתויגו בשפה. מומלץ שהשמות של הפריטים יהיו באורך של 140 תווים לכל היותר, ובאורך של 250 תווים לכל היותר. יש להגדיר את השדה הזה רק אם הקלט הוא פריט שירות בהתאמה אישית. צריך לעדכן את סוגי השירותים הסטנדרטיים באמצעות service_type_id.

StructuredServiceItem

מייצג שירות מובנה שמוצע על ידי המוכר. לדוגמה: toilet_installation.

שדות
service_type_id

string

חובה. השדה service_type_id הוא מזהה ייחודי ש-Google סיפקה ונמצאים ב-ServiceTypeMetadata. מידע זה מסופק על ידי שירות rpc של BatchGetBusinessCategory.

description

string

זה שינוי אופציונלי. תיאור של פריט השירות המובנה. מגבלת התווים היא 300.

ServiceType

הודעה שמתארת את סוג השירות שהעסק מציע.

שדות
service_type_id

string

פלט בלבד. מזהה קבוע (שסופק על ידי Google) לסוג השירות הזה.

display_name

string

פלט בלבד. השם המוצג של סוג השירות, קריא לאנשים.

SpecialHourPeriod

מייצג תקופה אחת שבה שעות הפעילות של מיקום שונות משעות הפעילות הרגילות שלו. טווח של שעות פתיחה מיוחדות צריך להיות פחות מ-24 שעות. הערכים open_time ו-start_date צריכים להקדים את close_time ואת end_date. הטווח close_time וend_date יכול להימשך עד 11:59 ביום שאחרי התאריך שצוין ב-start_date. לדוגמה, ערכי הקלט הבאים תקינים:

start_date=2015-11-23, open_time=08:00, close_time=18:00
start_date=2015-11-23, end_date=2015-11-23, open_time=08:00,
close_time=18:00 start_date=2015-11-23, end_date=2015-11-24,
open_time=13:00, close_time=11:59

ערכי הקלט הבאים לא תקינים:

start_date=2015-11-23, open_time=13:00, close_time=11:59
start_date=2015-11-23, end_date=2015-11-24, open_time=13:00,
close_time=12:00 start_date=2015-11-23, end_date=2015-11-25,
open_time=08:00, close_time=18:00
שדות
start_date

Date

התאריך הקלנדרי שבו מתחילה תקופת השעה המיוחדת הזו.

open_time

string

זמן הקיר ב-start_date כשמיקום נפתח, מבוטא בפורמט מורחב לפי תקן ISO 8601. (hh:mm) הערכים החוקיים הם 00:00-24:00, כאשר 24:00 מייצג את חצות בסוף שדה היום שצוין. יש לציין אם הערך של is_closed הוא False.

end_date

Date

התאריך ביומן שבו מסתיימת תקופת השעה המיוחדת הזו. אם השדה end_date לא מוגדר, ברירת המחדל תהיה התאריך שצוין ב-start_date. אם השדה הזה מוגדר, הערך שלו צריך להיות שווה ליום אחד לכל היותר אחרי start_date.

close_time

string

זמן הקיר ב-end_date כשמיקום נסגר, מבוטא בפורמט מורחב לפי תקן ISO 8601. (hh:mm) הערכים החוקיים הם 00:00-24:00, כאשר 24:00 מייצג את חצות בסוף שדה היום שצוין. יש לציין אם הערך של is_closed הוא False.

is_closed

bool

אם הערך הוא True, המערכת מתעלמת מ-end_date, מ-open_time ומ-close_time, והתאריך שצוין ב-start_date נחשב כסגור למשך כל היום.

SpecialHours

מייצג קבוצה של תקופות זמן שבהן שעות הפעילות של מיקום שונות משעות הפעילות הרגילות שלו.

שדות
special_hour_periods[]

SpecialHourPeriod

רשימת חריגים משעות הפעילות הרגילות של העסק.

חרציות

רמת החריפות של פריט מזון.

טיפוסים בני מנייה (enum)
SPICINESS_UNSPECIFIED לא צוינה רמה
MILD שם של חריף עדין.
MEDIUM שם של חריף בגוון ביניים.
HOT מילת מפתח של חריף חריף. הרמה הכי מעניינת.

StartUploadMediaItemDataRequest

הודעת בקשה עבור Media.StartUploadMediaItemData.

שדות
parent

string

שם המשאב של המיקום שאליו פריט המדיה הזה יתווסף.

TimeInterval

מרווח זמן, כולל. כדי לעמוד בדרישות, העמודה צריכה להכיל את כל השדות.

שדות
start_date

Date

תאריך ההתחלה של התקופה הזו.

start_time

TimeOfDay

שעת ההתחלה של התקופה הזו.

end_date

Date

תאריך הסיום של התקופה הזו.

end_time

TimeOfDay

מועד הסיום של התקופה הזו.

TimePeriod

מייצג את פרק הזמן שבו העסק פתוח, החל ביום או בשעה הפתוחים שצוינו ובשעת הסגירה שצוינה. שעת הסגירה חייבת לחול אחרי שעת הפתיחה, למשל מאוחר יותר באותו יום או ביום שלאחר מכן.

שדות
open_day

DayOfWeek

מציין את day of the week שהתקופה הזו מתחילה.

open_time

string

השעה בפורמט מורחב של 24 שעות לפי תקן ISO 8601 (hh:mm). הערכים החוקיים הם 00:00-24:00. השעה 24:00 מייצגת את חצות בסוף שדה היום שצוין.

close_day

DayOfWeek

מציין את day of the week שהתקופה הזו מסתיימת.

close_time

string

השעה בפורמט מורחב של 24 שעות לפי תקן ISO 8601 (hh:mm). הערכים החוקיים הם 00:00-24:00. השעה 24:00 מייצגת את חצות בסוף שדה היום שצוין.

TimeRange

טווח זמן. הנתונים יישלפו מהטווח כערך פתוח למחצה (כלומר, [start_time, end_time)).

שדות
start_time

Timestamp

חותמת זמן של תקופת הזמן בתחילת הטווח (כולל).

end_time

Timestamp

חותמת זמן של תקופה זמנית עבור סוף הטווח (לא כולל).

TransferLocationRequest

הודעת בקשה עבור Locations.TransferLocation.

שדות
name

string

שם המיקום להעברה.

to_account

string

השם של משאב החשבון שאליו צריך להעביר את המיקום (לדוגמה, 'accounts/8675309').

UpdateAccountAdminRequest

הודעת בקשה לגבי AccessControl.UpdateAccountAdmin.

שדות
name

string

שם המשאב של האדמין שצריך לעדכן.

admin

Admin

האדמין המעודכן. הערה: השדה היחיד שניתן לעריכה הוא role. המערכת תתעלם מכל שאר השדות.

UpdateAccountRequest

הודעת בקשה עבור Accounts.UpdateAccount.

שדות
name

string

שם החשבון שרוצים לעדכן.

account

Account

פרטי החשבון המעודכנים. הערה: השדה היחיד שניתן לעריכה הוא account_name.

validate_only

bool

אם כן, הבקשה מאומתת בלי לעדכן את החשבון בפועל.

UpdateFoodMenusRequest

הודעת בקשה ל-Foodmenu.UpdateFoodmenus

שדות
food_menus

FoodMenus

חובה. הפרטים המעודכנים של תפריט האוכל. כדי לבטל את הגדרת התפריט, אפשר לעדכן את התפריט בלי ליצור קטעים בתפריט.

update_mask

FieldMask

זה שינוי אופציונלי. השדות הספציפיים שצריך לעדכן. אם לא צוינה מסכה, הפעולה הזו נחשבת לעדכון מלא וכל השדות מוגדרים לערכים שמועברים. יכול להיות שיהיו מקרים שבהם לא תגדירו שדות ריקים בבקשה. לא ניתן לעדכן פריטים חוזרים בשדה בנפרד. הערה: "name" של Foodתפריטs הוא מזהה המשאב שלא ניתן לעדכן.

UpdateHealthProviderAttributesRequest

הודעת בקשה ל-HealthProviderAttributes.UpdateHealthProviderAttributes

שדות
health_provider_attributes

HealthProviderAttributes

חובה. המאפיינים המעודכנים של ספק הבריאות.

update_mask

FieldMask

זה שינוי אופציונלי. השדות הספציפיים שצריך לעדכן. אם לא צוינה מסכה, הפעולה הזו נחשבת לעדכון מלא וכל השדות מוגדרים לערכים שמועברים. יכול להיות שיהיו מקרים שבהם לא תגדירו שדות ריקים בבקשה. בגרסה 1 יש רק את השדה policies_networks לעדכון. בהמשך תהיה תמיכה במאפיינים נוספים.

UpdateLocalPostRequest

הודעת בקשה ל-UpdateLocalPost.

שדות
name

string

שם הפוסט המקומי שצריך לעדכן.

local_post

LocalPost

הפרטים המעודכנים של הפוסט המקומי.

update_mask

FieldMask

השדות הספציפיים שצריך לעדכן. עליך לציין כל שדה שמתעדכן במסכה.

UpdateLocationAdminRequest

הודעת בקשה לגבי AccessControl.UpdateLocationAdmin.

שדות
name

string

שם המשאב של האדמין שצריך לעדכן.

admin

Admin

האדמין המעודכן. הערה: השדה היחיד שניתן לעריכה הוא role. המערכת תתעלם מכל שאר השדות.

UpdateLocationRequest

הודעת בקשה לגבי Locations.UpdateLocation.

שדות
name

string

שם המיקום שרוצים לעדכן.

location

Location

פרטי המיקום המעודכנים.

update_mask

FieldMask

השדות הספציפיים שצריך לעדכן. אם לא צוינה מסכה, הפעולה הזו נחשבת לעדכון מלא וכל השדות מוגדרים לערכים שמועברים. יכול להיות שיהיו מקרים שבהם לא תגדירו שדות ריקים בבקשה.

validate_only

bool

אם הערך הוא True, הבקשה מאומתת בלי לעדכן את המיקום בפועל.

attribute_mask

FieldMask

המזהים של המאפיינים שצריך לעדכן. רק המאפיינים שמצוינים במסכה יעודכנו. אם מאפיין מסוים מופיע במסכה ולא במיקום שלו, הוא יוסר. אם המסכה ריקה, כל המאפיינים יתעדכנו.

בכל פעם שהשדה הזה מוגדר, השדה update_mask צריך לכלול מאפיינים כאחד מהשדות שצריך לעדכן.

UpdateMediaItemRequest

הודעת בקשה עבור Media.UpdateMediaItem.

שדות
name

string

השם של פריט המדיה שצריך לעדכן.

media_item

MediaItem

פריט המדיה שצריך לעדכן.

אפשר לעדכן רק את מזהה הפריט של הקטגוריה או המחירון.

update_mask

FieldMask

השדות הספציפיים שצריך לעדכן. אם לא מצוינת מסכה, הפעולה הזו נחשבת לעדכון מלא וכל השדות שניתנים לעריכה מוגדרים לערכים שמועברים.

UpdateNotificationsRequest

הודעת בקשה עבור Accounts.UpdateNotifications.

שדות
name

string

שם המשאב של הגדרת ההתראות.

notifications

Notifications

עדכון הגדרת ההתראות.

UpdateQuestionRequest

הודעת בקשה ל-QuestionAndAnswers.UpdateQuestion

שדות
name

string

שם השאלה שצריך לעדכן.

question

Question

השאלה המעודכנת.

UpdateReviewReplyRequest

הודעת בקשה ל-Reviews.UpdateReviewReply.

שדות
name

string

השם של הביקורת שעליה רוצים להגיב.

review_reply

ReviewReply

התשובה לביקורת. אם כבר יש תשובה, היא תחליף את התשובה הישנה.

UpdateServiceListRequest

עדכון הודעת הבקשה לרשימת שירותים.

שדות
service_list

ServiceList

זה שינוי אופציונלי. הפרטים המעודכנים של רשימת השירותים. אם השדה הזה ריק, ממשק ה-API ימחק את השדה ServiceList. אם מוגדרת ServiceList, ה-API יחליף את ה-ServiceList המקורי ב-ServiceList.

update_mask

FieldMask

זה שינוי אופציונלי. השדות הספציפיים שצריך לעדכן. אם לא צוינה מסכה, הפעולה הזו נחשבת לעדכון מלא וכל השדות מוגדרים לערכים שמועברים. יכול להיות שיהיו מקרים שבהם לא תגדירו שדות ריקים בבקשה. לא ניתן לעדכן פריטים חוזרים בשדה בנפרד.

UpsertAnswerRequest

הודעה עם בקשה לגבי שאלותAndAnswers.UpsertAnswer

שדות
parent

string

שם השאלה שעליה רוצים לכתוב את התשובה.

answer

Answer

התשובה החדשה.

UrlAttributeValue

ערכי מאפיין עם value_type של כתובת URL.

שדות
url

string

כתובת ה-URL.

ValidationError

תיאור כשלי אימות בבקשת לקוח.

שדות
error_details[]

ErrorDetail

פירוט כשלי אימות בודדים עם קודי שגיאה מסוג מספרים שלמים.

אימות

אימות מייצג ניסיון אימות במיקום מסוים.

שדות
name

string

שם מקור המידע של האימות.

method

VerificationMethod

שיטת האימות.

state

VerificationState

מצב האימות.

create_time

Timestamp

חותמת הזמן של בקשת האימות.

VerificationState

כל מצבי האימות האפשריים.

טיפוסים בני מנייה (enum)
VERIFICATION_STATE_UNSPECIFIED ערך ברירת המחדל יגרום לשגיאות.
PENDING האימות בהמתנה.
COMPLETED האימות הושלם.
FAILED האימות נכשל.

VerificationMethod

מציינת את התהליכים ש-Google משתמשת בהם כדי לאמת מיקום.

טיפוסים בני מנייה (enum)
VERIFICATION_METHOD_UNSPECIFIED ערך ברירת המחדל יגרום לשגיאות.
ADDRESS שולחים גלויה עם קוד אימות לכתובת דואר ספציפית. קוד האימות משמש להשלמת האימות ב-Google.
EMAIL שולחים אימייל עם קוד אימות לכתובת אימייל ספציפית. קוד האימות משמש להשלמת האימות ב-Google.
PHONE_CALL לבצע שיחת טלפון עם קוד אימות למספר טלפון ספציפי. קוד האימות משמש להשלמת האימות ב-Google.
SMS שליחת הודעת SMS עם קוד אימות למספר טלפון ספציפי. קוד האימות משמש להשלמת האימות ב-Google.
AUTO אימות המיקום ללא צורך בפעולה נוספת של המשתמש. יכול להיות שהאפשרות הזו לא תהיה זמינה לכל המיקומים.

VerificationOption

אפשרות האימות מייצגת את האופן שבו מאמתים את המיקום (מצוין בשיטת האימות) ולאן יישלח האימות (מצוין בנתונים המוצגים).

שדות
verification_method

VerificationMethod

שיטה לאימות המיקום.

שדה איחוד DisplayData. אחד מהנתונים ברשת המדיה. הנתונים חייבים להתאים לשיטה. ריקה אם השיטה המתאימה לא מכילה נתוני תצוגה. DisplayData יכול להיות רק אחת מהאפשרויות הבאות:
phone_data

PhoneVerificationData

יש להגדיר רק אם השיטה היא PHONE_CALL או SMS.

address_data

AddressVerificationData

יש להגדיר רק אם השיטה היא MAIL.

email_data

EmailVerificationData

יש להגדיר רק אם השיטה היא EMAIL.

AddressVerificationData

הצגת נתונים לאימות באמצעות גלויה.

שדות
business_name

string

שם העסק של המוכר.

address

PostalAddress

הכתובת שאליה ניתן לשלוח גלויה.

EmailVerificationData

הצגת נתונים לאימות באימייל.

שדות
domain_name

string

שם הדומיין בכתובת האימייל. לדוגמה &quot;gmail.com&quot; ב-foo@gmail.com

user_name

string

שם המשתמש בכתובת האימייל. לדוגמה "foo" ב-foo@gmail.com

is_user_name_editable

bool

האם הלקוח רשאי לספק שם משתמש אחר.

PhoneVerificationData

הצגת נתונים לאימות באמצעות הטלפון, למשל: שיחת טלפון, sms.

שדות
phone_number

string

מספר הטלפון שאליו יישלח קוד האימות.

VerifyLocationRequest

הודעת בקשה לאימות (attestations.VerifyLocation).

שדות
name

string

שם המשאב של המיקום לאימות.

method

VerificationMethod

שיטת האימות.

language_code

string

קוד השפה BCP 47 שמייצג את השפה שבה יש להשתמש בתהליך האימות.

context

ServiceBusinessContext

מידע נוסף בהקשר לאימות עסקים שמספקים שירותים. חובה עבור המיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. לצורך אימות ADDRESS, הכתובת תשמש לשליחת גלויה. עבור שיטות אחרות, היא צריכה להיות זהה לזו שמועברת אל FetchAuthenticationOptions. הערך INVALID_ARGUMENT לא יסומן אם הוא מוגדר לסוגים אחרים של מיקומי עסקים.

שדה איחוד RequestData. נתוני קלט של משתמשים לשיטה ספציפית, בנוסף לנתוני התצוגה. הנתונים חייבים להתאים לשיטה המבוקשת. אם אין צורך בנתונים, אפשר להשאיר אותה ריקה. RequestData יכול להיות רק אחת מהאפשרויות הבאות:
email_input

EmailInput

הקלט למתודה EMAIL.

address_input

AddressInput

הקלט לשיטה ADDRESS.

phone_input

PhoneInput

הקלט לשיטת PHONE_CALL/SMS

VerifyLocationResponse

הודעת תגובה ל-Authentications.VerifyLocation.

שדות
verification

Verification

בקשת האימות שנוצרה.