- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- VerificationOption
- AddressVerificationData
- EmailVerificationData
Melaporkan semua opsi verifikasi yang memenuhi syarat untuk lokasi dalam bahasa tertentu.
Permintaan HTTP
POST https://mybusinessverifications.googleapis.com/v1/{location=locations/*}:fetchVerificationOptions
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
location |
Wajib. Lokasi yang akan diverifikasi. |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"languageCode": string,
"context": {
object ( |
Kolom | |
---|---|
languageCode |
Wajib. Kode bahasa BCP 47 yang merepresentasikan bahasa yang akan digunakan untuk proses verifikasi. Opsi yang tersedia bervariasi berdasarkan bahasa. |
context |
Opsional. Informasi konteks tambahan untuk verifikasi bisnis layanan. Hanya dapat diterapkan ke lokasi yang jenis bisnisnya adalah CUSTOMER_LOCATION_ONLY. Menentukan alamat yang akurat dapat mengaktifkan lebih banyak opsi. INVALID_ ARGUMENT akan ditampilkan jika kolom ini ditetapkan untuk jenis lokasi bisnis lain. |
Isi respons
Pesan respons untuk Verifications.FetchVerificationOptions.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"options": [
{
object ( |
Kolom | |
---|---|
options[] |
Opsi verifikasi yang tersedia. |
Cakupan otorisasi
Memerlukan cakupan OAuth berikut ini:
https://www.googleapis.com/auth/business.manage
Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.
VerificationOption
Opsi verifikasi merepresentasikan cara memverifikasi lokasi (yang ditunjukkan dengan metode verifikasi) dan tempat verifikasi akan dikirim (yang ditunjukkan dengan data tampilan).
Representasi JSON |
---|
{ "verificationMethod": enum ( |
Kolom | |
---|---|
verificationMethod |
Metode untuk memverifikasi lokasi. |
Kolom union DisplayData . Salah satu data tampilan. Data harus cocok dengan metode. Kosong jika metode yang sesuai tidak memiliki data tampilan. DisplayData hanya ada berupa salah satu diantara berikut: |
|
phoneNumber |
Tetapkan hanya jika metode adalah PHONE_CALL atau SMS. Nomor telepon yang akan dikirimi PIN. |
addressData |
Tetapkan hanya jika metodenya adalah EMAIL. |
emailData |
Tetapkan hanya jika metode adalah EMAIL. |
announcement |
Tetapkan hanya jika metode adalah VETTED_PARTNER. |
AddressVerificationData
Menampilkan data untuk verifikasi melalui kartu pos.
Representasi JSON |
---|
{
"business": string,
"address": {
object ( |
Kolom | |
---|---|
business |
Nama bisnis penjual. |
address |
Alamat yang dapat dikirimi kartu pos. |
expectedDeliveryDaysRegion |
Perkiraan jumlah hari yang diperlukan untuk mengirimkan kartu pos ke wilayah alamat. |
EmailVerificationData
Data tampilan untuk verifikasi melalui email.
Representasi JSON |
---|
{ "domain": string, "user": string, "isUserNameEditable": boolean } |
Kolom | |
---|---|
domain |
Nama domain di alamat email. mis. "gmail.com" di foo@gmail.com |
user |
Nama pengguna di alamat email. mis. "foo" di foo@gmail.com |
isUserNameEditable |
Apakah klien diizinkan untuk memberikan nama pengguna yang berbeda atau tidak. |