REST Resource: accounts

Tài nguyên: Tài khoản

Tài khoản là một vùng chứa cho vị trí của bạn. Nếu là người dùng duy nhất quản lý 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)
  }
}
Trường
name

string

Bất biến. 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 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ó định dạng accounts/{account_id}.

type

enum (AccountType)

Bắt buộc. Chứa loại tài khoả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à được tạo các trang Google+ mà không yêu cầu kiểm duyệt.

vettedState

enum (VettedState)

Chỉ có đầu ra. Cho biết liệu tài khoản có được Google xem xét hay không. Tài khoản được xem xét kỹ lưỡng 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 của tài khoản nếu được cấp phép.

permissionLevel

enum (PermissionLevel)

Chỉ có đầu ra. Chỉ định cấp độ quyền của người dùng đối với tài khoản này.

organizationInfo

object (OrganizationInfo)

Chỉ có đầu ra. Thông tin bổ sung của một tổ chức. Trường 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 nào: tài khoản cá nhân/tài khoản người dùng hoặc tài khoản doanh nghiệp.

Enum
ACCOUNT_TYPE_UNSPECIFIED Chưa chỉ định.
PERSONAL Tài khoản người dùng cuối.
LOCATION_GROUP Một nhóm Vị trí. Để biết thêm thông tin, hãy xem bài viết này trong trung tâm trợ giúp
USER_GROUP Một nhóm người dùng để tách nhân viên trong tổ chức theo nhóm. Để biết thêm thông tin, hãy xem bài viết này 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 này trong trung tâm trợ giúp

AccountRole

Cho biết cấp truy cập của người dùng đã xác thực đối với tài khoản này. Để biết thêm thông tin, hãy xem bài viết này trong trung tâm trợ giúp

Enum
ACCOUNT_ROLE_UNSPECIFIED Chưa chỉ đị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 giới hạn của 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 chỉ định.
VERIFIED Tài khoản đã xác minh.
UNVERIFIED Tài khoản chưa được xác minh và chưa yêu cầu xác minh.
VERIFICATION_REQUESTED Tài khoản chưa được xác minh nhưng đã có yêu cầu xác minh.

VettedState

Cho biết trạng thái đã được xem xét của một tài khoản.

Enum
VETTED_STATE_UNSPECIFIED Chưa chỉ định
NOT_VETTED Tài khoản này chưa được Google xem xét.
VETTED Tài khoản này đã được Google xem xét kỹ lưỡng và ở trạng thái hợp lệ. Hệ thống sẽ tự động xem xét một tài khoản nếu tài khoản đó có quyền truy cập trực tiếp vào một tài khoản nhóm đã được xem xét.
INVALID Tài khoản đã được kiểm tra nhưng ở trạng thái không hợp lệ. Tài khoản đó sẽ hoạt động giống như một tài khoản chưa được xem xét.

PermissionLevel

Cho biết cấp truy cập của người dùng đã xác thực đối với tài khoản này.

Enum
PERMISSION_LEVEL_UNSPECIFIED Chưa chỉ đị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 tổ chức.

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

string

Chỉ có đầu ra. Miền mà bạ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 (Địa chỉ bưu điện)

Đại diện cho địa chỉ bưu chính, ví dụ: cho địa chỉ giao hàng qua bưu điện hoặc địa chỉ thanh toán. Khi có địa chỉ bưu chính, dịch vụ bưu chính có thể giao hàng đến trụ sở là P.O. Hộp hoặc thứ tự tương tự. Tính năng 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, một địa chỉ sẽ được tạo thông qua hoạt động đầu vào của người dùng hoặc từ việc 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á, chẳng hạn 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 đó.

Để biết thêm hướng dẫn 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
}
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, đây là bản sửa đổi mới nhất.

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

regionCode

string

Bắt buộc. Mã vùng CLDR của quốc gia/khu vực trong địa chỉ. Điều này không bao giờ được dự đoán và việc đảm bảo giá trị chính xác là tuỳ thuộc vào người dùng. Hãy tham khảo https://cldr.unicode.org/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 được yêu cầu khớp với một trong các ngôn ngữ được sử dụng trong địa chỉ quốc gia/khu vực hoặc từ tương đương được chuyển tự của chúng. Điều này có thể ảnh hưởng đến việc đị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ỳ hoạt động xác thực hoặc hoạt động nào khác không liên quan đến việc định dạng.

Nếu không biết 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 yêu cầu mã bưu chính phải xuất hiện, nhưng ở Hoa Kỳ, các quốc gia đó 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 tại Hoa Kỳ).

sortingCode

string

Không bắt buộc. Mã phân loại bổ sung, theo quốc gia cụ thể. Thông tin này không được sử dụng ở hầu hết các khu vực. Khi giá trị được sử dụng, giá trị phải là một chuỗi như "CEDEX", có thể theo sau là một số (ví dụ: "CEDEX 7") hoặc chỉ một số, đại diện cho "mã lĩnh vực" (Jamaica), "chỉ báo khu vực giao hàng" (Malawi) hoặc "chỉ báo tại bưu điện" (ví dụ: Bờ Biển Ngà).

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ụ: bạn có thể nhập 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 và không phải là 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ĩ thì không nên điền giá trị này.

locality

string

Không bắt buộc. Nói chung là phần thành phố/thị trấn của địa chỉ. Ví dụ: Thành phố ở Hoa Kỳ, xã CNTT, thị trấn có bưu điện của Vương quốc Anh. Trong các 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. Quận/phường 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ỉ phi cấu trúc mô tả các cấp thấp hơn của một địa chỉ.

Do 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ự dòng phải rõ ràng. Thứ tự của các dòng địa chỉ phải là "thứ tự phong bì" cho quốc gia/khu vực trong địa chỉ. Ở những nơi giá trị này có thể thay đổi (ví dụ: Nhật Bản), address_language được sử 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 dựa trên ngôn ngữ.

Cách 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ã vùng với tất cả thông tin còn lại được đặt trong Dòng địa chỉ. Có thể định dạng một địa chỉ như vậy gần như mà không cần mã hoá địa lý, nhưng không thể lập luận ngữ nghĩa về bất kỳ thành phần địa chỉ nào cho đến khi địa chỉ đó được giải quyết ít nhất một phần.

Tạo một địa chỉ chỉ chứa mã vùng và addressLines, sau đó mã hóa địa lý là cách được khuyến nghị để xử lý các địa chỉ hoàn toàn không có cấu trúc (trái ngược với việc đoán phần nào của địa chỉ sẽ 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ụ: thẻ có thể chứa từ "chăm sóc" của bạn.

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 theo tài khoả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.