Chỉ mục
AccessControl
(giao diện)Accounts
(giao diện)AcceptInvitationRequest
(thông báo)Account
(thông báo)Account.AccountRole
(enum)Account.AccountType
(enum)Account.OrganizationInfo
(thông báo)Account.PermissionLevel
(enum)Account.VerificationState
(enum)Account.VettedState
(enum)Admin
(thông báo)Admin.AdminRole
(enum)CreateAccountAdminRequest
(thông báo)CreateAccountRequest
(thông báo)CreateLocationAdminRequest
(thông báo)DeclineInvitationRequest
(thông báo)DeleteAccountAdminRequest
(thông báo)DeleteLocationAdminRequest
(thông báo)GetAccountRequest
(thông báo)Invitation
(thông báo)Invitation.TargetLocation
(thông báo)Invitation.TargetType
(enum)ListAccountAdminsRequest
(thông báo)ListAccountAdminsResponse
(thông báo)ListAccountsRequest
(thông báo)ListAccountsResponse
(thông báo)ListInvitationsRequest
(thông báo)ListInvitationsResponse
(thông báo)ListLocationAdminsRequest
(thông báo)ListLocationAdminsResponse
(thông báo)TransferLocationRequest
(thông báo)UpdateAccountAdminRequest
(thông báo)UpdateAccountRequest
(thông báo)UpdateLocationAdminRequest
(thông báo)
AccessControl
Dịch vụ này cho phép quản lý những người dùng có quyền truy cập vào tài khoản và thông tin vị trí.
AcceptInvitation |
---|
Chấp nhận lời mời đã chỉ định.
|
CreateAccountAdmin |
---|
Mời người dùng được chỉ định trở thành quản trị viên của tài khoản được chỉ định. Khách mời phải chấp nhận lời mời để được cấp quyền truy cập vào tài khoản. Hãy truy cập vào [AcceptTags] [google.mybusiness.accountmanagement.v1.AcceptInvites] lập trình để chấp nhận lời mời.
|
CreateLocationAdmin |
---|
Mời người dùng được chỉ định trở thành quản trị viên của vị trí đã chỉ định. Khách mời phải chấp nhận lời mời để được cấp quyền truy cập vào thông tin vị trí. Hãy truy cập vào [AcceptInvite] [google.mybusiness.accountmangement.v1.Acceptinvitation] để chấp nhận lời mời bằng cách lập trình.
|
DeclineInvitation |
---|
Từ chối lời mời đã chỉ định.
|
DeleteAccountAdmin |
---|
Xóa quản trị viên được chỉ định khỏi tài khoản được chỉ định.
|
DeleteLocationAdmin |
---|
Xóa quản trị viên được chỉ định với tư cách là người quản lý của vị trí đã chỉ định.
|
ListAccountAdmins |
---|
Liệt kê quản trị viên của tài khoản đã chỉ định.
|
ListInvitations |
---|
Liệt kê những lời mời đang chờ xử lý cho tài khoản được chỉ định.
|
ListLocationAdmins |
---|
Liệt kê tất cả quản trị viên của vị trí đã chỉ định.
|
TransferLocation |
---|
Di chuyển vị trí từ tài khoản mà người dùng sở hữu sang một tài khoản khác mà người dùng đó quản lý. Người dùng phải là chủ sở hữu của tài khoản liên kết với vị trí và ít nhất phải là người quản lý của tài khoản đích.
|
UpdateAccountAdmin |
---|
Cập nhật Quản trị viên cho Quản trị viên tài khoản được chỉ định.
|
UpdateLocationAdmin |
---|
Cập nhật Trang quản trị cho vị trí đã chỉ định. Chỉ có thể cập nhật Vai trò quản trị viên của quản trị viên.
|
Tài khoản
API này cho phép quản lý các tài khoản doanh nghiệp trên Google. Định nghĩa này xác định mô hình tài nguyên sau:
API này có một tập hợp các tài nguyên Tài khoản có tên là
accounts/*
.Để thuận tiện, bạn có thể sử dụng từ đồng nghĩa "tôi" thay vì mã tài khoản cho tài khoản cá nhân của người gọi đã xác thực. Ví dụ: GET /v1/accounts/me GET /v1/accounts/me/locations
CreateAccount |
---|
Tạo một tài khoản có tên và loại đã chỉ định trong thành phần mẹ đã cho.
|
GetAccount |
---|
Lấy tài khoản được chỉ định. Trả về
|
ListAccounts |
---|
Liệt kê tất cả tài khoản của người dùng đã xác thực. Điều này bao gồm tất cả tài khoản mà người dùng sở hữu cũng như mọi tài khoản mà người dùng có quyền quản lý.
|
UpdateAccount |
---|
Cập nhật tài khoản doanh nghiệp được chỉ định. Không thể cập nhật tài khoản cá nhân bằng phương pháp này.
|
AcceptInvitationRequest
Thông báo yêu cầu truy xuất AccessControl.AcceptInvite.
Các trường | |
---|---|
name |
Bắt buộc. Tên lời mời đang được chấp nhận. |
Tài khoản
Tài khoản là vùng chứa cho vị trí của bạn. Nếu là người dùng duy nhất quản lý các vị trí cho doanh nghiệp của mình, bạn có thể sử dụng Tài khoản Google cá nhân. Để chia sẻ quyền quản lý vị trí với nhiều người dùng, hãy tạo một tài khoản doanh nghiệp.
Các trường | |
---|---|
name |
Không thể thay đổi. Tên tài nguyên, ở định dạng |
account_name |
Bắt buộc. Tên tài khoản. Đối với tài khoản thuộc loại |
primary_owner |
Bắt buộc. Chỉ nhập. Tên tài nguyên của tài khoản sẽ là chủ sở hữu chính của tài khoản được tạo. Mã này phải có dạng |
type |
Bắt buộc. Chứa loại tài khoản. Bạn không thể tạo tài khoản thuộc loại PERSONAL và ORGANIZATION bằng API này. |
role |
Chỉ có đầu ra. Chỉ định AccountRole của tài khoản này. |
verification_state |
Chỉ có đầu ra. Nếu được xác minh, các vị trí được tạo trong tương lai sẽ tự động được kết nối với Google Maps và tạo các trang Google+ mà không cần kiểm duyệt. |
vetted_state |
Chỉ có đầu ra. Cho biết liệu tài khoản đã được Google xem xét kỹ lưỡng hay chưa. Tài khoản đã được kiểm tra có thể xác minh vị trí thông qua phương thức VETTED_PARTNER. |
account_number |
Chỉ có đầu ra. Số tham chiếu tài khoản nếu được cấp phép. |
permission_level |
Chỉ có đầu ra. Chỉ định cấp độ quyền mà người dùng có đối với tài khoản này. |
organization_info |
Chỉ có đầu ra. Thông tin bổ sung về tổ chức. Mã này chỉ được điền sẵn cho tài khoản tổ chức. |
AccountRole
Cho biết cấp truy cập mà người dùng đã xác thực có vào tài khoản này. Để biết thêm thông tin, hãy xem bài viết trong trung tâm trợ giúp
Enum | |
---|---|
ACCOUNT_ROLE_UNSPECIFIED |
Chưa xác định. |
PRIMARY_OWNER |
Người dùng là chủ sở hữu chính của tài khoản này. |
OWNER |
Chủ sở hữu người dùng của tài khoản. |
MANAGER |
Người dùng có thể quản lý tài khoản này. |
SITE_MANAGER |
Người dùng có thể quản lý một nhóm tính năng có giới hạn cho tài khoản. |
AccountType
Cho biết đây là loại tài khoản gì: tài khoản cá nhân/người dùng hay tài khoản doanh nghiệp.
Enum | |
---|---|
ACCOUNT_TYPE_UNSPECIFIED |
Chưa xác định. |
PERSONAL |
Tài khoản người dùng cuối. |
LOCATION_GROUP |
Một nhóm Địa điểm. Để biết thêm thông tin, hãy xem bài viết trong trung tâm trợ giúp |
USER_GROUP |
Nhóm người dùng để tách nhân viên của tổ chức thành các nhóm. Để biết thêm thông tin, hãy xem bài viết trong trung tâm trợ giúp |
ORGANIZATION |
Tổ chức đại diện cho một công ty. Để biết thêm thông tin, hãy xem bài viết trong trung tâm trợ giúp |
OrganizationInfo
Thông tin bổ sung được lưu trữ cho một tổ chức.
Các trường | |
---|---|
registered_domain |
Chỉ có đầu ra. Miền đã đăng ký cho tài khoản. |
address |
Chỉ có đầu ra. Địa chỉ gửi thư cho tài khoản. |
phone_number |
Chỉ có đầu ra. Số điện thoại liên hệ của tổ chức. |
PermissionLevel
Cho biết cấp truy cập mà người dùng đã xác thực có vào tài khoản này.
Enum | |
---|---|
PERMISSION_LEVEL_UNSPECIFIED |
Chưa xác định. |
OWNER_LEVEL |
Người dùng có quyền ở cấp chủ sở hữu. |
MEMBER_LEVEL |
Người dùng có quyền ở cấp thành viên. |
VerificationState
Cho biết trạng thái xác minh của tài khoản.
Enum | |
---|---|
VERIFICATION_STATE_UNSPECIFIED |
Chưa xác định. |
VERIFIED |
Tài khoản đã xác minh. |
UNVERIFIED |
Tài khoản chưa được xác minh và chưa được yêu cầu xác minh. |
VERIFICATION_REQUESTED |
Tài khoản chưa được xác minh nhưng đã yêu cầu xác minh. |
VettedState
Cho biết trạng thái đã được xem xét kỹ lưỡng của tài khoản.
Enum | |
---|---|
VETTED_STATE_UNSPECIFIED |
Chưa chỉ định |
NOT_VETTED |
Google chưa xem xét kỹ tài khoản này. |
VETTED |
Tài khoản này đã được Google xem xét kỹ lưỡng và đang ở trạng thái hợp lệ. Một tài khoản tự động được xem xét kỹ lưỡng nếu có quyền truy cập trực tiếp vào tài khoản nhóm được xem xét kỹ lưỡng. |
INVALID |
Tài khoản đã được xem xét kỹ lưỡng nhưng ở trạng thái không hợp lệ. Tài khoản đó sẽ hoạt động như một tài khoản chưa được xem xét. |
Bảng điều khiển dành cho quản trị viên
Quản trị viên của một Tài khoản hoặc một vị trí.
Các trường | |
---|---|
name |
Không thể thay đổi. Tên tài nguyên. Đối với quản trị viên tài khoản, biểu mẫu này có trong biểu mẫu: Đối với quản trị viên vị trí, mã này có dạng: Trường này sẽ bị bỏ qua nếu bạn đặt trường này trong quá trình tạo quản trị viên. |
admin |
Không bắt buộc. Tên của quản trị viên. Khi gửi lời mời đầu tiên, đây là địa chỉ email của người được mời. Trong các cuộc gọi Bạn chỉ cần đặt trường này trong quá trình tạo quản trị viên. |
account |
Không thể thay đổi. Tên của tài nguyên Tài khoản mà Quản trị viên này đề cập đến. Được dùng khi gọi locations.admin.create để mời một Nhóm vị trí làm quản trị viên. Nếu cả trường này và Định dạng: |
role |
Bắt buộc. Chỉ định vai trò mà quản trị viên này sử dụng với Tài khoản hoặc Vị trí đã chỉ định. |
pending_invitation |
Chỉ có đầu ra. Cho biết liệu quản trị viên này có lời mời đang chờ xử lý cho tài nguyên đã chỉ định hay không. |
AdminRole
Cho biết cấp truy cập mà quản trị viên có. Để biết thêm thông tin, hãy xem bài viết trong trung tâm trợ giúp
Enum | |
---|---|
ADMIN_ROLE_UNSPECIFIED |
Chưa xác định. |
PRIMARY_OWNER |
Quản trị viên có quyền truy cập cấp chủ sở hữu và là chủ sở hữu chính. (Hiển thị dưới dạng "Chủ sở hữu chính" trong giao diện người dùng). |
OWNER |
Quản trị viên có quyền truy cập cấp chủ sở hữu. (Hiển thị dưới dạng "Chủ sở hữu" trong giao diện người dùng). |
MANAGER |
Quản trị viên có quyền quản lý. |
SITE_MANAGER |
Quản trị viên có thể quản lý các trang mạng xã hội (Google+). (Hiển thị dưới dạng "Người quản lý địa điểm" trong giao diện người dùng). API này không cho phép tạo quản trị viên tài khoản với vai trò SITE_MANAGER. |
CreateAccountAdminRequest
Thông báo yêu cầu cho AccessControl.CreateAccountadmin.
Các trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của tài khoản mà quản trị viên này được tạo. |
admin |
Bắt buộc. Quản trị viên mà bạn đã tạo. Vai trò không được là SITE_MANAGER |
CreateAccountRequest
Thông báo yêu cầu cho Tài khoản.CreateAccount.
Các trường | |
---|---|
account |
Bắt buộc. Thông tin tài khoản cho tài khoản bạn sẽ tạo. Chỉ có các trường được phép là tài khoản và loại. |
CreateLocationAdminRequest
Thông báo yêu cầu cho AccessControl.CreateLocationadmin.
Các trường | |
---|---|
parent |
Bắt buộc. Tên tài nguyên của vị trí mà quản trị viên này được tạo. |
admin |
Bắt buộc. Quản trị viên sẽ tạo. |
DeclineInvitationRequest
Thông báo yêu cầu truy cập AccessControl.từ chối lời mời.
Các trường | |
---|---|
name |
Bắt buộc. Tên lời mời tài khoản đang bị từ chối. |
DeleteAccountAdminRequest
Thông báo yêu cầu cho AccessControl.DeleteAccountadmin.
Các trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của quản trị viên cần xoá khỏi tài khoản. |
DeleteLocationAdminRequest
Thông báo yêu cầu cho AccessControl.DeleteLocationQuản trị.
Các trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên của quản trị viên cần xoá khỏi vị trí. |
GetAccountRequest
Thông báo yêu cầu cho tài khoản.GetAccount.
Các trường | |
---|---|
name |
Bắt buộc. Tên của tài khoản cần tìm nạp. |
Thư mời
Đại diện cho lời mời đang chờ xử lý.
Các trường | |
---|---|
name |
Bắt buộc. Tên tài nguyên cho lời mời. |
role |
Chỉ có đầu ra. Vai trò được mời trên tài khoản. |
target_type |
Chỉ có đầu ra. Chỉ định loại mục tiêu nào sẽ xuất hiện trong phản hồi. |
Trường nhóm target . Cho biết mục tiêu của lời mời này. target chỉ có thể là một trong những trạng thái sau đây: |
|
target_account |
Tài khoản có thư viện gửi lời mời này là dành cho tài khoản. |
target_location |
Vị trí mục tiêu của lời mời này. |
TargetLocation
Đại diện cho vị trí mục tiêu cho lời mời đang chờ xử lý.
Các trường | |
---|---|
location_name |
Tên của vị trí mà người dùng được mời. |
address |
Địa chỉ của vị trí mà người dùng được mời. |
TargetType
Loại mục tiêu của lời mời.
Enum | |
---|---|
TARGET_TYPE_UNSPECIFIED |
Đặt khi loại mục tiêu chưa được chỉ định. |
ACCOUNTS_ONLY |
Chỉ liệt kê lời mời cho các mục tiêu của loại Tài khoản. |
LOCATIONS_ONLY |
Chỉ liệt kê lời mời cho các mục tiêu của loại Vị trí. |
ListAccountAdminsRequest
Thông báo yêu cầu cho AccessControl.ListAccountAdmins.
Các trường | |
---|---|
parent |
Bắt buộc. Tên của tài khoản để truy xuất danh sách quản trị viên. |
ListAccountAdminsResponse
Thông báo phản hồi cho AccessControl.ListAccountAdmins.
Các trường | |
---|---|
account_admins[] |
Tập hợp các phiên bản Quản trị. |
ListAccountsRequest
Thông báo yêu cầu cho Tài khoản.ListAccounts.
Các trường | |
---|---|
parent_account |
Không bắt buộc. Tên tài nguyên của tài khoản mà danh sách các tài khoản có thể truy cập trực tiếp sẽ được truy xuất. Điều này chỉ phù hợp với Tổ chức và Nhóm người dùng. Nếu trống, hàm sẽ trả về |
page_size |
Không bắt buộc. Số lượng tài khoản cần tìm nạp trên mỗi trang. Giá trị mặc định và tối đa là 20. |
page_token |
Không bắt buộc. Nếu chỉ định, trang tiếp theo của tài khoản sẽ được truy xuất. |
filter |
Không bắt buộc. Bộ lọc ràng buộc các tài khoản trả về. Phản hồi chỉ bao gồm các mục khớp với bộ lọc. Nếu Ví dụ: một yêu cầu có bộ lọc Trường |
ListAccountsResponse
Thông báo phản hồi cho Accounts.ListAccounts.
Các trường | |
---|---|
accounts[] |
Tập hợp các tài khoản mà người dùng có quyền truy cập. Tài khoản cá nhân của người dùng thực hiện truy vấn sẽ luôn là mục đầu tiên của kết quả, trừ khi nó bị lọc ra. |
next_page_token |
Nếu số lượng tài khoản vượt quá kích thước trang được yêu cầu, thì trường này sẽ được điền sẵn một mã thông báo để tìm nạp trang tài khoản tiếp theo trong lệnh gọi tiếp theo đến |
ListInvitationsRequest
Thông báo yêu cầu truy cập vào AccessControl.ListInvitess.
Các trường | |
---|---|
parent |
Bắt buộc. Tên của tài khoản mà từ đó danh sách lời mời được truy xuất. |
filter |
Không bắt buộc. Tính năng lọc phản hồi được hỗ trợ thông qua trườngInvite.target_type. |
ListInvitationsResponse
Thông báo phản hồi cho AccessControl.ListInvitess.
Các trường | |
---|---|
invitations[] |
Một tập hợp các lời mời đang chờ xử lý cho tài khoản. Số lượng lời mời được liệt kê ở đây không được vượt quá 1.000. |
ListLocationAdminsRequest
Thông báo yêu cầu truy cập vào AccessControl.ListLocationAdmins.
Các trường | |
---|---|
parent |
Bắt buộc. Tên của vị trí để liệt kê quản trị viên. |
ListLocationAdminsResponse
Thông báo phản hồi cho AccessControl.ListLocationAdmins.
Các trường | |
---|---|
admins[] |
Tập hợp các quản trị viên. |
TransferLocationRequest
Thông báo yêu cầu truy cập vào AccessControl.TransferLocation.
Các trường | |
---|---|
name |
Bắt buộc. Tên của vị trí cần chuyển. |
destination_account |
Bắt buộc. Tên của tài nguyên tài khoản để chuyển vị trí đến (ví dụ: "accounts/{account}"). |
UpdateAccountAdminRequest
Thông báo yêu cầu truy cập vào AccessControl.UpdateAccountAdmin.
Các trường | |
---|---|
account_admin |
Bắt buộc. Phiên bản cập nhật của Bảng điều khiển dành cho quản trị viên. |
update_mask |
Bắt buộc. Các trường cụ thể cần được cập nhật. Trường có thể chỉnh sửa duy nhất là vai trò. |
UpdateAccountRequest
Thông báo yêu cầu cho Accounts.UpdateAccount.
Các trường | |
---|---|
account |
Bắt buộc. Tài khoản đã cập nhật. |
update_mask |
Bắt buộc. Các trường cụ thể cần được cập nhật. Trường có thể chỉnh sửa duy nhất là |
validate_only |
Không bắt buộc. Nếu đúng, yêu cầu sẽ được xác thực nhưng không thực sự cập nhật tài khoản. |
UpdateLocationAdminRequest
Thông báo yêu cầu cho AccessControl.UpdateLocationAdmin.
Các trường | |
---|---|
location_admin |
Bắt buộc. Phiên bản cập nhật của Bảng điều khiển dành cho quản trị viên. |
update_mask |
Bắt buộc. Các trường cụ thể cần được cập nhật. Trường có thể chỉnh sửa duy nhất là vai trò. |