REST Resource: accounts.businessInfo

משאב: BusinessInfo

ההודעה BusinessInfo מכילה מידע חיוני על העסק של המוכר.

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

ייצוג ב-JSON
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
שדות
name

string

מזהה. שם המשאב של פרטי העסק. הפורמט: accounts/{account}/businessInfo

address

object (PostalAddress)

זה שינוי אופציונלי. הכתובת של העסק. רק השדות regionCode, ‏ addressLines, ‏ postalCode, ‏ administrativeArea ו-locality נתמכים. המערכת תתעלם משאר השדות.

phone

object (PhoneNumber)

פלט בלבד. מספר הטלפון של העסק.

phoneVerificationState

enum (PhoneVerificationState)

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

customerService

object (CustomerService)

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

koreanBusinessRegistrationNumber

string

זה שינוי אופציונלי. מספר הרישום לעסק בקוריאה בן 10 הספרות, מופרד בקו מפריד בפורמט: XXX-XX-XXXXX.

PostalAddress

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

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

עצות לגבי הזנת כתובת או עריכתה: - יש להשתמש בווידג'ט כתובות מוכן לשימוש בינלאומי, כמו https://github.com/google/libaddressinput. - אסור להציג למשתמשים רכיבי ממשק משתמש להזנה או לעריכה של שדות מחוץ למדינות שבהן השדה הזה נמצא בשימוש.

הנחיות נוספות לשימוש בסכימה הזו זמינות בכתובת: https://support.google.com/business/answer/6397478

ייצוג ב-JSON
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
שדות
revision

integer

גרסת הסכימה של PostalAddress. צריך להגדיר את הערך הזה כ-0, שהוא הגרסה האחרונה.

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

regionCode

string

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

languageCode

string

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

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

דוגמאות: 'zh-Hant',‏ 'ja',‏ 'ja-Latn',‏ 'en'.

postalCode

string

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

sortingCode

string

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

administrativeArea

string

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

locality

string

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

sublocality

string

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

addressLines[]

string

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

מכיוון שלערכים בשדה addressLines אין פרטי סוג, ולפעמים הם מכילים כמה ערכים בשדה אחד (לדוגמה, 'Austin, TX'), חשוב שהסדר של השורות יהיה ברור. סדר שורות הכתובת צריך להיות 'סדר מעטפה' עבור המדינה או האזור של הכתובת. במקומות שבהם הדבר עשוי להשתנות (לדוגמה, יפן), השדה address_language משמש כדי לציין זאת בבירור (לדוגמה, 'ja' לסדר מגדול לקטן ו-'ja-Latn' או 'en' לסדר מקטן לגדול). כך ניתן לבחור את השורה הספציפית ביותר של הכתובת על סמך השפה.

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

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

recipients[]

string

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

organization

string

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

מספר טלפון

אובייקט שמייצג מספר טלפון, מתאים כפורמט של API.

הייצוג הזה:

  • לא צריך להשתמש בהם לפורמט ספציפי לאזור גיאוגרפי של מספר טלפון, למשל ‎+1 (650) 253-0000 ext. 123

  • לא מיועדת לאחסון יעיל

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

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

לדוגמה, ב-Java זה ייראה כך:

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

מקורות מידע: - https://github.com/google/libphonenumber

ייצוג ב-JSON
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
שדות
extension

string

התוסף של מספר הטלפון. התוסף לא סטנדרטי בהמלצות של ITU, מלבד ההגדרה שלו כסדרה של מספרים באורך מקסימלי של 40 ספרות. בנוסף לספרות, יכול להיות שיהיו כאן גם תווים אחרים של חיוג, כמו ',' (המתנה) או '#'.

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

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

string

מספר הטלפון, שמוצג כסימן פלוס ('+') בתחילת המספר, ואחריו מספר טלפון בפורמט משוחרר של ITU E.164, שכולל את קוד החיוג של המדינה (1 עד 3 ספרות) ומספר המנוי, ללא רווחים או עיצוב נוספים. לדוגמה: - נכון: ‎+15552220123‎ - שגוי: ‎+1 (555) 222-01234 x123‎.

פורמט E.164 של ITU מגביל את מספר הטלפון ל-12 ספרות, אבל בפועל לא כל המדינות פועלות לפי ההגבלה הזו, ולכן אנחנו מרחיבים את ההגבלה הזו כאן. אסור להשתמש במספרים לאומיים בלבד.

מקורות: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes

shortCode

object (ShortCode)

מספר מקוצר.

מקורות מידע: - https://en.wikipedia.org/wiki/Short_code

ShortCode

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

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

ייצוג ב-JSON
{
  "regionCode": string,
  "number": string
}
שדות
regionCode

string

חובה. קוד האזור מסוג BCP-47 של המיקום שבו אפשר להתקשר למספר המקוצר הזה, למשל 'US' ו-'BB'.

מקורות מידע: - http://www.unicode.org/reports/tr35/#unicode_region_subtag

number

string

חובה. הספרות של הקוד המקוצר, ללא סימן פלוס ('+') בהתחלה או קוד מדינה. לדוגמה, '611'.

PhoneVerificationState

סטטוס האימות הטלפוני.

טיפוסים בני מנייה (enum)
PHONE_VERIFICATION_STATE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
PHONE_VERIFICATION_STATE_VERIFIED הטלפון מאומת.
PHONE_VERIFICATION_STATE_UNVERIFIED הטלפון לא מאומת

CustomerService

פרטי שירות הלקוחות.

ייצוג ב-JSON
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
שדות
uri

string

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

email

string

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

phone

object (PhoneNumber)

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

Methods

getBusinessInfo

אחזור פרטי העסק של חשבון.

updateBusinessInfo

עדכון פרטי העסק בחשבון.