Package google.mybusiness.accountmanagement.v1

Indice

AccessControl

Questo servizio consente di gestire gli utenti che hanno accesso ad account e sedi.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Accetta l'invito specificato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Invita l'utente specificato a diventare amministratore dell'account specificato. La persona invitata deve accettare l'invito per ottenere l'accesso all'account. Consulta [AccettaInvito] [google.mybusiness.accountmanagement.v1.AccettaInvito] per accettare un invito in modo programmatico.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Invita l'utente specificato a diventare amministratore della località specificata. L'invitato deve accettare l'invito per ottenere l'accesso alla posizione. Consulta [AccettaInvito] [google.mybusiness.accountmangement.v1.AccettaInvito] per accettare un invito in modo programmatico.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Rifiuta l'invito specificato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Rimuove l'amministratore specificato dall'account specificato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Rimuove l'amministratore specificato come gestore della sede specificata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Elenca gli amministratori dell'account specificato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Elenca gli inviti in attesa per l'account specificato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Elenca tutti gli amministratori per la località specificata.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Sposta una sede da un account di proprietà dell'utente a un altro account gestito dallo stesso utente. L'utente deve essere un proprietario dell'account a cui è attualmente associata la sede e deve anche essere almeno un gestore dell'account di destinazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Aggiorna l'amministratore per l'amministratore account specificato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Aggiorna l'amministratore per la località specificata. È possibile aggiornare solo il ruolo AdminRole dell'amministratore.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

Account

Questa API consente di gestire gli account aziendali su Google. Definisce il seguente modello di risorse:

  • L'API dispone di una raccolta di risorse dell'account denominata accounts/*.

  • Puoi utilizzare il sinonimo "io" anziché l'ID account per l'account personale del chiamante autenticato. Esempi: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

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

  • Non è possibile creare organizzazioni e account personali.
  • Non è possibile creare gruppi di utenti con un account personale come proprietario principale.
  • Non è possibile creare gruppi di località con un proprietario principale di un account personale se l'account personale si trova in un'organizzazione.
  • I gruppi di località non possono essere proprietari di gruppi di località.
Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Consente di acquisire l'account specificato. Restituisce NOT_FOUND se l'account non esiste o se il chiamante non dispone dei diritti di accesso all'account.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Elenca tutti gli account dell'utente autenticato. Sono inclusi tutti gli account di proprietà dell'utente e quelli per i quali l'utente dispone di diritti di gestione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Consente di aggiornare l'account aziendale specificato. Gli account personali non possono essere aggiornati con questo metodo.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.

AcceptInvitationRequest

Messaggio di richiesta per AccessControl.AccettaInvito.

Campi
name

string

Obbligatorio. Il nome dell'invito che viene accettato. accounts/{account_id}/invitations/{invitation_id}

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.

Campi
name

string

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

string

Obbligatorio. Il nome dell'account. Per un account di tipo PERSONAL, corrisponde al nome e al cognome dell'account utente.
primary_owner

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

AccountType

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

AccountRole

Solo output. Specifica l'AccountRole di questo account.
verification_state

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.
vetted_state

VettedState

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

string

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

PermissionLevel

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

OrganizationInfo

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

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.

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

OrganizationInfo

Informazioni aggiuntive archiviate per un'organizzazione.

Campi
registered_domain

string

Solo output. Il dominio registrato per l'account.
address

PostalAddress

Solo output. L'indirizzo postale dell'account.
phone_number

string

Solo output. Il numero di contatto dell'organizzazione.

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.

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.

Amministratore

L'amministratore di un account o di una località.

Campi
name

string

Immutabile. Il nome della risorsa. Per gli amministratori account, il formato è: accounts/{account_id}/admins/{admin_id}

Per gli amministratori delle sedi, il seguente formato è: locations/{location_id}/admins/{admin_id}

Questo campo verrà ignorato se impostato durante la creazione dell'amministratore.
admin

string

Campo facoltativo. Il nome dell'amministratore. Quando effettui l'invito iniziale, si tratta dell'indirizzo email dell'invitato. Durante le chiamate GET, viene restituito l'indirizzo email dell'utente se l'invito è ancora in attesa. In caso contrario, contiene il nome e il cognome dell'utente.

Questo campo deve essere impostato solo durante la creazione dell'amministratore.
account

string

Immutabile. Il nome della risorsa account a cui fa riferimento questo amministratore. Utilizzato quando si chiama locations.admins.create per invitare un LocationGroup come amministratore.

Se questo campo e admin sono impostati per le richieste CREATE, questo campo ha la precedenza e l'indirizzo email in admin verrà ignorato.

Formato: accounts/{account}.
role

AdminRole

Obbligatorio. Specifica il ruolo utilizzato da questo amministratore con l'account o la località specificati.
pending_invitation

bool

Solo output. Indica se l'amministratore ha un invito in attesa per la risorsa specificata.

AdminRole

Indica il livello di accesso di un amministratore. Per ulteriori informazioni, consulta questo articolo del Centro assistenza

Enum
ADMIN_ROLE_UNSPECIFIED Non specificato.
PRIMARY_OWNER L'amministratore dispone dell'accesso a livello di proprietario ed è il proprietario principale. (visualizzato come "Proprietario principale" nell'interfaccia utente).
OWNER L'amministratore dispone dell'accesso a livello di proprietario. (visualizzato come "Proprietario" nell'interfaccia utente).
MANAGER L'amministratore dispone dell'accesso per la gestione.
SITE_MANAGER L'amministratore può gestire le pagine social (Google+). (visualizzato come "Gestore sito" nell'interfaccia utente). Questa API non consente di creare un amministratore account con ruolo SITE_MANAGER.

CreateAccountAdminRequest

Messaggio di richiesta per AccessControl.CreateAccountAdmin.

Campi
parent

string

Obbligatorio. Il nome risorsa dell'account per cui è stato creato questo amministratore. accounts/{account_id}.
admin

Admin

Obbligatorio. L'amministratore lo ha creato. Il ruolo non può essere SITE_MANAGER

CreateAccountRequest

Messaggio di richiesta per Accounts.CreateAccount.

Campi
account

Account

Obbligatorio. Dati relativi all'account da creare. Gli unici campi consentiti sono account e tipo.

CreateLocationAdminRequest

Messaggio di richiesta per AccessControl.CreateLocationAdmin.

Campi
parent

string

Obbligatorio. Il nome risorsa della località per cui è stato creato questo amministratore. locations/{location_id}/admins.
admin

Admin

Obbligatorio. L'amministratore da creare.

DeclineInvitationRequest

Richiedi un messaggio per AccessControl.RifiutaInvito.

Campi
name

string

Obbligatorio. Il nome dell'invito per l'account che è stato rifiutato. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

Messaggio di richiesta per AccessControl.DeleteAccountAdmin.

Campi
name

string

Obbligatorio. Il nome della risorsa che l'amministratore deve rimuovere dall'account. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

Messaggio di richiesta per AccessControl.DeleteLocationAdmin.

Campi
name

string

Obbligatorio. Il nome della risorsa che l'amministratore deve rimuovere dalla località.

GetAccountRequest

Messaggio di richiesta per Account.GetAccount.

Campi
name

string

Obbligatorio. Il nome dell'account da recuperare.

Invito

Rappresenta un invito in attesa.

Campi
name

string

Obbligatorio. Il nome della risorsa per l'invito. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Solo output. Il ruolo invitato nell'account.
target_type

TargetType

Solo output. Specifica i tipi di target da visualizzare nella risposta.
Campo di unione target. Indica il target dell'invito. target può essere solo uno dei seguenti:
target_account

Account

L'account sparso per questo invito.
target_location

TargetLocation

La località target a cui è indirizzato questo invito.

TargetLocation

Rappresenta una località di destinazione per un invito in attesa.

Campi
location_name

string

Il nome della posizione in cui l'utente è invitato.
address

string

L'indirizzo della posizione in cui l'utente è invitato.

TargetType

Il tipo di target a cui è destinato un invito.

Enum
TARGET_TYPE_UNSPECIFIED Impostato quando il tipo di target non è specificato.
ACCOUNTS_ONLY Elenca gli inviti solo per i target di tipo Account.
LOCATIONS_ONLY Elenca gli inviti solo per i target di tipo Località.

ListAccountAdminsRequest

Messaggio di richiesta per AccessControl.ListAccountAdmins.

Campi
parent

string

Obbligatorio. Il nome dell'account da cui recuperare un elenco di amministratori. accounts/{account_id}/admins.

ListAccountAdminsResponse

Messaggio di risposta per AccessControl.ListAccountAdmins.

Campi
account_admins[]

Admin

Una raccolta di istanze di amministrazione.

ListAccountsRequest

Messaggio di richiesta per Accounts.ListAccounts.

Campi
parent_account

string

Campo facoltativo. Il nome della risorsa dell'account per il quale deve essere recuperato l'elenco di account direttamente accessibili. Questo ha senso solo per le organizzazioni e i gruppi di utenti. Se vuoto, restituirà ListAccounts per l'utente autenticato. accounts/{account_id}.
page_size

int32

Campo facoltativo. Il numero di account da recuperare per pagina. Il valore predefinito e massimo è 20.
page_token

string

Campo facoltativo. Se specificato, viene recuperata la pagina successiva degli account. Il valore pageToken viene restituito quando una chiamata a accounts.list restituisce più risultati di quanti possano rientrare nelle dimensioni della pagina richieste.
filter

string

Campo facoltativo. Un filtro che vincola gli account da restituire. La risposta include solo le voci che corrispondono al filtro. Se filter è vuoto, non vengono applicati vincoli e tutti gli account (suddivisi in pagine) vengono recuperati per l'account richiesto.

Ad esempio, una richiesta con il filtro type=USER_GROUP restituirà solo gruppi di utenti.

Il campo type è l'unico filtro supportato.

ListAccountsResponse

Messaggio di risposta per Accounts.ListAccounts.

Campi
accounts[]

Account

Una raccolta di account a cui l'utente ha accesso. L'account personale dell'utente che esegue la query sarà sempre il primo elemento del risultato, a meno che non venga filtrato.
next_page_token

string

Se il numero di account supera le dimensioni di pagina richieste, questo campo viene completato con un token per recuperare la pagina successiva di account in una chiamata successiva a accounts.list. Se non ci sono altri account, questo campo non è presente nella risposta.

ListInvitationsRequest

Messaggio di richiesta per AccessControl.ListInviti.

Campi
parent

string

Obbligatorio. Il nome dell'account da cui viene recuperato l'elenco di inviti. accounts/{account_id}/invitations
filter

string

Campo facoltativo. Il filtro della risposta è supportato tramite il campo Inviti.target_type.

ListInvitationsResponse

Messaggio di risposta per AccessControl.ListInvitis.

Campi
invitations[]

Invitation

Una raccolta di inviti in attesa per l'account. Il numero di inviti qui elencato non può essere maggiore di 1000.

ListLocationAdminsRequest

Messaggio di richiesta per AccessControl.ListLocationAdmins.

Campi
parent

string

Obbligatorio. Il nome della sede di cui elencare gli amministratori. locations/{location_id}/admins.

ListLocationAdminsResponse

Messaggio di risposta per AccessControl.ListLocationAdmins.

Campi
admins[]

Admin

Una raccolta di amministratori.

TransferLocationRequest

Messaggio di richiesta per AccessControl.TransferLocation.

Campi
name

string

Obbligatorio. Il nome della sede da trasferire. locations/{location_id}.
destination_account

string

Obbligatorio. Nome della risorsa dell'account a cui trasferire la località (ad esempio "accounts/{account}").

UpdateAccountAdminRequest

Messaggio di richiesta per AccessControl.UpdateAccountAdmin.

Campi
account_admin

Admin

Obbligatorio. La versione aggiornata della pagina Amministrazione.
update_mask

FieldMask

Obbligatorio. I campi specifici da aggiornare. L'unico campo modificabile è il ruolo.

UpdateAccountRequest

Messaggio di richiesta per Account.UpdateAccount.

Campi
account

Account

Obbligatorio. L'account aggiornato.
update_mask

FieldMask

Obbligatorio. I campi specifici da aggiornare. L'unico campo modificabile è accountName.
validate_only

bool

Campo facoltativo. Se il valore è true, la richiesta viene convalidata senza aggiornare effettivamente l'account.

UpdateLocationAdminRequest

Messaggio di richiesta per AccessControl.UpdateLocationAdmin.

Campi
location_admin

Admin

Obbligatorio. La versione aggiornata della pagina Amministrazione.
update_mask

FieldMask

Obbligatorio. I campi specifici da aggiornare. L'unico campo modificabile è il ruolo.