REST Resource: accounts

Risorsa: account

Un account è un contenitore per la tua località. Se sei l'unico utente che gestisce le sedi della tua attività, puoi utilizzare il tuo Account Google personale. Per condividere con più utenti la gestione delle sedi, crea un account aziendale.

Rappresentazione 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)
  }
}
Campi
name

string

Immutabile. Il nome della risorsa, nel formato accounts/{account_id}.

accountName

string

Obbligatorio. Il nome dell'account. Per un account di tipo PERSONAL, si tratta del nome e del cognome dell'account utente.

primaryOwner

string

Obbligatorio. Solo input. Il nome della risorsa dell'account che sarà il proprietario principale dell'account in fase di creazione. Deve avere il formato accounts/{account_id}.

type

enum (AccountType)

Obbligatorio. Contiene il tipo di account. Non è possibile creare account di tipo PERSONAL e ORGANIZATION utilizzando questa API.

role

enum (AccountRole)

Solo output. Specifica l'AccountRole di questo account.

verificationState

enum (VerificationState)

Solo output. Se verificate, le località future create vengono collegate automaticamente a Google Maps e vengono create pagine Google+ senza richiedere la moderazione.

vettedState

enum (VettedState)

Solo output. Indica se l'account è stato verificato da Google. Un account controllato è in grado di verificare le sedi con il metodo VETTED_PARTNER.

accountNumber

string

Solo output. Numero di riferimento dell'account, se fornito.

permissionLevel

enum (PermissionLevel)

Solo output. Specifica il livello di autorizzazione dell'utente per questo account.

organizationInfo

object (OrganizationInfo)

Solo output. Informazioni aggiuntive per un'organizzazione. Il campo viene compilato solo per un account dell'organizzazione.

AccountType

Indica di che tipo di account si tratta: account personale/utente o account aziendale.

Enum
ACCOUNT_TYPE_UNSPECIFIED Non specificato.
PERSONAL Un account utente finale.
LOCATION_GROUP Un gruppo di località. Per saperne di più, consulta l'articolo del Centro assistenza
USER_GROUP Un gruppo di utenti per la separazione del personale dell'organizzazione in gruppi. Per saperne di più, consulta l'articolo del Centro assistenza
ORGANIZATION Un'organizzazione che rappresenta un'azienda. Per saperne di più, consulta l'articolo del Centro assistenza

AccountRole

Indica il livello di accesso dell'utente autenticato a questo account. Per saperne di più, consulta l'articolo del Centro assistenza

Enum
ACCOUNT_ROLE_UNSPECIFIED Non specificato.
PRIMARY_OWNER L'utente è il proprietario principale di questo account.
OWNER Il proprietario dell'account.
MANAGER L'utente può gestire questo account.
SITE_MANAGER L'utente può gestire un insieme limitato di funzionalità dell'account.

VerificationState

Indica lo stato di verifica dell'account.

Enum
VERIFICATION_STATE_UNSPECIFIED Non specificato.
VERIFIED Account verificato.
UNVERIFIED Account che non è stato verificato e la verifica non è stata richiesta.
VERIFICATION_REQUESTED Account che non è stato verificato, ma è stata richiesta la verifica.

VettedState

Indica lo stato verificato di un account.

Enum
VETTED_STATE_UNSPECIFIED Non specificato
NOT_VETTED L'account non è verificato da Google.
VETTED L'account è verificato da Google ed è in uno stato valido. Un account viene automaticamente controllato se ha accesso diretto a un account del gruppo verificato.
INVALID L'account è stato verificato, ma lo stato non è valido. Si comporterà come un account non verificato.

PermissionLevel

Indica il livello di accesso dell'utente autenticato a questo account.

Enum
PERMISSION_LEVEL_UNSPECIFIED Non specificato.
OWNER_LEVEL L'utente dispone dell'autorizzazione a livello di proprietario.
MEMBER_LEVEL L'utente dispone dell'autorizzazione a livello di membro.

OrganizationInfo

Informazioni aggiuntive archiviate per un'organizzazione.

Rappresentazione JSON
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Campi
registeredDomain

string

Solo output. Il dominio registrato per l'account.

address

object (PostalAddress)

Solo output. L'indirizzo postale dell'account.

phoneNumber

string

Solo output. Il numero di contatto dell'organizzazione.

PostalAddress

Rappresenta un indirizzo postale, ad esempio per gli indirizzi di consegna postale o di pagamento. Dato un indirizzo postale, un servizio postale può consegnare gli articoli a una sede, una P.O. Box o simile. Non è progettato per creare modelli di località geografiche (strade, città, montagne).

Nell'utilizzo tipico, un indirizzo verrebbe creato tramite l'input dell'utente o importando dati esistenti, a seconda del tipo di processo.

Consigli sull'inserimento / modifica di indirizzi: - Usa un widget degli indirizzi pronto per l'internazionalizzazione, come https://github.com/google/libaddressinput. - Agli utenti non dovrebbero essere mostrati elementi di interfaccia utente per l'inserimento o la modifica di campi al di fuori dei paesi in cui viene utilizzato quel campo.

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 o della regione dell'indirizzo. Ciò non viene mai dedotto e spetta all'utente assicurarsi che il valore sia corretto. Per informazioni dettagliate, 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 di questo indirizzo (se noto). Spesso si tratta della lingua dell'interfaccia utente del modulo di input o dovrebbe corrispondere a una delle lingue utilizzate nell'indirizzo. paese/regione o i loro equivalenti traslitterati. Questo può influenzare la formattazione in alcuni paesi, ma non è fondamentale per la correttezza dei dati e non influirà mai su convalida o altre operazioni correlate alla formattazione.

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

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

postalCode

string

(Facoltativo) Codice postale dell'indirizzo. Non tutti i paesi utilizzano o richiedono la presenza di codici postali, ma se vengono utilizzati, possono attivare un'ulteriore convalida con altre parti dell'indirizzo (ad es. convalida stato/codice postale negli Stati Uniti).

sortingCode

string

(Facoltativo) Codice di ordinamento aggiuntivo specifico per il paese. Questa opzione non è utilizzata nella maggior parte delle regioni. Dove viene utilizzato, il valore è una stringa come "CEDEX", facoltativamente seguita da un numero (ad es. "CEDEX 7") o solo un numero, che rappresenta il "codice di settore" (Giamaica), "indicatore zona di consegna" (Malawi) o "indicatore dell'ufficio postale" (ad es. Costa d'Avorio).

administrativeArea

string

(Facoltativo) Suddivisione amministrativa di livello più elevato utilizzata per gli indirizzi postali di un paese o di una regione. Ad esempio, può essere uno stato, una provincia, un oblast o una prefettura. In particolare, per la Spagna si tratta della provincia e non della comunità autonoma (ad es. "Barcellona" e non "Catalogna"). Molti paesi non utilizzano un'area amministrativa negli indirizzi postali. Ad es. in Svizzera, deve essere lasciato vuoto.

locality

string

(Facoltativo) In genere si riferisce alla porzione di città dell'indirizzo. Esempi: città USA, comune in Italia, città postale nel Regno Unito. Nelle regioni del mondo in cui le località non sono ben definite o non si adattano bene a questa struttura, lascia il campo della località vuoto e utilizza addressLines.

sublocality

string

(Facoltativo) Quartiere dell'indirizzo. Ad esempio, possono essere quartieri, quartieri e distretti.

addressLines[]

string

Righe di 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 luoghi dove questo valore può variare (ad es. in Giappone), viene utilizzato address_language per renderlo esplicito (ad es. "ja" per ordinamenti di grandi dimensioni e "ja-Latn" o "en" per valori di piccole dimensioni). In questo modo, è possibile selezionare la riga più specifica di un indirizzo in base alla lingua.

La rappresentazione strutturale minima consentita di un indirizzo è composta da un regionalCode con tutte le informazioni rimanenti inserite in addressLines. Sarebbe possibile formattare un indirizzo del genere in modo molto approssimativo senza geocodifica, ma non è stato possibile effettuare alcun ragionamento semantico su nessuno dei componenti dell'indirizzo fino a quando non è stato almeno parzialmente risolto.

Creare un indirizzo che contenga solo countryCode e addressLines e poi la geocodifica è il metodo consigliato per gestire 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 "cura di" informazioni.

organization

string

(Facoltativo) Il nome dell'organizzazione all'indirizzo.

Metodi

create

Crea un account con il nome e il tipo specificati sotto l'elemento principale specificato.

get

Recupera l'account specificato.

list

Elenca tutti gli account dell'utente autenticato.

patch

Aggiorna l'account aziendale specificato.