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 ו-Org באמצעות ה-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

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

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

AccountRole

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

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

VerificationState

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

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

VettedState

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

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

PermissionLevel

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

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

OrganizationInfo

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

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

string

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

object (PostalAddress)

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

string

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

PostalAddress

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

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

עצות לגבי קלט / עריכה של כתובת: - השתמשו בווידג'ט כתובת שמוכן ללוקליזציה כמו 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, עיר דואר בבריטניה. באזורים בעולם שבהם רשויות מוניציפאליות לא מוגדרות היטב או שלא מתאימות למבנה הזה בצורה טובה, השאירו את הרשות המוניציפאלית ריקה והשתמשו בקווי כתובת.
sublocality

string

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

string

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

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

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

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

string

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

string

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

שיטות

create

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

get

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

list

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

patch

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