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 Firebase e le app Firebase di un progetto.

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

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

• Aggiungi i servizi Firebase al tuo progetto
• Aggiungi app Firebase al tuo progetto Firebase
• Collega il progetto Firebase a un account Google Analytics

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

Per informazioni sulla gestione degli accessi per l'API Firebase Management, consulta la documentazione dell'API Cloud Identity and 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 utilizzando la console Google Cloud.

Consulta Informazioni sui progetti Firebase per i dettagli sul numero di progetti consentiti per account.

Prima di iniziare

Prima di iniziare, devi attivare l'API di gestione 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 ancora fatto, devi abilitare 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 ti trovi in un ambiente Google Cloud, imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sul percorso della chiave del service account.

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 service account:

import { initializeApp, applicationDefault } from "firebase-admin/app";

initializeApp();

async function getAccessToken() {
  try {
    const accessToken = await applicationDefault().getAccessToken();
    return accessToken.access_token;
  } catch (err) {
    console.error('Unable to get access token');
    console.error(err);
  }
}

Trova il nome della risorsa del progetto

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

Per chiamare questo endpoint:

• Devi disporre di un progetto Google Cloud esistente e di un token di accesso all'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 di richiesta di un elenco di progetti Google Cloud disponibili per Node.js:

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 nextPageToken che puoi utilizzare come parametro di query per visualizzare 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 i servizi Firebase. Tieni presente che il campo project fornisce il nome della risorsa univoco a livello globale 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.

Aggiungi i servizi Firebase al tuo progetto

I progetti Google Cloud possono usufruire dei servizi offerti da Firebase. In questa sezione imparerai ad aggiungere in modo programmatico i servizi Firebase al tuo progetto Google Cloud esistente. 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 di project.
• Un membro del progetto o un service account 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 completata correttamente.

Per verificare se l'operazione è andata a buon fine, puoi chiamare operations.get sull'operazione finché il valore di done non è true e il relativo 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 di response è FirebaseProject, il progetto Google Cloud ora dispone dei servizi Firebase. La risposta contiene anche altre informazioni utili sul FirebaseProject appena creato, come il suo projectNumber e il suo resources predefinito. La Operation viene eliminata automaticamente al termine.

Aggiungi app Firebase al tuo progetto

Molte app diverse possono utilizzare un FirebaseProject, tra cui app per iOS, Android e web. In questa sezione imparerai ad aggiungere app Firebase alle tue app FirebaseProject esistenti 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+

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

RICHIEDI

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

• Obbligatorio:

  • bundleId: l'ID pacchetto canonico dell'app per iOS così come appare nell'App Store per iOS.

• Facoltativo, ma consigliato:

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

  • appStoreId: l'ID Apple generato automaticamente e assegnato alla tua app da Apple. Specifica un appStoreId se è già stato assegnato da Apple.

Nel corpo della richiesta per il nostro esempio, utilizzeremo solo un displayName e bundleId:

{
  "displayName": "My Firebase iOS App",
  "bundleId": "com.firebase.ios"
}

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

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

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

  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.iosApps.create è un Operation. Prima di poter chiamare altri endpoint correlati a Firebase per il tuo progetto, l'operazione deve essere completata correttamente.

Per verificare se l'operazione è andata a buon fine, puoi chiamare operations.get sull'operazione finché il valore di done non è true e il relativo response non è di tipo IosApp. 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.IosApp",
    "name": "projects/first-cloud-project/iosApps/...",
    "appId": "...",
    "displayName": "My Firebase iOS App",
    "projectId": "first-cloud-project",
    "bundleId": "com.firebase.ios"
  }
}

Poiché done è true e il tipo response è un IosApp, FirebaseProject ora ha un IosApp. La risposta contiene anche altre informazioni utili sulla tua app Firebase per iOS appena creata, come l'appId Firebase univoco. La Operation viene eliminata automaticamente al termine.

Android

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 viene visualizzato in Google Play Console.

• 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 completata correttamente.

Per verificare se l'operazione è andata a buon fine, puoi chiamare operations.get sull'operazione finché il valore di done non è true e il relativo response non è di tipo AndroidApp. 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.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, FirebaseProject ora ha un AndroidApp. La risposta contiene anche altre informazioni utili sulla tua app per Android Firebase appena creata, come l'ID Firebase univoco appId. La Operation viene eliminata automaticamente dopo il completamento.

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 appena creata di ShaCertificate.

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 gradle signingReport:

./gradlew signingReport

Per saperne di più, consulta API di Google per Android.

Web

Puoi aggiungere un'app web Firebase al tuo progetto Firebase esistente.

RICHIEDI

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

• Facoltativamente,

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

• Non consigliato:

  • appUrls: gli URL completi in cui è ospitata l'app. Quando un'app web Firebase è associata a un sito Firebase Hosting, Firebase compila automaticamente questi campi, quindi lasciali vuoti nel corpo della richiesta.

Per il nostro esempio, specificheremo solo un displayName nel corpo della richiesta:

{
  "displayName": "My Firebase Web App"
}

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

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

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

  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.webApps.create è un Operation. Prima di poter chiamare altri endpoint correlati a Firebase per il tuo progetto, l'operazione deve essere completata correttamente.

Per verificare se l'operazione è andata a buon fine, puoi chiamare operations.get sull'operazione finché il valore di done non è true e il relativo response non è di tipo WebApp. 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.WebApp",
    "name": "projects/first-cloud-project/webApps/...",
    "appId": "...",
    "displayName": "My Firebase Web App",
    "projectId": "first-cloud-project"
  }
}

Poiché done è true e il tipo response è WebApp, FirebaseProject ora ha un WebApp. La risposta contiene anche altre informazioni utili sulla tua app web Firebase appena creata, come l'ID Firebase univoco appId. La Operation viene eliminata automaticamente al termine.

(Facoltativo) Collega 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 all'interno dell'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 alle app Firebase esistenti nel tuo FirebaseProject (in base a packageName o bundleId associati allo stream di dati). Poi, a seconda dei casi, 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, ne vengono creati di nuovi nella proprietà Google Analytics per ciascuna delle tue app Firebase. Tieni presente che viene sempre eseguito il provisioning di un nuovo stream di dati per un'app web, anche se in precedenza era associata 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 nel tuo progetto Firebase sono presenti app web Firebase prima di collegare il progetto a Google Analytics, gli oggetti di configurazione Firebase per queste app verranno aggiornati con un nuovo campo measurementId. Questo oggetto di configurazione aggiornato è necessario affinché la tua app web possa utilizzare Analytics. Chiama projects.webApps.getConfig per ottenere 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 eseguirà il provisioning di una nuova proprietà Google Analytics e la assocerà a 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 completata correttamente.

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, il relativo 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 di response è analyticsDetails, FirebaseProject è ora collegato all'account Google Analytics specificato. Il Operation viene eliminato automaticamente al termine.