Package google.mybusiness.accountmanagement.v1

Indeks

AccessControl

Layanan ini memungkinkan pengelolaan pengguna yang memiliki akses ke akun dan lokasi.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Menerima undangan tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Mengundang pengguna tertentu untuk menjadi administrator untuk akun tertentu. Pengguna yang diundang harus menerima undangan agar diberi akses ke akun. Lihat [AcceptUndangan] [google.mybusiness.accountmanagement.v1.AcceptInvitation] untuk menerima undangan secara terprogram.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Mengundang pengguna tertentu agar menjadi administrator untuk lokasi tertentu. Pengguna yang diundang harus menerima undangan agar diberi akses ke lokasi. Lihat [AcceptInvite] [google.mybusiness.accountmangement.v1.AcceptInvite] untuk menerima undangan secara terprogram.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Menolak undangan tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Menghapus admin tertentu dari akun tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Menghapus admin tertentu sebagai pengelola lokasi tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Menampilkan daftar admin untuk akun yang ditentukan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Mencantumkan undangan yang menunggu keputusan untuk akun tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Menampilkan daftar semua admin untuk lokasi yang ditentukan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Memindahkan lokasi dari akun milik pengguna ke akun lain yang dikelola pengguna yang sama. Pengguna harus merupakan pemilik akun yang lokasi saat ini dikaitkan dan setidaknya harus merupakan pengelola akun tujuan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Memperbarui Admin untuk Admin Akun tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Memperbarui Admin untuk lokasi yang ditentukan. Hanya AdminRole Admin yang dapat diperbarui.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Akun

API ini memungkinkan pengelolaan akun bisnis di Google. Kode ini menentukan model resource berikut:

  • API ini memiliki kumpulan Resource akun, yang bernama accounts/*.

  • Untuk memudahkan, Anda dapat menggunakan sinonim "me" sebagai pengganti id akun untuk akun pribadi pemanggil terautentikasi. Contoh: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

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

  • Akun pribadi dan Organisasi tidak dapat dibuat.
  • Grup Pengguna tidak dapat dibuat dengan akun Pribadi sebagai pemilik utama.
  • Grup Lokasi tidak dapat dibuat dengan pemilik utama akun Pribadi jika akun Pribadi berada di Organisasi.
  • Grup Lokasi tidak dapat memiliki Grup Lokasi.
Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Mendapatkan akun yang ditentukan. Menampilkan NOT_FOUND jika akun tidak ada atau jika pemanggil tidak memiliki hak akses untuk akun tersebut.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Menampilkan daftar semua akun untuk pengguna terautentikasi. Hal ini mencakup semua akun yang dimiliki pengguna, serta akun apa pun yang hak pengelolaannya dimiliki pengguna.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Memperbarui akun bisnis yang ditentukan. Akun pribadi tidak dapat diperbarui menggunakan metode ini.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/business.manage

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

AcceptInvitationRequest

Pesan permintaan untuk AccessControl.AcceptInvite.

Kolom
name

string

Wajib. Nama undangan yang diterima. accounts/{account_id}/invitations/{invitation_id}

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.

Kolom
name

string

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

string

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

string

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

AccountType

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

AccountRole

Hanya output. Menentukan AccountRole akun ini.
verification_state

VerificationState

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

VettedState

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

string

Hanya output. Nomor referensi akun jika disediakan.
permission_level

PermissionLevel

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

OrganizationInfo

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

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.

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

OrganizationInfo

Informasi tambahan yang disimpan untuk organisasi.

Kolom
registered_domain

string

Hanya output. Domain terdaftar untuk akun.
address

PostalAddress

Hanya output. Alamat pos untuk akun.
phone_number

string

Hanya output. Nomor kontak untuk organisasi.

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.

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.

Admin

Administrator Akun atau lokasi.

Kolom
name

string

Tidak dapat diubah. Nama resource. Untuk admin akun, ini dalam bentuk: accounts/{account_id}/admins/{admin_id}

Untuk admin lokasi, ini dalam bentuk: locations/{location_id}/admins/{admin_id}

Kolom ini akan diabaikan jika ditetapkan selama pembuatan admin.
admin

string

Opsional. Nama admin. Saat membuat undangan awal, ini adalah alamat email pengguna yang diundang. Pada panggilan GET, alamat email pengguna akan ditampilkan jika undangan masih menunggu keputusan. Jika tidak, kolom ini berisi nama depan dan nama belakang pengguna.

Kolom ini hanya perlu ditetapkan selama pembuatan admin.
account

string

Tidak dapat diubah. Nama resource Akun yang dirujuk Admin ini. Digunakan saat memanggil locations.admins.create untuk mengundang LocationGroup sebagai admin.

Jika kolom ini dan admin ditetapkan pada permintaan CREATE, kolom ini akan diprioritaskan dan alamat email di admin akan diabaikan.

Format accounts/{account}.
role

AdminRole

Wajib. Menentukan peran yang digunakan admin ini dengan Akun atau Lokasi yang ditentukan.
pending_invitation

bool

Hanya output. Menunjukkan apakah admin ini memiliki undangan yang masih menunggu keputusan untuk resource yang ditentukan.

AdminRole

Menunjukkan tingkat akses yang dimiliki admin. Untuk mengetahui informasi selengkapnya, lihat artikel pusat bantuan

Enum
ADMIN_ROLE_UNSPECIFIED Tidak ditentukan.
PRIMARY_OWNER Admin memiliki akses tingkat pemilik dan merupakan pemilik utama. (Ditampilkan sebagai 'Pemilik Utama' di UI).
OWNER Admin memiliki akses tingkat pemilik. (Ditampilkan sebagai 'Pemilik' di UI).
MANAGER Admin memiliki akses manajerial.
SITE_MANAGER Admin dapat mengelola halaman sosial (Google+). (Ditampilkan sebagai 'Pengelola Lokasi' di UI). API ini tidak mengizinkan pembuatan admin akun dengan peran SITE_MANAGER.

CreateAccountAdminRequest

Pesan permintaan untuk AccessControl.CreateAccountAdmin.

Kolom
parent

string

Wajib. Nama resource akun yang dibuatkan admin ini. accounts/{account_id}.
admin

Admin

Wajib. Admin yang akan dibuat. Peran tidak boleh SITE_MANAGER

CreateAccountRequest

Pesan permintaan untuk Accounts.CreateAccount.

Kolom
account

Account

Wajib. Informasi akun untuk akun yang akan dibuat. Kolom yang diizinkan hanya akun dan jenis.

CreateLocationAdminRequest

Pesan permintaan untuk AccessControl.CreateLocationAdmin.

Kolom
parent

string

Wajib. Nama resource lokasi yang dibuat admin ini. locations/{location_id}/admins.
admin

Admin

Wajib. Admin yang akan dibuat.

DeclineInvitationRequest

Pesan permintaan untuk AccessControl.RejectInvitation.

Kolom
name

string

Wajib. Nama undangan akun yang ditolak. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

Pesan permintaan untuk AccessControl.DeleteAccountAdmin.

Kolom
name

string

Wajib. Nama resource admin yang akan dihapus dari akun. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

Pesan permintaan untuk AccessControl.DeleteLocationAdmin.

Kolom
name

string

Wajib. Nama resource admin yang akan dihapus dari lokasi.

GetAccountRequest

Pesan permintaan untuk Accounts.GetAccount.

Kolom
name

string

Wajib. Nama akun yang akan diambil.

Undangan

Merepresentasikan undangan yang menunggu keputusan.

Kolom
name

string

Wajib. Nama resource untuk undangan. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Hanya output. Peran yang diundang di akun.
target_type

TargetType

Hanya output. Menentukan jenis target yang akan muncul dalam respons.
Kolom union target. Menunjukkan target yang akan menerima undangan ini. target hanya ada berupa salah satu diantara berikut:
target_account

Account

Akun yang jarang diisi yang akan menerima undangan ini.
target_location

TargetLocation

Target lokasi yang akan menerima undangan ini.

TargetLocation

Merepresentasikan lokasi target untuk undangan yang menunggu keputusan.

Kolom
location_name

string

Nama lokasi tempat pengguna diundang.
address

string

Alamat lokasi tempat pengguna diundang.

TargetType

Untuk jenis target undangan.

Enum
TARGET_TYPE_UNSPECIFIED Tetapkan saat jenis target tidak ditentukan.
ACCOUNTS_ONLY Daftar undangan hanya untuk target jenis Akun.
LOCATIONS_ONLY Daftar undangan hanya untuk target jenis Lokasi.

ListAccountAdminsRequest

Pesan permintaan untuk AccessControl.ListAccountAdmins.

Kolom
parent

string

Wajib. Nama akun tempat mengambil daftar admin. accounts/{account_id}/admins.

ListAccountAdminsResponse

Pesan respons untuk AccessControl.ListAccountAdmins.

Kolom
account_admins[]

Admin

Kumpulan instance Admin.

ListAccountsRequest

Pesan permintaan untuk Accounts.ListAccounts.

Kolom
parent_account

string

Opsional. Nama resource akun tempat daftar akun yang dapat diakses secara langsung akan diambil. Hal ini hanya masuk akal untuk Organisasi dan Grup Pengguna. Jika kosong, akan menampilkan ListAccounts untuk pengguna yang diautentikasi. accounts/{account_id}.
page_size

int32

Opsional. Berapa banyak akun yang harus diambil per halaman. Default dan maksimum adalah 20.
page_token

string

Opsional. Jika ditentukan, halaman akun berikutnya diambil. pageToken ditampilkan saat panggilan ke accounts.list menampilkan lebih banyak hasil daripada yang bisa ditampung dalam ukuran halaman yang diminta.
filter

string

Opsional. Filter yang membatasi akun yang akan ditampilkan. Responsnya hanya menyertakan entri yang cocok dengan filter. Jika filter kosong, tidak ada batasan yang diterapkan dan semua akun (bernomor halaman) diambil untuk akun yang diminta.

Misalnya, permintaan dengan filter type=USER_GROUP hanya akan menampilkan grup pengguna.

Kolom type adalah satu-satunya filter yang didukung.

ListAccountsResponse

Pesan respons untuk Accounts.ListAccounts.

Kolom
accounts[]

Account

Kumpulan akun yang dapat diakses pengguna. Akun pribadi pengguna yang melakukan kueri akan selalu menjadi item pertama hasil, kecuali jika difilter.
next_page_token

string

Jika jumlah akun melebihi ukuran halaman yang diminta, kolom ini diisi dengan token untuk mengambil halaman akun berikutnya pada panggilan berikutnya ke accounts.list. Jika tidak ada lagi akun, kolom ini tidak ada dalam respons.

ListInvitationsRequest

Pesan permintaan untuk AccessControl.ListInvite.

Kolom
parent

string

Wajib. Nama akun tempat daftar undangan diambil. accounts/{account_id}/invitations
filter

string

Opsional. Memfilter respons didukung melalui kolom Undangan.target_type.

ListInvitationsResponse

Pesan respons untuk AccessControl.ListInvitations.

Kolom
invitations[]

Invitation

Kumpulan undangan yang tertunda untuk akun. Jumlah undangan yang tercantum di sini tidak boleh lebih dari 1.000.

ListLocationAdminsRequest

Pesan permintaan untuk AccessControl.ListLocationAdmins.

Kolom
parent

string

Wajib. Nama lokasi yang adminnya akan dicantumkan. locations/{location_id}/admins.

ListLocationAdminsResponse

Pesan respons untuk AccessControl.ListLocationAdmins.

Kolom
admins[]

Admin

Kumpulan Admin.

TransferLocationRequest

Pesan permintaan untuk AccessControl.TransferLocation.

Kolom
name

string

Wajib. Nama lokasi yang akan ditransfer. locations/{location_id}.
destination_account

string

Wajib. Nama resource akun yang menjadi tujuan transfer lokasi (misalnya, "accounts/{account}").

UpdateAccountAdminRequest

Pesan permintaan untuk AccessControl.UpdateAccountAdmin.

Kolom
account_admin

Admin

Wajib. Versi Admin yang diupdate.
update_mask

FieldMask

Wajib. Kolom spesifik yang harus diperbarui. Satu-satunya kolom yang dapat diedit adalah peran.

UpdateAccountRequest

Pesan permintaan untuk Accounts.UpdateAccount.

Kolom
account

Account

Wajib. Akun yang diperbarui.
update_mask

FieldMask

Wajib. Kolom spesifik yang harus diperbarui. Satu-satunya kolom yang dapat diedit adalah accountName.
validate_only

bool

Opsional. Jika benar, permintaan divalidasi tanpa benar-benar memperbarui akun.

UpdateLocationAdminRequest

Pesan permintaan untuk AccessControl.UpdateLocationAdmin.

Kolom
location_admin

Admin

Wajib. Versi Admin yang diupdate.
update_mask

FieldMask

Wajib. Kolom spesifik yang harus diperbarui. Satu-satunya kolom yang dapat diedit adalah peran.