Package google.mybusiness.accountmanagement.v1

索引

• AccessControl (介面)
• Accounts (介面)
• AcceptInvitationRequest (訊息)
• Account (訊息)
• Account.AccountRole (列舉)
• Account.AccountType (列舉)
• Account.OrganizationInfo (訊息)
• Account.PermissionLevel (列舉)
• Account.VerificationState (列舉)
• Account.VettedState (列舉)
• Admin (訊息)
• Admin.AdminRole (列舉)
• CreateAccountAdminRequest (訊息)
• CreateAccountRequest (訊息)
• CreateLocationAdminRequest (訊息)
• DeclineInvitationRequest (訊息)
• DeleteAccountAdminRequest (訊息)
• DeleteLocationAdminRequest (訊息)
• GetAccountRequest (訊息)
• Invitation (訊息)
• Invitation.TargetLocation (訊息)
• Invitation.TargetType (列舉)
• ListAccountAdminsRequest (訊息)
• ListAccountAdminsResponse (訊息)
• ListAccountsRequest (訊息)
• ListAccountsResponse (訊息)
• ListInvitationsRequest (訊息)
• ListInvitationsResponse (訊息)
• ListLocationAdminsRequest (訊息)
• ListLocationAdminsResponse (訊息)
• TransferLocationRequest (訊息)
• UpdateAccountAdminRequest (訊息)
• UpdateAccountRequest (訊息)
• UpdateLocationAdminRequest (訊息)

AccessControl

這項服務可讓您管理有權存取帳戶和地點的使用者。

AcceptInvitation
rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty) 接受指定的邀請。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/business.manage 詳情請參閱 OAuth 2.0 總覽。

CreateAccountAdmin
rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin) 邀請指定使用者成為指定帳戶的管理員。邀請對象必須接受邀請，才能獲得帳戶存取權。如要透過程式輔助方式接受邀請，請參閱 [Accept 邀請] [google.mybusiness.accountmanagement.v1.AcceptInvite] 以便透過程式輔助方式接受邀請。 授權範圍 需要下列 OAuth 範圍： https://www.googleapis.com/auth/business.manage 詳情請參閱 OAuth 2.0 總覽。

CreateLocationAdmin
rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin) 邀請指定使用者成為指定位置的管理員。邀請對象必須接受邀請，才能取得該地點的存取權。如要以程式輔助方式接受邀請，請參閱 [Accept 邀請] [google.mybusiness.accountmangement.v1.Accept 邀請]。 授權範圍 需要下列 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/* 的帳戶資源。

• 為方便起見，您可以在已驗證呼叫端的個人帳戶中使用「me」同義詞，而非帳戶 ID。範例：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.Accept 邀請 的訊息。

欄位
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 必要欄位。包含帳戶類型。無法使用這個 API 建立 PERSONAL 和 Organization 類型的帳戶。
role	AccountRole 僅供輸出。指定這個帳戶的 AccountRole。
verification_state	VerificationState 僅供輸出。通過驗證後，日後建立的地點就會自動連結至 Google 地圖，而 Google+ 專頁不需經過審核即可建立。
vetted_state	VettedState 僅供輸出。表示帳戶是否已經過 Google 審查。已通過審查的帳戶可以透過 VETTED_PARTNER 方法驗證地點。
account_number	string 僅供輸出。帳戶參考號碼 (如有提供)。
permission_level	PermissionLevel 僅供輸出。指定使用者對這個帳戶的權限層級。
organization_info	OrganizationInfo 僅供輸出。機構的其他資訊。系統只會為機構帳戶填入這項資訊。

AccountRole

指出已驗證使用者對這個帳戶的存取層級。詳情請參閱說明中心文章。

列舉
ACCOUNT_ROLE_UNSPECIFIED	未指定。
PRIMARY_OWNER	這位使用者是這個帳戶的主要擁有者。
OWNER	帳戶的使用者擁有者。
MANAGER	使用者可以管理這個帳戶。
SITE_MANAGER	使用者可以管理帳戶的部分功能組合，

AccountType

表示屬於個人/使用者帳戶或企業帳戶。

列舉
ACCOUNT_TYPE_UNSPECIFIED	未指定。
PERSONAL	使用者帳戶。
LOCATION_GROUP	一組地點。詳情請參閱說明中心文章。
USER_GROUP	使用者群組，用於將機構員工區隔成不同群組。詳情請參閱說明中心文章。
ORGANIZATION	代表公司的機構。詳情請參閱說明中心文章。

OrganizationInfo

為機構儲存的其他資訊。

欄位
registered_domain	string 僅供輸出。帳戶的註冊網域。
address	PostalAddress 僅供輸出。帳戶的郵寄地址。
phone_number	string 僅供輸出。機構聯絡電話。

PermissionLevel

指出已驗證使用者對這個帳戶的存取層級。

列舉
PERMISSION_LEVEL_UNSPECIFIED	未指定。
OWNER_LEVEL	使用者俱備擁有者層級權限。
MEMBER_LEVEL	使用者擁有成員層級權限。

VerificationState

表示帳戶的驗證狀態。

列舉
VERIFICATION_STATE_UNSPECIFIED	未指定。
VERIFIED	已驗證帳戶。
UNVERIFIED	帳戶未經驗證，也未提出驗證要求。
VERIFICATION_REQUESTED	帳戶尚未驗證，但已提出驗證要求。

VettedState

表示帳戶的審核狀態。

列舉
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 無法變更。「管理員」參照的「帳戶」資源名稱。用於呼叫 location.admins.create 以邀請 LocationGroup 成為管理員。 若在 CREATE 要求中同時設定這個欄位和 admin，系統會優先採用這個欄位，忽略 admin 中的電子郵件地址。 格式：accounts/{account}。
role	AdminRole 必要欄位。指定這位管理員搭配指定的「帳戶或位置」角色。
pending_invitation	bool 僅供輸出。表示這位管理員是否有指定資源的待處理邀請。

AdminRole

表示管理員擁有的存取層級。詳情請參閱說明中心文章。

列舉
ADMIN_ROLE_UNSPECIFIED	未指定。
PRIMARY_OWNER	管理員有擁有者層級存取權，同時也是主要擁有者。(在 UI 中顯示為「主要擁有者」)。
OWNER	管理員有擁有者層級存取權。(UI 中會顯示為「Owner」)。
MANAGER	管理員有管理員存取權。
SITE_MANAGER	可管理社交 (Google+) 專頁。(在使用者介面中顯示為「Site Manager」)。這個 API 不允許建立具有 SITE_MANAGER 角色的帳戶管理員。

CreateAccountAdminRequest

要求 AccessControl.CreateAccountAdmin 的訊息。

欄位
parent	string 必要欄位。管理員所建立帳戶的資源名稱。accounts/{account_id}.
admin	Admin 必要欄位。要建立的管理員。角色不得為 SITE_MANAGER

CreateAccountRequest

Account.CreateAccount 的要求訊息。

欄位
account	Account 必要欄位。要建立的帳戶帳戶資訊。唯一的可用欄位是帳戶和類型。

CreateLocationAdminRequest

要求 AccessControl.CreateLocationAdmin 的訊息。

欄位
parent	string 必要欄位。為管理員建立的位置資源名稱。locations/{location_id}/admins.
admin	Admin 必要欄位。待建立的管理員。

DeclineInvitationRequest

要求 AccessControl.拒絕邀請的訊息。

欄位
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

Account.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

邀請適用的目標類型。

列舉
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 選用設定。指定後，系統會擷取帳戶的下一頁。如果呼叫 accounts.list 傳回的結果超過要求的頁面大小，就會傳回 pageToken。
filter	string 選用設定。篩選器會限制要傳回的帳戶。回應只會包含符合篩選條件的項目。如果 filter 空白，系統就不會套用任何限制條件，且會為要求的帳戶擷取所有帳戶 (分頁)。 舉例來說，含有 type=USER_GROUP 篩選器的要求只會傳回使用者群組。 type 欄位是唯一支援的篩選器。

ListAccountsResponse

Account.ListAccounts 的回應訊息。

欄位
accounts[]	Account 使用者有權存取的帳戶集合。除非已篩除，否則執行查詢者的個人帳戶一律是搜尋結果的第一個項目。
next_page_token	string 如果帳戶數量超過請求的頁面大小，系統會在這個欄位填入權杖，以便在後續呼叫 accounts.list 時擷取下一個帳戶。如果沒有更多帳戶，回應中就不會出現這個欄位。

ListInvitationsRequest

AccessControl.List 邀請 s 的要求訊息。

欄位
parent	string 必要欄位。擷取邀請清單的帳戶名稱。accounts/{account_id}/invitations
filter	string 選用設定。您可以透過 邀請.target_type 欄位篩選回應。

ListInvitationsResponse

AccessControl.List 邀請 s 的回應訊息。

欄位
invitations[]	Invitation 帳戶中待處理的邀請。這裡列出的邀請數不得超過 1000。

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

帳戶.UpdateAccount 的要求訊息。

欄位
account	Account 必要欄位。已更新的帳戶。
update_mask	FieldMask 必要欄位。要更新的特定欄位。唯一可編輯的欄位為 accountName。
validate_only	bool 選用設定。如果為 true，表示該要求已通過驗證，而不會實際更新帳戶。

UpdateLocationAdminRequest

要求 AccessControl.UpdateLocationAdmin 的訊息。

欄位
location_admin	Admin 必要欄位。更新後的管理員版本。
update_mask	FieldMask 必要欄位。要更新的特定欄位。唯一可編輯的欄位是角色。