REST Resource: accounts

Tài nguyê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.

Biểu diễn dưới dạng 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)
  }
}
Các trường
name

string

Không thể thay đổi. Tên tài nguyên, ở định dạng accounts/{account_id}.
accountName

string

Bắt buộc. Tên tài khoản. Đối với tài khoản thuộc loại PERSONAL, đây là họ và tên của tài khoản người dùng.
primaryOwner

string

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 accounts/{account_id}.
type

enum (AccountType)

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

enum (AccountRole)

Chỉ có đầu ra. Chỉ định AccountRole của tài khoản này.
verificationState

enum (VerificationState)

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

enum (VettedState)

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

string

Chỉ có đầu ra. Số tham chiếu tài khoản nếu được cấp phép.
permissionLevel

enum (PermissionLevel)

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

object (OrganizationInfo)

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.

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

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.

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.

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.

OrganizationInfo

Thông tin bổ sung được lưu trữ cho một tổ chức.

Biểu diễn dưới dạng JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Các trường
registeredDomain

string

Chỉ có đầu ra. Miền đã đăng ký cho tài khoản.
address

object (PostalAddress)

Chỉ có đầu ra. Địa chỉ gửi thư cho tài khoản.
phoneNumber

string

Chỉ có đầu ra. Số điện thoại liên hệ của tổ chức.

PostalAddress

Đại diện cho địa chỉ bưu chính, ví dụ: địa chỉ giao hàng hoặc thanh toán qua bưu điện. Khi có địa chỉ bưu chính, dịch vụ bưu chính có thể giao hàng đến tận nhà, hộp thư bưu điện hoặc những thứ tương tự. Bố cục này không nhằm lập mô hình vị trí địa lý (đường, thị trấn, núi).

Trong cách sử dụng thông thường, địa chỉ sẽ được tạo qua hoạt động đầu vào của người dùng hoặc bằng cách nhập dữ liệu hiện có, tuỳ thuộc vào loại quy trình.

Lời khuyên về việc nhập / chỉnh sửa địa chỉ: – Sử dụng tiện ích địa chỉ sẵn sàng quốc tế hoá như https://github.com/google/libaddressinput) – Không nên cung cấp cho người dùng các phần tử trên giao diện người dùng để nhập hoặc chỉnh sửa các trường ở bên ngoài quốc gia sử dụng trường đó.

Để được hướng dẫn thêm về cách sử dụng giản đồ này, vui lòng xem: https://support.google.com/business/answer/6397478

Biểu diễn dưới dạng JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Các trường
revision

integer

Bản sửa đổi giản đồ của PostalAddress. Giá trị này phải được đặt thành 0, vì đây là bản sửa đổi mới nhất.

Tất cả bản sửa đổi mới phải tương thích ngược với bản sửa đổi cũ.
regionCode

string

Bắt buộc. Mã vùng CLDR của quốc gia/khu vực trên địa chỉ. Điều này không bao giờ được suy luận và người dùng có trách nhiệm đảm bảo giá trị chính xác. Hãy truy cập vào https://cldr.unicode.org/ và https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html để biết thông tin chi tiết. Ví dụ: "CH" cho Thuỵ Sĩ.
languageCode

string

Không bắt buộc. Mã ngôn ngữ BCP-47 của nội dung địa chỉ này (nếu biết). Đây thường là ngôn ngữ giao diện người dùng của biểu mẫu nhập hoặc dự kiến sẽ khớp với một trong các ngôn ngữ dùng tại quốc gia/khu vực của địa chỉ hoặc các ngôn ngữ tương đương được chuyển tự. Điều này có thể ảnh hưởng đến định dạng ở một số quốc gia nhất định, nhưng không quan trọng đối với độ chính xác của dữ liệu và sẽ không bao giờ ảnh hưởng đến bất kỳ thao tác xác thực hay hoạt động nào khác liên quan đến việc không định dạng.

Nếu không xác định được giá trị này, bạn nên bỏ qua giá trị này (thay vì chỉ định giá trị mặc định có thể không chính xác).

Ví dụ: "zh-Hant", "ja", "ja-Latn", "en".
postalCode

string

Không bắt buộc. Mã bưu chính của địa chỉ. Không phải quốc gia nào cũng sử dụng hoặc bắt buộc phải có mã bưu chính. Tuy nhiên, ở những nơi sử dụng mã bưu chính, mã bưu chính có thể kích hoạt quy trình xác thực bổ sung với các phần khác của địa chỉ (ví dụ: xác thực tiểu bang/mã bưu chính ở Hoa Kỳ).
sortingCode

string

Không bắt buộc. Mã phân loại bổ sung theo quốc gia. Chế độ này không được sử dụng ở hầu hết các khu vực. Trong trường hợp sử dụng, giá trị có thể là một chuỗi như "CEDEX", tuỳ ý theo sau là một số (ví dụ: "CEDEX 7") hoặc chỉ là một số, đại diện cho "mã ngành" (Jamaica), "chỉ báo khu vực giao hàng" (Malawi) hoặc "chỉ báo bưu điện" (ví dụ: Côte d'Ivoire).
administrativeArea

string

Không bắt buộc. Phân khu hành chính cao nhất dùng cho địa chỉ bưu chính của một quốc gia hoặc khu vực. Ví dụ: đó có thể là một tiểu bang, một tỉnh, một vùng hoặc một tỉnh. Cụ thể, đối với Tây Ban Nha, đây là tỉnh chứ không phải cộng đồng tự trị (ví dụ: "Barcelona" chứ không phải "Catalonia"). Nhiều quốc gia không sử dụng khu vực hành chính trong địa chỉ bưu điện. Ví dụ: ở Thuỵ Sĩ, bạn nên bỏ trống mã này.
locality

string

Không bắt buộc. Thường có nghĩa là phần thành phố/thị trấn trong địa chỉ. Ví dụ: Thành phố ở Hoa Kỳ, khu CNTT, thị trấn có bưu điện ở Vương quốc Anh. Ở những khu vực trên thế giới nơi các địa phương không được xác định rõ hoặc không phù hợp với cấu trúc này, hãy để trống địa phương và sử dụng addressLines.
sublocality

string

Không bắt buộc. Cụm dân cư của địa chỉ. Ví dụ: đây có thể là vùng lân cận, thị xã, quận.
addressLines[]

string

Dòng địa chỉ không có cấu trúc mô tả các cấp thấp hơn của một địa chỉ.

Vì các giá trị trong addressLines không có thông tin về loại và đôi khi có thể chứa nhiều giá trị trong một trường (ví dụ: "Austin, TX"), điều quan trọng là thứ tự hàng phải rõ ràng. Thứ tự của các dòng địa chỉ phải là "phong bì đơn đặt hàng" cho quốc gia/khu vực của địa chỉ. Ở những nơi có thể khác nhau (ví dụ: Nhật Bản), address_language được dùng để thể hiện rõ ràng (ví dụ: "ja" cho thứ tự từ lớn đến nhỏ và "ja-Latn" hoặc "en" cho từ nhỏ đến lớn). Bằng cách này, dòng địa chỉ cụ thể nhất có thể được chọn theo ngôn ngữ.

Biểu diễn cấu trúc tối thiểu được phép của một địa chỉ bao gồm một mã khu vực với tất cả thông tin còn lại được đặt trong addressLines. Có thể định dạng địa chỉ như vậy rất gần mà không cần mã hoá địa lý, nhưng không thể đưa ra lý luận ngữ nghĩa nào về bất kỳ thành phần địa chỉ nào cho đến khi địa chỉ đó ít nhất được giải quyết một phần.

Tạo một địa chỉ chỉ chứa mã vùng và địa chỉ, sau đó mã hoá địa lý là cách được khuyên dùng để xử lý các địa chỉ hoàn toàn không có cấu trúc (thay vì đoán phần nào của địa chỉ nên là địa phương hoặc khu vực hành chính).
recipients[]

string

Không bắt buộc. Người nhận tại địa chỉ. Trong một số trường hợp nhất định, trường này có thể chứa thông tin nhiều dòng. Ví dụ: tài liệu này có thể chứa thông tin "chăm sóc".
organization

string

Không bắt buộc. Tên của tổ chức tại địa chỉ.

Phương thức

create

 Tạo một tài khoản có tên và loại đã chỉ định trong thành phần mẹ đã cho.

get

 Lấy tài khoản được chỉ định.

list

 Liệt kê tất cả tài khoản của người dùng đã xác thực.

patch

 Cập nhật tài khoản doanh nghiệp được chỉ định.