REST Resource: accounts.businessInfo

Risorsa: BusinessInfo

Il messaggio BusinessInfo contiene informazioni essenziali sull'attività di un commerciante.

Questo messaggio acquisisce i dettagli chiave dell'attività, come indirizzo fisico, contatti dell'assistenza clienti e identificatori specifici per regione.

Rappresentazione JSON 
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
Campi
name

string

Identificatore. Il nome della risorsa delle informazioni sull'attività. Formato: accounts/{account}/businessInfo
address

object (PostalAddress)

Facoltativo. L'indirizzo dell'attività. Sono supportati solo i campi regionCode, addressLines, postalCode, administrativeArea e locality. Tutti gli altri campi vengono ignorati.
phone

object (PhoneNumber)

Solo output. Il numero di telefono dell'attività.
phoneVerificationState

enum (PhoneVerificationState)

Solo output. Lo stato della verifica telefonica dell'attività.
customerService

object (CustomerService)

Facoltativo. L'assistenza clienti dell'attività.
koreanBusinessRegistrationNumber

string

Facoltativo. Il numero di registrazione dell'attività per la Corea del Sud di 10 cifre separato da trattini nel formato: XXX-XX-XXXXX.

PostalAddress

Rappresenta un indirizzo postale. Ad esempio, per l'indirizzo di consegna postale o per gli indirizzi per i pagamenti. Dato un indirizzo postale, un servizio postale può consegnare gli articoli a un'abitazione, a una cassetta postale o a un indirizzo simile. Non è progettato per modellare località geografiche (strade, città, montagne).

In un utilizzo tipico, un indirizzo viene creato dall'input dell'utente o dall'importazione di dati esistenti, a seconda del tipo di processo.

Consigli per l'inserimento / la modifica dell'indirizzo: - Utilizza un widget di indirizzo pronto per l'internazionalizzazione, ad esempio https://github.com/google/libaddressinput. - Agli utenti non devono essere mostrati elementi dell'interfaccia utente per l'inserimento o la modifica di campi al di fuori dei paesi in cui vengono utilizzati.

Per ulteriori indicazioni su come utilizzare questo schema, consulta la pagina https://support.google.com/business/answer/6397478

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

integer

La revisione dello schema di PostalAddress. Deve essere impostato su 0, ovvero la revisione più recente.

Tutte le nuove revisioni devono essere compatibili con le versioni precedenti.
regionCode

string

Obbligatorio. Codice regione CLDR del paese/della regione dell'indirizzo. Questo valore non viene mai dedotto ed è responsabilità dell'utente assicurarsi che sia corretto. Per maggiori dettagli, visita le pagine https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Esempio: "CH" per la Svizzera.
languageCode

string

Facoltativo. Codice lingua BCP-47 dei contenuti dell'indirizzo (se noto). Spesso si tratta della lingua dell'interfaccia utente del modulo di immissione o dovrebbe corrispondere a una delle lingue utilizzate nel paese/nella regione dell'indirizzo o ai relativi equivalenti traslitterati. Ciò può influire sulla formattazione in alcuni paesi, ma non è fondamentale per la correttezza dei dati e non influirà mai sulla convalida o su altre operazioni non correlate alla formattazione.

Se questo valore non è noto, deve essere omesso (anziché specificare un valore predefinito eventualmente errato).

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

string

Facoltativo. Il codice postale dell'indirizzo. Non tutti i paesi utilizzano o richiedono la presenza di codici postali, ma, dove vengono utilizzati, possono attivare una convalida aggiuntiva con altre parti dell'indirizzo (ad esempio la convalida dello stato/del codice postale negli Stati Uniti).
sortingCode

string

Facoltativo. Codice di ordinamento aggiuntivo specifico per paese. Questo formato non viene utilizzato nella maggior parte delle regioni. Se viene utilizzato, il valore è una stringa come "CEDEX", eventualmente seguita da un numero (ad esempio "CEDEX 7") o solo un numero, che rappresenta il "codice settore" (Giamaica), l'"indicatore zona di consegna" (Malawi) o l'"indicatore ufficio postale" (ad esempio Costa d'Avorio).
administrativeArea

string

Facoltativo. Suddivisione amministrativa di grado più alto usata per l'indirizzo postale di un paese o di un'area geografica. Ad esempio, può essere uno stato, una provincia, un oblast o una prefettura. Nello specifico, per la Spagna si tratta della provincia e non della comunità autonoma (ad esempio "Barcellona" e non "Catalogna"). Molti paesi non utilizzano un'area amministrativa negli indirizzi postali. Ad esempio, in Svizzera questo campo deve essere lasciato vuoto.
locality

string

Facoltativo. Solitamente si riferisce alla porzione di città dell'indirizzo. Esempi: "city" per gli Stati Uniti, "comune" in Italia, "post town" nel Regno Unito. Lì dove le località non sono ben definite o non rientrano nella struttura, lascia il campo vuoto e usa addressLines.
sublocality

string

Facoltativo. Quartiere dell'indirizzo. Ad esempio, possono essere quartieri, rioni, distretti.
addressLines[]

string

Righe dell'indirizzo non strutturate che descrivono i livelli inferiori di un indirizzo.

Poiché i valori in addressLines non hanno informazioni sul tipo e a volte possono contenere più valori in un singolo campo (ad es. "Austin, TX"), è importante che l'ordine delle righe sia chiaro. L'ordine delle righe dell'indirizzo deve essere "ordine busta" per il paese o la regione dell'indirizzo. Nei paesi in cui questo può variare (ad esempio in Giappone), viene utilizzato address_language per renderlo esplicito (ad esempio "ja" per l'ordinamento da grande a piccolo e "ja-Latn" o "en" per l'ordinamento da piccolo a grande). In questo modo, è possibile selezionare la riga più specifica di un indirizzo in base alla lingua.

La rappresentazione strutturale minima consentita di un indirizzo è costituita da un codice regione con tutte le informazioni rimanenti inserite nelle righe indirizzo. Sarebbe possibile formattare un indirizzo del genere in modo molto approssimativo senza geocodifica, ma non è possibile effettuare deduzioni semantiche su nessuno dei componenti dell'indirizzo finché non viene risolto almeno parzialmente.

La creazione di un indirizzo contenente solo regionCode e addressLines, seguita dal geocodifica, è il modo consigliato per gestire gli indirizzi completamente non strutturati (anziché indovinare quali parti dell'indirizzo devono essere località o aree amministrative).
recipients[]

string

Facoltativo. Il destinatario all'indirizzo. In determinate circostanze, questo campo può contenere informazioni su più righe. Ad esempio, potrebbe contenere informazioni su chi gestisce la proprietà.
organization

string

Facoltativo. Il nome dell'organizzazione all'indirizzo.

Numero di telefono

Un oggetto che rappresenta un numero di telefono, adatto come formato di invio dell'API.

Questa rappresentazione:

  • Non deve essere utilizzato per la formattazione di un numero di telefono specifico per le impostazioni internazionali, ad esempio "+1 (650) 253-0000 int. 123"

  • non è progettato per un'archiviazione efficiente

  • potrebbe non essere adatto per la composizione. Per questo scopo, devono essere utilizzate librerie specializzate (vedi riferimenti) per analizzare il numero

Per fare qualcosa di significativo con questo numero, ad esempio formattarlo per vari casi d'uso, devi prima convertirlo in un oggetto i18n.phonenumbers.PhoneNumber.

Ad esempio, in Java sarebbe:

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

Riferimenti: - https://github.com/google/libphonenumber

Rappresentazione JSON 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
Campi
extension

string

L'estensione del numero di telefono. L'estensione non è standardizzata nei consigli dell'ITU, tranne per il fatto che è definita come una serie di numeri con una lunghezza massima di 40 cifre. Oltre ai numeri, qui potrebbero essere memorizzati altri caratteri di composizione, ad esempio "," (che indica una pausa) o "#".

Tieni presente che al momento nessuna regione utilizza estensioni con codici brevi, pertanto questo campo viene normalmente impostato solo in combinazione con un numero E.164. Viene tenuto separato dal numero E.164 per consentire l'utilizzo di estensioni di codici brevi in futuro.
Campo unione kind. Obbligatorio. Un numero normale o un codice breve. In futuro potrebbero essere aggiunti nuovi campi a oneof di seguito, pertanto i client devono ignorare i numeri di telefono per i quali non è impostato nessuno dei campi in base ai quali sono stati codificati. kind può essere solo uno dei seguenti:
e164Number

string

Il numero di telefono, rappresentato da un segno più iniziale ("+"), seguito da un numero di telefono che utilizza un formato ITU E.164 rilassato composto dal codice paese (da 1 a 3 cifre) e dal numero dell'abbonato, senza spazi o formattazione aggiuntivi. Ad esempio: - corretto: "+15552220123" - errato: "+1 (555) 222-01234 x123".

Il formato E.164 dell'ITU limita quest'ultimo a 12 cifre, ma in pratica non tutti i paesi lo rispettano, quindi allentiamo questa limitazione. I numeri solo nazionali non sono consentiti.

Riferimenti: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

Un codice breve.

Riferimento: - https://en.wikipedia.org/wiki/Short_code

ShortCode

Un oggetto che rappresenta un codice breve, ovvero un numero di telefono in genere molto più breve dei numeri di telefono normali e che può essere utilizzato per indirizzare i messaggi nei sistemi MMS e SMS, nonché per la composizione abbreviata (ad esempio "Invia un messaggio al 611 per sapere quanti minuti ti rimangono nel tuo piano").

I codici brevi sono limitati a una regione e non possono essere chiamati a livello internazionale, il che significa che lo stesso codice breve può esistere in regioni diverse, con prezzi e utilizzi diversi, anche se queste regioni condividono lo stesso codice paese (ad esempio Stati Uniti e Canada).

Rappresentazione JSON 
{
  "regionCode": string,
  "number": string
}
Campi
regionCode

string

Obbligatorio. Il codice regione BCP-47 della località in cui è possibile effettuare chiamate a questo codice breve, ad esempio "US" e "BB".

Riferimenti: - http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

Obbligatorio. Le cifre del codice breve, senza il segno più iniziale ("+") o il codice paese. Ad esempio, "611".

PhoneVerificationState

Lo stato della verifica telefonica.

Enum
PHONE_VERIFICATION_STATE_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
PHONE_VERIFICATION_STATE_VERIFIED Lo smartphone è verificato.
PHONE_VERIFICATION_STATE_UNVERIFIED Lo smartphone non è verificato

CustomerService

Informazioni sull'assistenza clienti.

Rappresentazione JSON 
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
Campi
uri

string

Facoltativo. L'URI in cui è possibile trovare l'assistenza clienti.
email

string

Facoltativo. L'indirizzo email a cui è possibile contattare l'assistenza clienti.
phone

object (PhoneNumber)

Facoltativo. Il numero di telefono a cui è possibile chiamare l'assistenza clienti.

Metodi

getBusinessInfo

 Recupera le informazioni sull'attività di un account.

updateBusinessInfo

 Aggiorna le informazioni sull'attività di un account.