Package google.mybusiness.accountmanagement.v1

אינדקס

AccessControl

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

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

הזמנה של המשתמש שצוין להפוך לאדמין של החשבון שצוין. המוזמן חייב לאשר את ההזמנה כדי לקבל גישה לחשבון. כדי לאשר הזמנות באופן פרוגרמטי אפשר להיכנס לדף [AcceptInvite] [google.mybusiness.accountmanagement.v1.AcceptInvite].

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

הזמנה של המשתמש שצוין להפוך לאדמין במיקום שצוין. המוזמן חייב לאשר את ההזמנה כדי לקבל גישה למיקום. כדי לאשר הזמנה באופן פרוגרמטי, אפשר להיכנס לדף [AcceptInvite] [google.mybusiness.accountmangement.v1.AcceptOrder].

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

עדכון האדמין עבור האדמין בחשבון שצוין.

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

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

היקפי הרשאות

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

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

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

חשבונות

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

  • ה-API כולל אוסף של משאבי חשבון שנקרא accounts/*.

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

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

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

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

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

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

היקפי הרשאות

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

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

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

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

היקפי הרשאות

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

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

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

AcceptInvitationRequest

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

שדות
name

string

חובה. שם ההזמנה שהתקבלה. accounts/{account_id}/invitations/{invitation_id}

חשבון

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

שדות
name

string

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

string

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

string

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

AccountType

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

AccountRole

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

VerificationState

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

VettedState

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

string

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

PermissionLevel

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

OrganizationInfo

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

AccountRole

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

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

AccountType

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

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

OrganizationInfo

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

שדות
registered_domain

string

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

PostalAddress

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

string

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

PermissionLevel

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

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

VerificationState

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

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

VettedState

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

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

אדמין

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

שדות
name

string

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

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

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

string

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

צריך להגדיר את השדה הזה רק במהלך יצירת אדמין.
account

string

לא משתנה. השם של משאב החשבון שהאדמין הזה מתייחס אליו. משמש כשמתקשרים אל locations.admins.create כדי להזמין קבוצת מיקומים כאדמין.

אם השדה הזה וגם admin מוגדרים בבקשות CREATE, השדה הזה יקבל עדיפות ותתעלם מכתובת האימייל ב-admin.

פורמט: accounts/{account}.
role

AdminRole

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

bool

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

AdminRole

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

טיפוסים בני מנייה (enums)
ADMIN_ROLE_UNSPECIFIED לא צוין.
PRIMARY_OWNER לאדמין יש גישה ברמת בעלים והוא הבעלים הראשי. (מוצג כ 'בעלים ראשי' בממשק המשתמש).
OWNER לאדמין יש גישה ברמת בעלים. (מוצג כ 'בעלים' בממשק המשתמש).
MANAGER לאדמין יש הרשאת גישה ניהולית.
SITE_MANAGER המנהל יכול לנהל דפים של רשתות חברתיות (+Google). (מוצג כ 'מנהל אתר' בממשק המשתמש). ממשק ה-API הזה לא מאפשר ליצור מנהל חשבון עם תפקיד SITE_manager.

CreateAccountAdminRequest

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

שדות
parent

string

חובה. שם המשאב של החשבון שעבורו נוצר האדמין. accounts/{account_id}.
admin

Admin

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

CreateAccountRequest

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

שדות
account

Account

חובה. פרטי החשבון שרוצים ליצור. השדות המותרים היחידים הם 'חשבון' ו'סוג'.

CreateLocationAdminRequest

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

שדות
parent

string

חובה. שם המשאב של המיקום שעבורו נוצר האדמין. locations/{location_id}/admins.
admin

Admin

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

DeclineInvitationRequest

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

שדות
name

string

חובה. שם ההזמנה לחשבון שנדחתה. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

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

שדות
name

string

חובה. שם המשאב של האדמין שיש להסיר מהחשבון. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

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

שדות
name

string

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

GetAccountRequest

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

שדות
name

string

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

הזמנה

מייצג הזמנה בהמתנה.

שדות
name

string

חובה. שם המשאב של ההזמנה. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

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

TargetType

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

Account

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

TargetLocation

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

TargetLocation

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

שדות
location_name

string

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

string

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

TargetType

סוג היעד שאליו מיועדת ההזמנה.

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

ListAccountAdminsRequest

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

שדות
parent

string

חובה. שם החשבון שממנו יש לאחזר רשימת אדמינים. accounts/{account_id}/admins.

ListAccountAdminsResponse

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

שדות
account_admins[]

Admin

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

ListAccountsRequest

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

שדות
parent_account

string

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

int32

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

string

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

string

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

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

השדה type הוא המסנן הנתמך היחיד.

ListAccountsResponse

הודעת תגובה עבור Accounts.ListAccounts.

שדות
accounts[]

Account

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

string

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

ListInvitationsRequest

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

שדות
parent

string

חובה. שם החשבון שממנו מאוחזרת רשימת ההזמנות. accounts/{account_id}/invitations
filter

string

אפשרות. אפשר לסנן את התשובה באמצעות השדה Invite.target_type.

ListInvitationsResponse

הודעת תגובה ל-AccessControl.ListInvites.

שדות
invitations[]

Invitation

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

ListLocationAdminsRequest

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

שדות
parent

string

חובה. שם המיקום לרשימת האדמינים. locations/{location_id}/admins.

ListLocationAdminsResponse

הודעת תגובה ל-AccessControl.ListLocationAdmins.

שדות
admins[]

Admin

אוסף של אדמינים.

TransferLocationRequest

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

שדות
name

string

חובה. שם המיקום שרוצים להעביר. locations/{location_id}.
destination_account

string

חובה. השם של משאב החשבון שאליו רוצים להעביר את המיקום (לדוגמה, 'accounts/{account}').

UpdateAccountAdminRequest

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

שדות
account_admin

Admin

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

FieldMask

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

UpdateAccountRequest

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

שדות
account

Account

חובה. החשבון המעודכן.
update_mask

FieldMask

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

bool

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

UpdateLocationAdminRequest

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

שדות
location_admin

Admin

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

FieldMask

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