REST Resource: accounts

משאב: חשבון

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

ייצוג JSON 
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
שדות
name

string

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

string

חובה. שם החשבון. עבור חשבון מסוג PERSONAL, זהו השם הפרטי ושם המשפחה של חשבון המשתמש.
primaryOwner

string

חובה. קלט בלבד. שם המשאב של החשבון, שיהיה הבעלים הראשי של החשבון שנוצר. הוא צריך להיות בפורמט accounts/{account_id}.
type

enum (AccountType)

חובה. מכיל את סוג החשבון. לא ניתן ליצור חשבונות מסוג PERSONAL ו-ORGANIZATION באמצעות ה-API הזה.
role

enum (AccountRole)

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

enum (VerificationState)

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

enum (VettedState)

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

string

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

enum (PermissionLevel)

פלט בלבד. ההגדרה הזאת קובעת את רמת ההרשאה של המשתמש בחשבון הזה.
organizationInfo

object (OrganizationInfo)

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

AccountType

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

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

AccountRole

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

טיפוסים בני מנייה (enums)
ACCOUNT_ROLE_UNSPECIFIED לא צוין.
PRIMARY_OWNER המשתמש הוא הבעלים הראשי של החשבון הזה.
OWNER הבעלים של החשבון.
MANAGER המשתמש יכול לנהל את החשבון הזה.
SITE_MANAGER המשתמש יכול לנהל קבוצה מוגבלת של תכונות בחשבון.

VerificationState

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

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

VettedState

מציין את מצב החשבון שנבדק.

טיפוסים בני מנייה (enums)
VETTED_STATE_UNSPECIFIED לא צוינה
NOT_VETTED החשבון לא נבדק על ידי Google.
VETTED החשבון נבדק על ידי Google ונמצא במצב תקין. החשבון נבדק באופן אוטומטי אם יש לו גישה ישירה לחשבון קבוצתי שנבדק.
INVALID החשבון נבדק אבל הסטטוס שלו לא תקין. החשבון יפעל כמו חשבון שלא נבדק.

PermissionLevel

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

טיפוסים בני מנייה (enums)
PERMISSION_LEVEL_UNSPECIFIED לא צוין.
OWNER_LEVEL למשתמש יש הרשאה ברמת בעלים.
MEMBER_LEVEL למשתמש יש הרשאה ברמת 'חבר'.

OrganizationInfo

מידע נוסף המאוחסן עבור ארגון.

ייצוג JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
שדות
registeredDomain

string

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

object (PostalAddress)

פלט בלבד. הכתובת למשלוח דואר שמשויכת לחשבון.
phoneNumber

string

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

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

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

string

אפשרות. מיקום המשנה של הכתובת. לדוגמה: שכונות, רובעים או מחוזות.
addressLines[]

string

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

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

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

הדרך המומלצת לטיפול בכתובות לא מובנות לחלוטין היא יצירת כתובת הכוללת קוד regionCode ו-addressLines בלבד ולאחר מכן קידוד גיאוגרפי (בניגוד לנחש אילו חלקים של הכתובת צריכים להיות רשויות מקומיות או אזורים מנהליים).
recipients[]

string

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

string

אפשרות. שם הארגון בכתובת.

שיטות

create

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

get

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

list

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

patch

 עדכון החשבון העסקי שצוין.