REST Resource: accounts

Resource: Akun

Akun adalah penampung untuk lokasi Anda. Jika Anda satu-satunya pengguna yang mengelola lokasi untuk bisnis, Anda dapat menggunakan Akun Google pribadi Anda. Untuk membagikan pengelolaan lokasi dengan beberapa pengguna, buat akun bisnis.

Representasi 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)
  }
}
Kolom
name

string

Tidak dapat diubah. Nama resource, dalam format accounts/{account_id}.
accountName

string

Wajib. Nama akun. Untuk akun jenis PERSONAL, ini adalah nama depan dan nama belakang akun pengguna.
primaryOwner

string

Wajib. Hanya input. Nama resource akun yang akan menjadi pemilik utama akun yang sedang dibuat. URL harus dalam bentuk accounts/{account_id}.
type

enum (AccountType)

Wajib. Berisi jenis akun. Akun jenis PERSONAL dan Organization tidak dapat dibuat menggunakan API ini.
role

enum (AccountRole)

Hanya output. Menentukan AccountRole akun ini.
verificationState

enum (VerificationState)

Hanya output. Jika diverifikasi, lokasi mendatang yang dibuat akan otomatis terhubung ke Google Maps dan dibuatkan halaman Google+, tanpa memerlukan moderasi.
vettedState

enum (VettedState)

Hanya output. Menunjukkan apakah akun diverifikasi oleh Google. Akun terverifikasi dapat memverifikasi lokasi melalui metode VETTED_PARTNER.
accountNumber

string

Hanya output. Nomor referensi akun jika disediakan.
permissionLevel

enum (PermissionLevel)

Hanya output. Menentukan tingkat izin yang dimiliki pengguna untuk akun ini.
organizationInfo

object (OrganizationInfo)

Hanya output. Info tambahan untuk organisasi. Kolom ini hanya diisi untuk akun organisasi.

AccountType

Menunjukkan jenis akun: akun pribadi/pengguna atau akun bisnis.

Enum
ACCOUNT_TYPE_UNSPECIFIED Tidak ditentukan.
PERSONAL Akun pengguna akhir.
LOCATION_GROUP Grup Lokasi. Untuk mengetahui informasi selengkapnya, lihat artikel pusat bantuan
USER_GROUP Grup Pengguna untuk memisahkan staf organisasi dalam beberapa grup. Untuk mengetahui informasi selengkapnya, lihat artikel pusat bantuan
ORGANIZATION Organisasi yang mewakili perusahaan. Untuk mengetahui informasi selengkapnya, lihat artikel pusat bantuan

AccountRole

Menunjukkan tingkat akses yang dimiliki pengguna terautentikasi untuk akun ini. Untuk mengetahui informasi selengkapnya, lihat artikel pusat bantuan

Enum
ACCOUNT_ROLE_UNSPECIFIED Tidak ditentukan.
PRIMARY_OWNER Pengguna adalah pemilik utama akun ini.
OWNER Pemilik pengguna akun.
MANAGER Pengguna dapat mengelola akun ini.
SITE_MANAGER Pengguna dapat mengelola serangkaian fitur terbatas untuk akun.

VerificationState

Menunjukkan status verifikasi akun.

Enum
VERIFICATION_STATE_UNSPECIFIED Tidak ditentukan.
VERIFIED Akun terverifikasi.
UNVERIFIED Akun yang tidak diverifikasi, dan verifikasi belum diminta.
VERIFICATION_REQUESTED Akun yang tidak diverifikasi, tetapi verifikasi telah diminta.

VettedState

Menunjukkan status terverifikasi akun.

Enum
VETTED_STATE_UNSPECIFIED Tidak Ditentukan
NOT_VETTED Akun tidak diverifikasi oleh Google.
VETTED Akun diverifikasi oleh Google dan memiliki status valid. Akun secara otomatis diperiksa jika memiliki akses langsung ke akun grup terverifikasi.
INVALID Akun diperiksa, tetapi memiliki status tidak valid. Akun akan berperilaku seperti akun yang tidak diteliti.

PermissionLevel

Menunjukkan tingkat akses yang dimiliki pengguna terautentikasi untuk akun ini.

Enum
PERMISSION_LEVEL_UNSPECIFIED Tidak ditentukan.
OWNER_LEVEL Pengguna memiliki izin tingkat pemilik.
MEMBER_LEVEL Pengguna memiliki izin tingkat anggota.

OrganizationInfo

Informasi tambahan yang disimpan untuk organisasi.

Representasi JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Kolom
registeredDomain

string

Hanya output. Domain terdaftar untuk akun.
address

object (PostalAddress)

Hanya output. Alamat pos untuk akun.
phoneNumber

string

Hanya output. Nomor kontak untuk organisasi.

PostalAddress

Mewakili alamat pos, mis. untuk pengiriman pos atau alamat pembayaran. Misalnya, layanan pos dapat mengirimkan item ke lokasi, P.O. Box, atau yang serupa. Ini tidak dimaksudkan untuk membuat model lokasi geografis (jalan, kota, gunung).

Dalam penggunaan umum, alamat akan dibuat melalui input pengguna atau dari mengimpor data yang ada, bergantung pada jenis prosesnya.

Saran terkait input / pengeditan alamat: - Gunakan widget alamat yang siap internasionalisasi seperti https://github.com/google/libaddressinput) - Pengguna tidak boleh diberi elemen UI untuk memasukkan atau mengedit kolom selain negara tempat kolom tersebut digunakan.

Untuk panduan lebih lanjut tentang cara menggunakan skema ini, lihat: https://support.google.com/business/answer/6397478

Representasi JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Kolom
revision

integer

Revisi skema PostalAddress. Nilai ini harus disetel ke 0, yang merupakan revisi terbaru.

Semua revisi baru harus kompatibel dengan revisi lama.
regionCode

string

Wajib. Kode wilayah CLDR negara/wilayah alamat. Ini tidak pernah disimpulkan dan terserah pengguna untuk memastikan nilainya benar. Lihat https://cldr.unicode.org/ dan https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html untuk mengetahui detailnya. Contoh: "CH" untuk Swiss.
languageCode

string

Opsional. Kode bahasa BCP-47 konten alamat ini (jika diketahui). Ini sering kali merupakan bahasa UI formulir input atau diharapkan cocok dengan salah satu bahasa yang digunakan di negara/wilayah alamat, atau padanannya yang telah ditransliterasi. Hal ini dapat memengaruhi pemformatan di negara tertentu, tetapi tidak penting bagi kebenaran data dan tidak akan memengaruhi validasi apa pun atau operasi terkait non-pemformatan lainnya.

Jika nilai ini tidak diketahui, nilai ini harus dihilangkan (daripada menentukan default yang mungkin salah).

Contoh: "zh-Hant", "ja", "ja-Latn", "en".
postalCode

string

Opsional. Kode pos alamat. Tidak semua negara menggunakan atau mewajibkan keberadaan kode pos. Namun, jika kode pos digunakan, kode pos tersebut dapat memicu validasi tambahan dengan bagian alamat lainnya (misalnya, validasi negara bagian/kode pos di AS).
sortingCode

string

Opsional. Kode pengurutan tambahan khusus negara. Opsi ini tidak digunakan di sebagian besar wilayah. Jika digunakan, nilainya bisa berupa string seperti "CEDEX", secara opsional diikuti dengan angka (mis. "CEDEX 7"), atau hanya angka saja, yang mewakili "kode sektor" (Jamaika), "indikator area pengiriman" (Malawi), atau "indikator kantor pos" (mis. Côte d'Ivoire).
administrativeArea

string

Opsional. Subdivisi administratif tertinggi yang digunakan untuk alamat pos negara atau wilayah. Misalnya, ini dapat berupa negara bagian, provinsi, oblast, atau prefektur. Khususnya, untuk Spanyol ini adalah provinsi dan bukan komunitas otonom (mis. "Barcelona" dan bukan "Catalunya"). Banyak negara yang tidak menggunakan wilayah administratif dalam alamat pos. Misalnya, di Swiss, kolom ini harus dibiarkan kosong.
locality

string

Opsional. Secara umum merujuk pada bagian kota dari alamat. Contoh: US city, IT comune, UK post city. Di wilayah dunia dengan lokalitas yang tidak didefinisikan dengan baik atau tidak cocok dengan struktur ini, biarkan lokalitas kosong dan gunakan addressLines.
sublocality

string

Opsional. Sublokalitas alamat. Misalnya, ini dapat berupa kawasan, borough, distrik.
addressLines[]

string

Baris alamat tidak terstruktur yang menjelaskan tingkat alamat yang lebih rendah.

Karena nilai dalam addressLines tidak memiliki informasi jenis dan terkadang dapat berisi beberapa nilai dalam satu kolom (misalnya "Austin, TX"), urutan baris harus jelas. Urutan baris alamat harus "urutan amplop" untuk negara/wilayah alamat. Di tempat yang dapat bervariasi (misalnya Jepang), address_language digunakan untuk membuatnya eksplisit (misalnya "ja" untuk pengurutan besar ke kecil dan "ja-Latn" atau "en" untuk kecil ke besar). Dengan cara ini, baris alamat yang paling spesifik dapat dipilih berdasarkan bahasa.

Representasi struktural minimum yang diizinkan dari alamat terdiri dari regionCode dengan semua informasi lainnya yang ditempatkan di addressLines. Memformat alamat seperti itu bisa dilakukan dengan sangat akurat tanpa geocoding, tetapi tidak ada alasan semantik yang bisa dibuat mengenai salah satu komponen alamat hingga setidaknya sebagian diselesaikan.

Membuat alamat yang hanya berisi regionCode dan addressLines, dan kemudian geocoding adalah cara yang disarankan untuk menangani alamat yang benar-benar tidak terstruktur (sebagai kebalikan dari menebak bagian alamat mana yang harus berupa lokalitas atau wilayah administratif).
recipients[]

string

Opsional. Penerima di alamat. Dalam keadaan tertentu, kolom ini dapat berisi informasi multibaris. Misalnya, halaman ini mungkin berisi informasi "perawatan".
organization

string

Opsional. Nama organisasi di alamat.

Metode

create

 Membuat akun dengan nama dan jenis yang ditentukan di bawah induk tertentu.

get

 Mendapatkan akun yang ditentukan.

list

 Menampilkan daftar semua akun untuk pengguna terautentikasi.

patch

 Memperbarui akun bisnis yang ditentukan.