Package google.mybusiness.businessinformation.v1

אינדקס

AttributesService

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

GetAttributes

rpc GetAttributes(GetAttributesRequest) returns (Attributes)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

GetGoogleUpdatedAttributes

rpc GetGoogleUpdatedAttributes(GetGoogleUpdatedAttributesRequest) returns (Attributes)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

ListAttributeMetadata

rpc ListAttributeMetadata(ListAttributeMetadataRequest) returns (ListAttributeMetadataResponse)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

UpdateAttributes

rpc UpdateAttributes(UpdateAttributesRequest) returns (Attributes)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

CategoriesService

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

BatchGetCategories

rpc BatchGetCategories(BatchGetCategoriesRequest) returns (BatchGetCategoriesResponse)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

ListCategories

rpc ListCategories(ListCategoriesRequest) returns (ListCategoriesResponse)

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

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

רשתות

שירות לחיפוש מידע על רשת.

GetChain

rpc GetChain(GetChainRequest) returns (Chain)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

SearchChains

rpc SearchChains(SearchChainsRequest) returns (SearchChainsResponse)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

GoogleLocations

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

SearchGoogleLocations

rpc SearchGoogleLocations(SearchGoogleLocationsRequest) returns (SearchGoogleLocationsResponse)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

מיקומים

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

CreateLocation

rpc CreateLocation(CreateLocationRequest) returns (Location)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

DeleteLocation

rpc DeleteLocation(DeleteLocationRequest) returns (Empty)

מוחק מיקום.

אם לא ניתן למחוק את המיקום הזה באמצעות ה-API והוא מסומן כך ב-google.mybusiness.businessinformation.v1.LocationState, צריך להשתמש באתר של פרופיל העסק ב-Google.

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

GetGoogleUpdatedLocation

rpc GetGoogleUpdatedLocation(GetGoogleUpdatedLocationRequest) returns (GoogleUpdatedLocation)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

GetLocation

rpc GetLocation(GetLocationRequest) returns (Location)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

ListLocations

rpc ListLocations(ListLocationsRequest) returns (ListLocationsResponse)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

UpdateLocation

rpc UpdateLocation(UpdateLocationRequest) returns (Location)

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

היקפי ההרשאות

נדרש היקף ההרשאות הבא של OAuth:

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

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

AdWordsLocationExtensions

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

שדות
ad_phone

string

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

מאפיין

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

שדות
name

string

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

value_type

AttributeValueType

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

values[]

Value

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

repeated_enum_value

RepeatedEnumAttributeValue

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

uri_values[]

UriAttributeValue

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

AttributeMetadata

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

שדות
parent

string

המזהה הייחודי של המאפיין.

value_type

AttributeValueType

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

display_name

string

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

group_display_name

string

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

repeatable

bool

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

value_metadata[]

AttributeValueMetadata

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

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)' עם כמה ערכים אפשריים שאפשר להגדיר או לבטל באופן מפורש.

מאפיינים

מאגר לכל המאפיינים של מיקום נתון.

שדות
name

string

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

attributes[]

Attribute

אוסף של מאפיינים שצריך לעדכן.

BatchGetCategoriesRequest

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

שדות
names[]

string

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

language_code

string

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

region_code

string

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

view

CategoryView

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

BatchGetCategoriesResponse

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

שדות
categories[]

Category

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

BusinessHours

מייצג את תקופות הזמן שבהן המיקום הזה פעיל. מכיל אוסף של מופעים של [TimePeriod][google.mybusiness.mybusinessinformation.v1.TimePeriod].

שדות
periods[]

TimePeriod

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

קטגוריות

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

שדות
primary_category

Category

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

additional_categories[]

Category

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

קטגוריה

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

שדות
name

string

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

display_name

string

פלט בלבד. שם קריא לאנשים של הקטגוריה. ההגדרה הזו מוגדרת כשקוראים את המיקום. כשמשנים את המיקום, צריך להגדיר 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_id}.

chain_names[]

ChainName

שמות השרשרת.

websites[]

ChainUri

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

location_count

int32

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

ChainName

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

שדות
display_name

string

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

language_code

string

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

ChainUri

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

שדות
uri

string

ה-URI של הרשת הזו.

CreateLocationRequest

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

שדות
parent

string

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

location

Location

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

validate_only

bool

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

request_id

string

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

DeleteLocationRequest

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

שדות
name

string

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

ErrorCode

כל קודי השגיאות שהוחזרו על ידי ה-API.

טיפוסים בני מנייה (enum)
ERROR_CODE_UNSPECIFIED חסר קוד שגיאה.
INVALID_ATTRIBUTE_NAME לא ניתן להחיל אחד מהמאפיינים שסופקו על המיקום הזה. אפשר להחיל על המיקום הזה רק מאפיינים שהוחזרו בתשובה ListAttributeMetadata. כל שמות המאפיינים הבעייתיים יוחזרו במפתח attribute_names מתחת למטא-נתונים.
ASSOCIATE_OPERATION_ON_VERIFIED_LOCATION השגיאה הזו מוחזרת כשלקוח מנסה לשייך מיקום או לבטל שיוך של מיקום למיקום שנמצא במצב מאומת.
ASSOCIATE_LOCATION_INVALID_PLACE_ID הערך של place_id שצוין בבקשה associateLocation לא תואם למיקום או לא תקין. צריך לוודא שה-place_id שהוגדר תואם לאחד מהמזהים שמוחזרים בתשובה SearchGoogleLocations.
LAT_LNG_UPDATES_NOT_PERMITTED לפרויקט הזה אין הרשאה לעדכן את שדה קו הרוחב/האורך במיקום. אפשר לעדכן את הרוחב/הlng באמצעות הפונקציונליות של שחרור הסיכה בממשק המשתמש, או לספק לנו כתובת.
PO_BOX_IN_ADDRESS_NOT_ALLOWED לא ניתן להשתמש בתיבת דואר בכתובת. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
BLOCKED_REGION עקב סנקציות בינלאומיות שאנחנו מחויבים לציית להן, אין לנו אפשרות לקבל עסקים מהאזור הזה. מפתחות של מטא-נתונים כוללים את 'field_maks'.
MISSING_BOTH_PHONE_AND_WEBSITE יש לציין מספר טלפון או אתר לעסקים מסוג CUSTOMER_LOCATION_ONLY. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
MISSING_STOREFRONT_ADDRESS_OR_SAB כל המיקומים חייבים לכלול לפחות כתובת של חנות או אזור שירות. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
LAT_LNG_TOO_FAR_FROM_ADDRESS הצמד של קו הרוחב/קו האורך והכתובת רחוק מדי זה מזה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
LAT_LNG_REQUIRED הוצא משימוש. הוחלף ב-PIN_DROP_REQUIRED. לא ניתן לאתר את הכתובת שצוינה. יש לציין קו רוחב/אורך. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_CHARACTERS נמצאו תווים לא חוקיים. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-'false_characters'.
FORBIDDEN_WORDS נמצאו מילים אסורות. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-forbidden_words.
INVALID_INTERCHANGE_CHARACTERS נמצאו תווים לא חוקיים. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
FIELDS_REQUIRED_FOR_CATEGORY נדרשים שדות נוספים עבור קטגוריית המיקום הזו. מפתחות המטא-נתונים כוללים את 'field_mask', 'value' ו-'fields_required'.
STOREFRONT_REQUIRED_FOR_CATEGORY בקטגוריית העסק שלך צריך למצוא מיקום של חזית עסק שהלקוחות יכולים להגיע אליו. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
ADDRESS_MISSING_REGION_CODE בכתובת חסר אזור_code נדרש. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
ADDRESS_EDIT_CHANGES_COUNTRY לא ניתן להעביר את הכתובת למדינה אחרת. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
SPECIAL_HOURS_SET_WITHOUT_REGULAR_HOURS אפשר לציין שעות פתיחה מיוחדות רק אם למיקום העסק יש שעות פעילות קבועות. המטא-נתונים ריקים.
INVALID_TIME_SCHEDULE לוח הזמנים לא חוקי, שעת ההתחלה החופפת או שעת הסיום מוקדמת משעת ההתחלה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_HOURS_VALUE פורמט או ערך לא חוקיים של שעות. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
OVERLAPPED_SPECIAL_HOURS שעות פתיחה מיוחדות לא יכולות להיות חופפות. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INCOMPATIBLE_MORE_HOURS_TYPE_FOR_CATEGORY הקטגוריה הראשית של העסק שלך לא תומכת בשעות הפעילות האלה. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-'inmatch_hours_type'.
DUPLICATE_CHILDREN_LOCATIONS ילדים כפולים ב-related_data. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INCOMPATIBLE_SERVICE_AREA_AND_CATEGORY עסק שנותן שירות באזור מוגדר לא יכול לכלול את הקטגוריה הראשית הנבחרת. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_SERVICE_AREA_PLACE_ID ערך Place_id לא חוקי ב-service_area. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-place_id.
INVALID_AREA_TYPE_FOR_SERVICE_AREA סוג אזור לא חוקי עבור service_area. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-place_id.
OPENING_DATE_TOO_FAR_IN_THE_FUTURE תאריך הפתיחה צריך להיות בטווח של שנה מהיום. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
OPENING_DATE_MISSING_YEAR_OR_MONTH תאריך הפתיחה צריך לכלול שנה או חודש. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
OPENING_DATE_BEFORE_1AD תאריך הפתיחה לא יכול להיות לפני התאריך הראשון לספירה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
TOO_MANY_ENTRIES הזנת יותר מדי ערכים בשדה. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-max_count.
INVALID_PHONE_NUMBER קלט של מספר טלפון לא מזוהה. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
INVALID_PHONE_NUMBER_FOR_REGION מספר טלפון לא חוקי באזור. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
MISSING_PRIMARY_PHONE_NUMBER חסר מספר טלפון ראשי. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
THROTTLED לא ניתן לעדכן את השדה כרגע. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
UNSUPPORTED_POINT_RADIUS_SERVICE_AREA אין יותר תמיכה באזורי שירות ברדיוס נקודה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_CATEGORY מזהה הקטגוריה לא חוקי. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
CANNOT_REOPEN אי אפשר לפתוח מחדש את העסק. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_BUSINESS_OPENING_DATE תאריך פתיחת העסק לא תקין. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_LATLNG latlng לא חוקי. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
PROFILE_DESCRIPTION_CONTAINS_URL אין לכלול כתובת URL בתיאור העסק. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
LODGING_CANNOT_EDIT_PROFILE_DESCRIPTION לא ניתן לערוך את תיאור הפרופיל של מיקום האירוח. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_URL קישור לא חוקי. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_ADDRESS כתובת לא חוקית. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
PARENT_CHAIN_CANNOT_BE_THE_LOCATION_ITSELF ParentChain לא יכול להיות המיקום עצמו. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
RELATION_CANNOT_BE_THE_LOCATION_ITSELF קשר לא יכול להיות המיקום עצמו. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
MISSING_ADDRESS_COMPONENTS חסר ערך לרכיבי הכתובת. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
READ_ONLY_ADDRESS_COMPONENTS לא ניתן לערוך רכיבי כתובת לקריאה בלבד. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
STRING_TOO_LONG המחרוזת ארוכה מדי. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-'max_length'.
STRING_TOO_SHORT המחרוזת קצרה מדי. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-'min_length'.
REQUIRED_FIELD_MISSING_VALUE חסר ערך בשדה חובה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
ATTRIBUTE_PROVIDER_URL_NOT_ALLOWED אי אפשר להוסיף או לערוך כתובת URL של ספק. מפתחות של מטא-נתונים כוללים את 'attribute_name'.
ATTRIBUTE_INVALID_ENUM_VALUE ערך לא ידוע של המאפיין 'טיפוסים בני מנייה (enum)'. מפתחות של מטא-נתונים כוללים את 'attribute_name'.
ATTRIBUTE_NOT_AVAILABLE המאפיין שניתן להתאמה לא חוקי למיקום הזה. מפתחות של מטא-נתונים כוללים את 'attribute_name'.
ATTRIBUTE_CANNOT_BE_REPEATED מאפיין שניתן להרחבה מצוין פעם אחת בלבד. מפתחות של מטא-נתונים כוללים את 'attribute_name'.
ATTRIBUTE_TYPE_NOT_COMPATIBLE_FOR_CATEGORY המאפיין 'ניתן להתאמה' לא תואם לקטגוריות שהוגדרו במיקום. מפתחות של מטא-נתונים כוללים את 'attribute_name'.
ADDRESS_REMOVAL_NOT_ALLOWED הסרת הכתובת אסורה עבור העסק שלך. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
AMBIGUOUS_TITLE השם הטוב ביותר לא ברור לשפה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_CATEGORY_FOR_SAB SAB טהור לא יכולה להכיל gcids שהם תתי-סוג של gcid:establishment_poi. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
RELATION_ENDPOINTS_TOO_FAR נקודות הקצה של הקשר רחוקות מדי אחת מהשנייה. מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.
INVALID_SERVICE_ITEM לא הוגדרו פריטים מובְנים [structured_service_item] ו-free_form_service_item. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
SERVICE_ITEM_LABEL_NO_DISPLAY_NAME חסר שם מוצג לתווית. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
SERVICE_ITEM_LABEL_DUPLICATE_DISPLAY_NAME השם המוצג לא ייחודי לכל התוויות בכל רשימות המחירים. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
SERVICE_ITEM_LABEL_INVALID_UTF8 התווית מכילה סמלי UTF-8 לא חוקיים. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
FREE_FORM_SERVICE_ITEM_WITH_NO_CATEGORY_ID חסר השדה category_id במאפיין free_form_service_item. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
FREE_FORM_SERVICE_ITEM_WITH_NO_LABEL חסרה תווית ב-free_form_service_item. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
SERVICE_ITEM_WITH_NO_SERVICE_TYPE_ID חסר השדה service_type_id במאפיין structured_service_item. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
INVALID_LANGUAGE קוד השפה לא חוקי. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
PRICE_CURRENCY_MISSING חסר קוד מטבע לפי תקן ISO 4217. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
PRICE_CURRENCY_INVALID קוד המטבע שהזנת לא תקין לפי תקן ISO 4217. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
SERVICE_TYPE_ID_DUPLICATE המזהים של סוגי השירות אינם ייחודיים במיקום. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
PIN_DROP_REQUIRED לא ניתן לאתר את הכתובת שצוינה. יש להשתמש בממשק המשתמש כדי לנעוץ סיכה במפה. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
STALE_DATA Google עדכנה לאחרונה פריט אחד או יותר. רק הבעלים של העסק הזה יכול לבצע שינויים בנתונים שנמצאים ב'שדה' בשלב זה, היכנסו לכתובת business.google.com. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
PHONE_NUMBER_EDITS_NOT_ALLOWED השדה של מספר הטלפון הושבת עבור המיקום הזה, ולא ניתן לערוך אותו. מפתחות של מטא-נתונים כוללים את השדה 'field_mask'.
MULTIPLE_ORGANIZATIONALLY_PART_OF_RELATION יש יותר ממערכת יחסים אחת שמשמשת כמודל של הקשר הלוגי בין שני מיקומים (למשל, עיוות, מיקום). מפתחות המטא-נתונים כוללים את השדה 'field_mask' ו-value.

GetAttributesRequest

בקשה לקבלת AttributesService.GetAttributes.

שדות
name

string

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

GetChainRequest

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

שדות
name

string

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

GetGoogleUpdatedAttributesRequest

בקשה לקבלת AttributesService.GetGoogleUpdatedAttributes.

שדות
name

string

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

GetGoogleUpdatedLocationRequest

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

שדות
name

string

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

read_mask

FieldMask

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

GetLocationRequest

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

שדות
name

string

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

read_mask

FieldMask

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

GoogleLocation

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

שדות
name

string

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

location

Location

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

request_admin_rights_uri

string

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

GoogleUpdatedLocation

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

שדות
location

Location

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

diff_mask

FieldMask

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

pending_mask

FieldMask

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

תווית

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

שדות
display_name

string

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

description

string

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

language_code

string

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

ListAttributeMetadataRequest

בקשה לקבלת AttributesService.ListAttributeMetadata.

שדות
parent

string

שם המשאב של המיקום לחיפוש מאפיינים זמינים. אם השדה הזה מוגדר, השדות category_name, region_code, language_code ו-show_all הם לא שדות חובה ואין להגדיר אותם.

category_name

string

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

region_code

string

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

language_code

string

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

show_all

bool

כאשר השדה הזה מוגדר כ-True, המטא-נתונים של כל המאפיינים הזמינים מוחזרים, ללא התייחסות לשדות ההורה ו-category_name. כשהערך של show_all מוגדר כ-True, נדרשים נתוני language_code ו-region_code.

page_size

int32

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

page_token

string

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

ListAttributeMetadataResponse

התשובה ל-AttributesService.ListAttributeMetadata.

שדות
attribute_metadata[]

AttributeMetadata

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

next_page_token

string

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

ListCategoriesRequest

הודעת בקשה לגבי BusinessCategory.ListCategory.

שדות
region_code

string

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

language_code

string

חובה. קוד השפה של BCP 47.

filter

string

זה שינוי אופציונלי. סינון מחרוזת מהמשתמש. השדה היחיד שנתמך הוא displayName. לדוגמה: filter=displayName=foo.

page_size

int32

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

page_token

string

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

view

CategoryView

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

ListCategoriesResponse

הודעת תגובה בנושא BusinessCategory.ListCategory.

שדות
categories[]

Category

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

next_page_token

string

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

ListLocationsRequest

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

שדות
parent

string

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

page_size

int32

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

page_token

string

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

filter

string

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

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

order_by

string

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

read_mask

FieldMask

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

ListLocationsResponse

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

שדות
locations[]

Location

המיקומים.

next_page_token

string

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

total_size

int32

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

מיקום

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

שדות
name

string

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

language_code

string

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

store_code

string

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

title

string

חובה. שם המיקום צריך לשקף את השם של העסק בעולם האמיתי, כפי שהוא מוצג באופן עקבי בחזית החנות, באתר ובנייר המכתבים של העסק, וכפי שהוא מוכר ללקוחות. מידע נוסף, במקרים הרלוונטיים, ייכלל בשדות אחרים של המשאב (לדוגמה, Address, Categories). אל תוסיף מידע מיותר לשם שלך (לדוגמה, עדיף להשתמש במילה "Google" על פני "Google Inc. - Mountain View Corporate Headquarters"). אין לכלול תיאורים שיווקיים, קודי חנויות, תווים מיוחדים, שעות פעילות או סטטוס פתיחה/סגירה, מספרי טלפון, כתובות של אתרים, פרטי שירות/מוצר, מיקום/כתובת או מסלול הגעה, או מידע על מקום מארח (לדוגמה: "Chase ATM in Duane Reade").

phone_numbers

PhoneNumbers

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

categories

Categories

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

storefront_address

PostalAddress

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

website_uri

string

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

regular_hours

BusinessHours

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

special_hours

SpecialHours

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

service_area

ServiceAreaBusiness

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

labels[]

string

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

ad_words_location_extensions

AdWordsLocationExtensions

זה שינוי אופציונלי. מידע נוסף שמוצג ב-AdWords.

latlng

LatLng

זה שינוי אופציונלי. קו רוחב וקו אורך שסופקו על ידי המשתמש. כשיוצרים מיקום, המערכת מתעלמת מהשדה הזה אם הכתובת שסופקה קואורדינטות (geocoding) בהצלחה. השדה הזה מוחזר בבקשות רק אם הערך של latlng שסופק על ידי המשתמש התקבל במהלך היצירה, או אם הערך של latlng עודכן דרך האתר של 'פרופיל העסק ב-Google'. רק לקוחות שאושרו יכולים לעדכן את השדה הזה.

open_info

OpenInfo

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

metadata

Metadata

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

profile

Profile

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

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

relationship_data

RelationshipData

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

more_hours[]

MoreHours

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

service_items[]

ServiceItem

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

מטא-נתונים

מידע נוסף על המיקום שהמשתמשים לא יכולים לערוך.

שדות
has_google_updated

bool

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

has_pending_edits

bool

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

can_delete

bool

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

can_operate_local_post

bool

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

can_modify_service_list

bool

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

can_have_food_menus

bool

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

can_operate_health_data

bool

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

can_operate_lodging_data

bool

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

place_id

string

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

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

duplicate_location

string

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

maps_uri

string

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

new_review_uri

string

פלט בלבד. קישור לדף בחיפוש Google שבו לקוח יכול לכתוב ביקורת על המיקום.

can_have_business_calls

bool

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

has_voice_of_merchant

bool

פלט בלבד. שדה זה מציין אם קיים בדף האפליקציה Voice of Merchant. אם ערך בוליאני זה אינו נכון, יש להפעיל את locations.getVoiceOfMerchantState API כדי לקבל פרטים על הסיבה לכך שאין בהם Voice of Merchant.

MoreHours

התקופות שבמהלכן המיקום פתוח לסוגים מסוימים של עסקים.

שדות
hours_type_id

string

חובה. סוג השעות. על הלקוחות להתקשר אל {#link business categories:BatchGet} כדי לקבל את סוגי השעות הנתמכות בקטגוריות של המיקומים שלהם.

periods[]

TimePeriod

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

MoreHoursType

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

שדות
hours_type_id

string

פלט בלבד. מזהה קבוע ש-Google סיפקה לשעות מהסוג הזה.

display_name

string

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

localized_display_name

string

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

OpenInfo

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

שדות
status

OpenForBusiness

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

can_reopen

bool

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

opening_date

Date

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

OpenForBusiness

סטטוס של מיקום.

טיפוסים בני מנייה (enum)
OPEN_FOR_BUSINESS_UNSPECIFIED לא צוין.
OPEN מציין שהמיקום פתוח.
CLOSED_PERMANENTLY מציין שהמיקום נסגר לצמיתות.
CLOSED_TEMPORARILY מציין שהמיקום נסגר באופן זמני.

PhoneNumbers

אוסף של מספרי טלפון של העסק. במהלך העדכון, צריך להגדיר את שני השדות. לקוחות לא יכולים לעדכן רק את מספרי הטלפון הראשיים או נוספים באמצעות מסיכת העדכון. עדיף להשתמש בפורמט לחיוג בינלאומי, למשל +1 415 555 0132. מידע נוסף זמין בכתובת (https://developers.google.com/style/phone-numbers#international-phone-numbers).

שדות
primary_phone

string

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

additional_phones[]

string

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

PlaceInfo

מגדיר אזור שמיוצג על ידי מזהה מקום.

שדות
place_name

string

חובה. השם המותאם לשוק המקומי. לדוגמה, Scottsdale, AZ.

place_id

string

חובה. המזהה של המקום. חייב להתאים לאזור. (https://developers.google.com/places/web-service/supported_types#table3)

מקומות

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

שדות
place_infos[]

PlaceInfo

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

פרופיל

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

שדות
description

string

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

RelationshipData

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

שדות
parent_location

RelevantLocation

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

children_locations[]

RelevantLocation

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

parent_chain

string

שם המשאב בשרשרת שאליה משויך המיקום הזה. [איך למצוא מזהה רשת] [Locations.SearchChains]

RelevantLocation

מידע על מיקום אחר שקשור למיקום הנוכחי. הקשר יכול להיות כל אחד מהצדדים DEPARTMENT_OF או INDEPENDENT_ESTABLISHMENT_OF, והמיקום שצוין כאן יכול להיות בכל אחד מהצדדים (הורה/צאצא) של המיקום.

שדות
place_id

string

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

relation_type

RelationType

חובה. סוג הקשר.

RelationType

היחסים בין סוגי הסוגים שיש לציין.

טיפוסים בני מנייה (enum)
RELATION_TYPE_UNSPECIFIED סוג לא צוין.
DEPARTMENT_OF הנתון הזה מייצג קשר בין שני מיקומים שחולקים אזור פיזי אחד, אותו מותג/ניהול בכיר/ארגון, אבל עם מאפיינים מרכזיים שונים כמו שעות הפעילות של החנות או מספרי טלפון. לדוגמה, Costco Pharmacy היא מחלקה ב-Costco סיטונאי.
INDEPENDENT_ESTABLISHMENT_IN נתון זה מייצג מקרים שבהם שני מיקומים נמצאים במשותף באותו מיקום פיזי, אך מחברות שונות (למשל, Starbucks בתל אביב, חנויות בקניון).

RepeatedEnumAttributeValue

ערכי מאפיין עם value_type של REPEATED_ENUM. המערכת מורכבת משתי רשימות של מזהים של ערכים: אלו שמוגדרים (true) ומזהים לא מוגדרים (false). ערכים שחסרים נחשבים לא ידועים. יש לציין לפחות ערך אחד.

שדות
set_values[]

string

ערכי ה-Enum שהוגדרו.

unset_values[]

string

ערכים של מספרים שלא הוגדרו.

SearchChainsRequest

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

שדות
chain_name

string

חובה. מחפשים רשת לפי השם שלה. יש תמיכה בשאילתות מדויקות/חלקיות/מטושטשות או קשורות. דוגמאות: "walmart" , "wal-mart" , "walmmmart" , "沃尔玛"

page_size

int32

המספר המקסימלי של שרשראות תואמות שצריך להחזיר מהשאילתה הזו. ערך ברירת המחדל הוא 10. הערך המקסימלי האפשרי הוא 500.

SearchChainsResponse

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

שדות
chains[]

Chain

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

SearchGoogleLocationsRequest

הודעת בקשה עבור GoogleLocations.SearchGoogleLocations.

שדות
page_size

int32

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

שדה איחוד search_query. שאילתת חיפוש. אפשר לספק אותו כאובייקט מיקום או כשאילתת מחרוזת. search_query יכול להיות רק אחת מהאפשרויות הבאות:
location

Location

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

query

string

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

SearchGoogleLocationsResponse

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

שדות
google_locations[]

GoogleLocation

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

ServiceAreaBusiness

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

שדות
business_type

BusinessType

חובה. מציין את ה[סוג] [google.mybusiness.businessinfo.v1.ServiceAreaBusiness.BusinessType] של העסק שנותן שירות באזור מוגדר (SAB).

places

Places

האזור שבו העסק הזה פועל מוגדר באמצעות קבוצה של מקומות.

region_code

string

בלתי ניתן לשינוי. קוד האזור במאגר CLDR של המדינה או האזור שבהם נמצא העסק עם אזור שירות. פרטים נוספים זמינים בכתובת http://cldr.unicode.org/ ובכתובת http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. דוגמה: 'CH' עבור שווייץ.

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

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

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

BusinessType

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

טיפוסים בני מנייה (enum)
BUSINESS_TYPE_UNSPECIFIED פלט בלבד. לא צוין.
CUSTOMER_LOCATION_ONLY העסק מציע שירות רק באזור שמסביב (לא בכתובת העסק). אם עסק מתעדכן מ-CUSTOMER_AND_BUSINESS_LOCATION ל-CUSTOMER_LOCATION_ONLY, עדכון המיקום חייב לכלול את מסכת השדות storefront_address ולהגדיר את השדה כריק.
CUSTOMER_AND_BUSINESS_LOCATION מציע שירות בכתובת העסק ובאזור שמסביב.

ServiceItem

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

שדות
price

Money

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

שדה איחוד service_item_info. צריך תמיד להגדיר אחד מהשדות הבאים. service_item_info יכול להיות רק אחת מהאפשרויות הבאות:
structured_service_item

StructuredServiceItem

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

free_form_service_item

FreeFormServiceItem

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

FreeFormServiceItem

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

שדות
category

string

חובה. השדה הזה מייצג את שם הקטגוריה (כלומר, המזהה היציב של הקטגוריה). category ו-service_type_id צריכים להתאים לשילובים האפשריים שצוינו בהודעה Category.

label

Label

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

StructuredServiceItem

מייצג שירות מובנה שמוצע על ידי המוכר. לדוגמה: toilet_installation.

שדות
service_type_id

string

חובה. השדה service_type_id הוא מזהה ייחודי ש-Google סיפקה ונמצאים ב-ServiceType. המידע הזה סופק על ידי שירות rpc של BatchGetCategories.

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

TimeOfDay

זה שינוי אופציונלי. הערכים החוקיים הם 00:00-24:00 כאשר השעה 24:00 מייצגת חצות בסוף שדה היום שצוין. יש לציין אם הערך של closed הוא False.

end_date

Date

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

close_time

TimeOfDay

זה שינוי אופציונלי. הערכים החוקיים הם 00:00-24:00. השעה 24:00 מייצגת את חצות בסוף שדה היום שצוין. יש לציין אם הערך של closed הוא False.

closed

bool

זה שינוי אופציונלי. אם הערך הוא True, המערכת מתעלמת מ-end_date, מ-open_time ומ-close_time, והתאריך שצוין ב-start_date נחשב כסגור למשך כל היום.

SpecialHours

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

שדות
special_hour_periods[]

SpecialHourPeriod

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

TimePeriod

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

שדות
open_day

DayOfWeek

חובה. מציין את day of the week שהתקופה הזו מתחילה.

open_time

TimeOfDay

חובה. הערכים החוקיים הם 00:00-24:00. השעה 24:00 מייצגת את חצות בסוף שדה היום שצוין.

close_day

DayOfWeek

חובה. מציין את day of the week שהתקופה הזו מסתיימת.

close_time

TimeOfDay

חובה. הערכים החוקיים הם 00:00-24:00. השעה 24:00 מייצגת את חצות בסוף שדה היום שצוין.

UpdateAttributesRequest

בקשה לקבלת AttributesService.UpdateAttributes.

שדות
attributes

Attributes

אוסף של מאפיינים שצריך לעדכן.

attribute_mask

FieldMask

חובה. שם המאפיין של מאפיינים שרוצים לעדכן. מיוצג על ידי attributes/{attribute}.

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

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

UpdateLocationRequest

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

שדות
location

Location

חובה. פרטי המיקום המעודכנים.

update_mask

FieldMask

חובה. השדות הספציפיים שצריך לעדכן.

validate_only

bool

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

UriAttributeValue

ערכי מאפיין עם value_type של כתובת URL.

שדות
uri

string

חובה. ערך ה-URI המוצע למאפיין הזה.