Configurare e gestire un progetto Firebase utilizzando l'API REST Management

L'API REST Firebase Management consente la configurazione e la gestione programmatica dei progetti Firebase, incluse le risorse e le app Firebase di un progetto.

Questa panoramica descrive il flusso di lavoro generale per aggiungere risorse e app Firebase a un Google Cloud progetto esistente che non utilizza ancora i servizi Firebase.

Puoi passare a sezioni specifiche di questa pagina se vuoi solo:

• Aggiungere i servizi Firebase al progetto
• Aggiungere app Firebase al progetto Firebase
• Collegare il progetto Firebase a un account Google Analytics

Prima di seguire i passaggi in questa pagina, assicurati di attivare l'API.

Per informazioni sulla gestione dell'accesso per l'API Firebase Management, consulta la documentazione dell'API Cloud Identity Access Management (IAM).

Nota: se non hai già un progetto Google Cloud, puoi crearne uno utilizzando il metodo projects.create nell'API Resource Manager Google Cloud o la console Google Cloud.

Visita la pagina Informazioni sui progetti Firebase per informazioni dettagliate sul numero di progetti consentiti per account.

Prima di iniziare

Prima di iniziare, devi abilitare l'API Management per il tuo progetto Google Cloud e generare il token di accesso.

Abilita l'API REST di gestione per il tuo progetto Google Cloud

Se non l'hai già fatto, devi attivare l'API Firebase Management per l'utilizzo con il tuo progetto Google Cloud.

1. Apri la pagina API Firebase Management nella console API di Google.
2. Quando richiesto, seleziona il tuo progetto Google Cloud.
3. Fai clic su Abilita nella pagina dell'API Firebase Management.

Genera il token di accesso API

Ecco un esempio per Node.js che recupera il token di accesso.

Innanzitutto, se non sei in un ambiente Google Cloud, imposta la variabile di ambiente Google Cloud sul percorso della chiave dell'account di servizio.GOOGLE_APPLICATION_CREDENTIALS

Linux o macOS

export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json"

Windows

Con PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\your\service-account-file.json"

Quindi, utilizza l'SDK Firebase Admin per ottenere un token di accesso dalle credenziali del tuo account di servizio:

const admin = require('firebase-admin');

function getAccessToken() {
  return admin.credential.applicationDefault().getAccessToken()
      .then(accessToken => {
        return accessToken.access_token;
      })
      .catch(err => {
        console.error('Unable to get access token');
        console.error(err);
      });
}

Trovare il nome della risorsa del progetto

Puoi trovare i Google Cloud progetti disponibili per l'aggiunta di servizi Firebase.

Per chiamare questo endpoint:

• Devi avere un progetto Google Cloud esistente e un token di accesso API.
• Un membro del progetto deve essere almeno un visualizzatore del progetto Google Cloud esistente.

RICHIEDI

Chiama availableProjects.list. Il corpo della richiesta per questa chiamata deve essere vuoto.

Ecco un esempio per Node.js per richiedere un elenco di progetti Google Cloud disponibili:

const fetch = require('node-fetch');

async function listProjects() {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/availableProjects';
  const options = {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    const projects = resp['projectInfo'];
    console.log('Project total: ' + projects.length);
    console.log('');
    for (let i in projects) {
      const project = projects[i];
      console.log('Project ' + i);
      console.log('ID: ' + project['project']);
      console.log('Display Name: ' + project['displayName']);
      console.log('');
    }
  } catch(err) {
    console.error(err);
  }
}

RISULTATO

Il corpo della risposta di una chiamata a availableProjects.list contiene un elenco di oggetti ProjectInfo. Se l'elenco dei progetti è troppo lungo, il corpo della risposta contiene anche un valore nextPageToken che puoi utilizzare come parametro di query per ottenere la pagina successiva dei progetti.

Ecco un esempio di corpo della risposta di una chiamata availableProjects.list:

{
  "projectInfo": [
    {
      "project": "projects/first-cloud-project",
      "displayName": "First Cloud Project"
    },
    {
      "project": "projects/second-cloud-project",
      "displayName": "Second Cloud Project"
    }
  ]
}

Questa risposta di esempio contiene due progetti Google Cloud a cui è possibile aggiungere servizi Firebase. Tieni presente che il campo project fornisce il nome della risorsa univoco a livello mondiale per un progetto.

Puoi utilizzare qualsiasi valore project elencato nella risposta di availableProjects.list per aggiungere servizi Firebase o aggiungere app al tuo progetto.

Nella sezione successiva aggiungeremo i servizi Firebase a First Cloud Project utilizzando il nome della risorsa projects/first-gcp-project.

Aggiungere i servizi Firebase al progetto

I progetti Google Cloud possono usufruire dei servizi offerti da Firebase. In questa sezione scoprirai come aggiungere i servizi Firebase al tuo progetto Google Cloud esistente tramite programmazione. Tieni presente che puoi anche aggiungere i servizi Firebase al tuo progetto Google Cloud esistente nella console Firebase.

Per chiamare questo endpoint:

• Devi disporre di un progetto Google Cloud esistente, di un token di accesso all'API e del nome della risorsa univoco del tuo project.
• Un membro del progetto o un account di servizio deve disporre delle seguenti autorizzazioni. Se sei un editor o un proprietario del progetto Google Cloud esistente, disponi di queste autorizzazioni.
  firebase.projects.update
resourcemanager.projects.get
serviceusage.services.enable
serviceusage.services.get

RICHIEDI

Chiama projects.addFirebase. Il corpo della richiesta per questa chiamata deve essere vuoto.

Ecco un esempio per Node.js per aggiungere i servizi Firebase al tuo progetto Google Cloud:

const fetch = require('node-fetch');

async function addFirebase(projectId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + ':addFirebase';
  const options = {
    method: 'POST',
    // Use a manual access token here since explicit user access token is required.
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

RISULTATO

Il risultato di una chiamata a projects.addFirebase è un Operation. Prima di poter chiamare altri endpoint correlati a Firebase per il tuo progetto, l'operazione deve essere riuscita.

Per verificare se l'operazione è riuscita, puoi chiamare operations.get sull'operazione finché il valore di done non è true e il suo response non è di tipo FirebaseProject. Se l'operazione non va a buon fine, il relativo error viene impostato su google.rpc.Status.

Ecco il corpo della risposta di una chiamata operations.get:

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.FirebaseProject",
    "projectId": "first-cloud-project",
    "projectNumber": "...",
    "displayName": "First Cloud Project",
    "name": "projects/first-cloud-project",
    "resources": {
      "hostingSite": "first-cloud-project",
      "realtimeDatabaseInstance": "first-cloud-project"
    }
  }
}

Poiché done è true e il tipo response è FirebaseProject, il progetto Google Cloud ora dispone dei servizi Firebase. La risposta contiene anche altre informazioni utili sul FirebaseProject appena creato, ad esempio il projectNumber e il resources predefinito. Il Operation viene eliminato automaticamente al termine dell'operazione.

Aggiungere app Firebase al progetto

Molte app diverse possono utilizzare un FirebaseProject, tra cui app per iOS, Android e web. In questa sezione, scoprirai come aggiungere app Firebase a quelle esistentiFirebaseProject in modo programmatico. Tieni presente che puoi anche aggiungere app Firebase al tuo progetto Firebase esistente nella console Firebase.

Per chiamare gli endpoint in questa sezione:

• Devi disporre di un token di accesso all'API e di un FirebaseProject esistente.
• Un membro del progetto deve essere un editor o un proprietario del progetto Firebase esistente.

Seleziona un tipo di app Firebase da aggiungere al tuo progetto Firebase.

iOS Android Web

Puoi aggiungere un'app per Android Firebase al tuo progetto Firebase esistente.

RICHIEDI

Chiama projects.androidApps.create. Ecco come creare il corpo della richiesta:

• Obbligatorio:

  • packageName: il nome del pacchetto canonico dell'app per Android come appare nella Console per gli sviluppatori Google Play.

• Facoltativo, ma consigliato:

  • displayName: il nome visualizzato dell'app assegnato dall'utente. Questo valore è utile per trovare l'app in un secondo momento nella console Firebase.

Nel corpo della richiesta per il nostro esempio, utilizzeremo packageName e displayName:

{
  "displayName": "My Firebase Android App"
  "packageName": "com.firebase.android"
}

Ecco un esempio per Node.js per aggiungere un'app Firebase per Android al tuo progetto Firebase:

const fetch = require('node-fetch');

async function addAndroidApp(projectId, displayName, packageName) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + '/androidApps';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'displayName': displayName,
      'packageName': packageName
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

RISULTATO

Il risultato di una chiamata a projects.androidApps.create è un Operation. Prima di poter chiamare altri endpoint correlati a Firebase per il tuo progetto, l'operazione deve essere riuscita.

Per verificare se l'operazione è riuscita, puoi chiamare operations.get sull'operazione finché il valore di done non è true e il suo response è di tipo AndroidApp. Se l'operazione non va a buon fine, error viene impostato su google.rpc.Status.

Ecco il corpo della risposta di una chiamata operations.get:

{
  "name": "operations/...",
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.AndroidApp",
    "name": "projects/first-cloud-project/androidApps/...",
    "appId": "...",
    "displayName": "My Firebase Android App",
    "projectId": "first-cloud-project",
    "packageName": "com.firebase.android"
  }
}

Poiché done è true e il tipo response è un AndroidApp, il FirebaseProject ora ha un AndroidApp. La risposta contiene anche altre informazioni utili sulla tua app Firebase per Android appena creata, ad esempio il valore appId Firebase univoco. Il Operation viene eliminato automaticamente al termine.

Aggiungi certificati SHA

Puoi aggiungere certificati SHA a qualsiasi app Firebase per Android esistente chiamando projects.androidApps.sha.create. Il corpo della richiesta per questa chiamata al metodo deve avere un campo name vuoto. Il risultato di questa chiamata è un'istanza di ShaCertificate appena creata.

Quando chiami projects.androidApps.sha.create, devi fornire un hash del certificato SHA-1 o SHA-256 valido. Puoi ottenere l'hash SHA del tuo certificato di firma con il comando signingReport di Gradle:

./gradlew signingReport

Per ulteriori informazioni, visita la pagina API di Google per Android.

(Facoltativo) Collegare il progetto Firebase a un account Google Analytics

Puoi collegare un account Google Analytics esistente al tuo FirebaseProject esistente in modo programmatico. Tieni presente che puoi anche collegare il tuo progetto Firebase esistente a Google Analytics nella scheda Integrazioni delle Impostazioni progetto.

Per chiamare questo endpoint:

• Devi disporre di un token di accesso all'API e di un FirebaseProject esistente.
• Un membro del progetto deve essere un proprietario del progetto Firebase esistente.

La chiamata a projects.addGoogleAnalytics richiede un analytics_resource, che può essere un analyticsAccountId o un analyticsPropertyId:

• Specifica un analyticsAccountId esistente per eseguire il provisioning di una nuova proprietà Google Analytics nell'account specificato e associa la nuova proprietà al tuo progetto Firebase.

• Specifica un analyticsPropertyId esistente per associare la proprietà Google Analytics al tuo progetto Firebase.

Puoi trovare sia il tuo analyticsAccountId sia eventuali analyticsPropertyId esistenti sul sito web di Google Analytics.

Quando chiami projects.addGoogleAnalytics:

1. Il primo controllo determina se gli stream di dati esistenti nella proprietà Google Analytics corrispondono ad app Firebase esistenti nel tuo FirebaseProject (in base al packageName o al bundleId associato allo stream di dati). Successivamente, in base alle esigenze, gli stream di dati e le app vengono collegati. Tieni presente che questo collegamento automatico si applica solo alle app per Android e iOS.

2. Se non vengono trovati stream di dati corrispondenti per le tue app Firebase, nella proprietà Google Analytics viene eseguito il provisioning di nuovi stream di dati per ciascuna delle tue app Firebase. Tieni presente che per un'app web viene sempre eseguito il provisioning di un nuovo stream di dati, anche se in precedenza era associato a uno stream di dati nella tua proprietà Analytics.

Scopri di più sulla gerarchia e sulla struttura degli account Google Analytics nella documentazione di Analytics.

Nota: se hai app web Firebase nel tuo progetto Firebase prima di collegarlo a Google Analytics, gli oggetti di configurazione Firebase per queste app verranno aggiornati con un nuovo campo measurementId. Questo oggetto di configurazione aggiornato è obbligatorio per l'utilizzo di Analytics da parte della tua app web. Chiama projects.webApps.getConfig per ottenere gli oggetti di configurazione aggiornati.

RICHIEDI

Chiama projects.addGoogleAnalytics.

Nel corpo della richiesta per la nostra chiamata di esempio a project.addGoogleAnalytics, specificheremo il nostro account Google Analytics analyticsAccountId. Questa chiamata effettuerà il provisioning di una nuova proprietà Google Analytics e la associerà al FirebaseProject.

{
  "analyticsAccountId": "<your-google-analytics-account-id>"
}

Ecco un esempio per Node.js per collegare un progetto Firebase a un account Google Analytics:

const fetch = require('node-fetch');

async function addGoogleAnalytics(projectId, analyticsAccountId) {
  const accessToken = getAccessToken();
  const uri = 'https://firebase.googleapis.com/v1beta1/projects/' + projectId + ':addGoogleAnalytics';
  const options = {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + accessToken,
    },
    body: JSON.stringify({
      'analyticsAccountId': analyticsAccountId
    }),
  };

  try {
    const rawResponse = await fetch(uri, options);
    const resp = await rawResponse.json();
    console.log(resp);
  } catch(err) {
    console.error(err['message']);
  }
}

RISULTATO

Il risultato di una chiamata a projects.addGoogleAnalytics è un Operation. Prima di poter chiamare altri endpoint correlati a Firebase per il tuo progetto, l'operazione deve essere riuscita.

Per verificare se l'operazione è andata a buon fine, puoi chiamare operations.get sull'operazione finché il valore di done non è true e response non è di tipo analyticsDetails. Se l'operazione non va a buon fine, error viene impostato su google.rpc.Status.

Ecco il corpo della risposta di una chiamata operations.get:

{
  "name": "operations/...",
  "none": true,
  "response": {
    "@type": "type.googleapis.com/google.firebase.service.v1beta1.AnalyticsDetails",
    "analyticsProperty": [
      {
        "id": "...",
        "displayName": "..."
      }
    ],
    "streamMappings": [
      {
        "app": "...",
        "streamId": "...",
        "measurementId": "..."
      }
    ]
  }
}

Poiché done è true e il tipo response è analyticsDetails, FirebaseProject ora è collegato all'account Google Analytics specificato. Il Operation viene eliminato automaticamente al termine.