REST Resource: accounts

Risorsa: account

Un account è un contenitore della tua sede. 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, corrisponde al nome e al cognome dell'account utente.

primaryOwner

string

Obbligatorio. Solo input. Il nome della risorsa dell'account che sarà il proprietario principale dell'account che viene creato. Deve essere nel formato accounts/{account_id}.

type

enum (AccountType)

Obbligatorio. Contiene il tipo di account. Impossibile creare account di tipo PERSONALe e ORGANIZZAZIONE utilizzando questa API.

role

enum (AccountRole)

Solo output. Specifica l'AccountRole di questo account.

verificationState

enum (VerificationState)

Solo output. Una volta verificate, le sedi future che verranno create vengono collegate automaticamente a Google Maps e hanno pagine Google+ create, senza necessità di moderazione.

vettedState

enum (VettedState)

Solo output. Indica se l'account è verificato da Google. Un account verificato è in grado di verificare le sedi utilizzando 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. Questo campo viene compilato solo per un account dell'organizzazione.

AccountType

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

Enum
ACCOUNT_TYPE_UNSPECIFIED Non specificato.
PERSONAL Un account utente finale.
LOCATION_GROUP Un gruppo di sedi. Per ulteriori informazioni, consulta questo articolo del Centro assistenza
USER_GROUP Un gruppo di utenti per segregare il personale dell'organizzazione in gruppi. Per ulteriori informazioni, consulta questo articolo del Centro assistenza
ORGANIZATION Un'organizzazione che rappresenta un'azienda. Per ulteriori informazioni, consulta questo articolo del Centro assistenza

AccountRole

Indica il livello di accesso dell'utente autenticato a questo account. Per ulteriori informazioni, consulta questo articolo del Centro assistenza

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

VerificationState

Indica lo stato di verifica dell'account.

Enum
VERIFICATION_STATE_UNSPECIFIED Non specificato.
VERIFIED Account verificato.
UNVERIFIED Account non verificato e che non è stata richiesta la verifica.
VERIFICATION_REQUESTED Account non verificato, ma richiesta di 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 è stato verificato da Google ed è valido. Un account viene verificato automaticamente se ha accesso diretto a un account del gruppo verificato.
INVALID L'account è stato verificato, ma lo stato non è valido. L'account 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 la consegna o gli indirizzi per i pagamenti. Dato un indirizzo postale, un servizio postale può consegnare gli articoli a una sede, a una casella postale o simili. Non è stato progettato per modellare le località geografiche (strade, città, montagne).

Nell'uso tipico, un indirizzo viene creato tramite l'input utente o dall'importazione di dati esistenti, a seconda del tipo di processo.

Consigli per l'inserimento / la modifica dell'indirizzo: - Usa un widget degli indirizzi pronto per l'internazionalizzazione, come https://github.com/google/libaddressinput). - Agli utenti non devono essere presentati elementi UI per l'inserimento o la modifica di campi al di fuori dei paesi in cui viene utilizzato tale 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, che corrisponde alla 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. Questo non viene mai dedotto e spetta all'utente verificare 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

Campo 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 nel paese/nella regione dell'indirizzo o ai relativi equivalenti trascritti. 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 correlate a non formattazione.

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

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

postalCode

string

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

sortingCode

string

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

administrativeArea

string

Campo facoltativo. Suddivisione amministrativa di livello più alto utilizzata per gli indirizzi postali di un paese o di una regione. Ad esempio, uno stato, una provincia, un oblast o una prefettura. Nello specifico, 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 esempio, in Svizzera questo campo deve essere lasciato vuoto.

locality

string

Campo facoltativo. Si riferisce generalmente alla parte relativa alla città dell'indirizzo. Esempi: città degli Stati Uniti, comune italiano, città del 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

Campo facoltativo. Circoscrizione dell'indirizzo. ad esempio quartieri, distretti o distretti.

addressLines[]

string

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

Poiché i valori in addressLines non contengono 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 indirizzo deve essere "ordine busta" per il paese/la regione dell'indirizzo. Nei luoghi in cui può variare (ad esempio in Giappone), viene utilizzato address_language per renderlo esplicito (ad es. "ja" per ordinamento da grande a piccolo e "ja-Latn" o "en" per ordine piccolo-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 è composta da un elemento regioneCode con tutte le informazioni rimanenti inserite nelle righe dell'indirizzo. Sarebbe possibile formattare un indirizzo di questo tipo in modo molto approssimativo senza geocodifica, ma non è stato possibile fare un ragionamento semantico su nessuno dei componenti dell'indirizzo fino a quando non fosse stato risolto almeno parzialmente.

La creazione di un indirizzo contenente solo regioneCode e indirizzoLines, quindi la geocodifica è il metodo consigliato per gestire indirizzi completamente non strutturati (invece di indovinare quali parti dell'indirizzo dovrebbero essere località o aree amministrative).

recipients[]

string

Campo facoltativo. Il destinatario all'indirizzo. In determinate circostanze, questo campo può contenere informazioni su più righe. Ad esempio, potrebbe contenere informazioni di tipo "cura di".

organization

string

Campo 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

Consente di acquisire l'account specificato.

list

Elenca tutti gli account dell'utente autenticato.

patch

Consente di aggiornare l'account aziendale specificato.