Interfejs Firebase Management REST API umożliwia automatyczną konfigurację projektów w Firebase i zarządzanie nimi, w tym zasobami Firebase i aplikacjami w Firebase.
To omówienie opisuje ogólny proces dodawania zasobów i aplikacji Firebase do istniejącego projektu Google Cloud, który nie korzysta jeszcze z usług Firebase.
Możesz przejść do konkretnych sekcji tej strony, jeśli chcesz:
- Dodawanie usług Firebase do projektu
- Dodawanie aplikacji w Firebase do projektu w Firebase
- Łączenie projektu w Firebase z kontem Google Analytics
Zanim wykonasz czynności opisane na tej stronie, włącz interfejs API.
Informacje o zarządzaniu dostępem do interfejsu Firebase Management API znajdziesz w dokumentacji interfejsu Cloud Identity Access Management (IAM) API.
Zanim zaczniesz
Zanim zaczniesz, musisz włączyć interfejs API zarządzania Google Analytics w projekcie Google Cloud i wygenerować token dostępu.
Włączanie interfejsu Management REST API w projekcie Google Cloud
Jeśli jeszcze tego nie zrobiono, musisz włączyć Firebase Management API do użycia w projekcie Google Cloud.
- Otwórz stronę Firebase Management API w konsoli interfejsów API Google.
- Gdy pojawi się prośba, wybierz projekt Google Cloud.
- Na stronie Firebase Management API kliknij Włącz.
Generowanie tokena dostępu do interfejsu API
Oto przykład kodu w Node.js, który pobiera token dostępu.
Najpierw, jeśli nie jesteś w środowisku Google Cloud, ustaw zmienną środowiskową GOOGLE_APPLICATION_CREDENTIALS na ścieżkę do klucza konta usługi.
Linux lub macOS
export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json"
Windows
W PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\your\service-account-file.json"
Następnie użyj pakietu Firebase Admin SDK, aby uzyskać token dostępu z danych logowania konta usługi:
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);
}
}
Znajdowanie nazwy zasobu projektu
Możesz znaleźć projekty Google Cloud, do których można dodać usługi Firebase.
WYŚLIJ PROŚBĘ
Zadzwoń pod numer availableProjects.list.
Treść żądania dla tego wywołania musi być pusta.
Oto przykład żądania listy dostępnych projektów Google Cloud w 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);
}
}
WYNIK
Treść odpowiedzi na wywołanie availableProjects.list zawiera listę obiektów ProjectInfo. Jeśli lista projektów jest zbyt długa, treść odpowiedzi zawiera też parametr nextPageToken, którego możesz użyć jako parametru zapytania, aby wyświetlić następną stronę projektów.
Oto przykładowa treść odpowiedzi na wywołanie availableProjects.list:
{
"projectInfo": [
{
"project": "projects/first-cloud-project",
"displayName": "First Cloud Project"
},
{
"project": "projects/second-cloud-project",
"displayName": "Second Cloud Project"
}
]
}
Ta przykładowa odpowiedź zawiera 2 projekty Google Cloud, do których można dodać usługi Firebase. Pamiętaj, że pole project zawiera globalnie unikalną nazwę zasobu projektu.
Możesz użyć dowolnej wartości project podanej w odpowiedzi z availableProjects.list, aby dodać usługi Firebase lub dodać aplikacje do projektu.
W następnej sekcji dodamy usługi Firebase do First Cloud Project, używając nazwy zasobu projects/first-gcp-project.
Dodawanie usług Firebase do projektu
Projekty Google Cloud mogą korzystać z usług oferowanych przez Firebase. W tej sekcji dowiesz się, jak automatycznie dodawać usługi Firebase do istniejącego projektu Google Cloud. Pamiętaj, że możesz też dodać usługi Firebase do istniejącego projektu Google Cloud w konsoli Firebase.
WYŚLIJ PROŚBĘ
Zadzwoń pod numer projects.addFirebase.
Treść żądania dla tego wywołania musi być pusta.
Oto przykład dodawania usług Firebase do projektu Google Cloud w Node.js:
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']);
}
}
WYNIK
Wynikiem wywołania projects.addFirebase jest Operation. Zanim będzie można wywołać inne punkty końcowe związane z Firebase dla projektu, operacja musi zakończyć się powodzeniem.
Aby sprawdzić, czy operacja się powiodła, możesz wywołać operations.get, dopóki wartość done nie będzie wynosić true, a response nie będzie typu FirebaseProject. Jeśli operacja się nie powiedzie, jej error zostanie ustawione na google.rpc.Status.
Oto treść odpowiedzi na wywołanie 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"
}
}
}
Ponieważ done to true, a typ response to FirebaseProject, projekt Google Cloud ma teraz usługi Firebase. Odpowiedź zawiera też inne przydatne informacje o nowo utworzonym zasobie FirebaseProject, takie jak projectNumber i domyślny resources. Po zakończeniu Operation jest automatycznie usuwany.
Dodawanie aplikacji w Firebase do projektu
Z FirebaseProject może korzystać wiele różnych aplikacji, w tym aplikacje na iOS, Androida i aplikacje internetowe. W tej sekcji dowiesz się, jak programowo dodawać aplikacje w Firebase do istniejącego konta FirebaseProject. Pamiętaj, że możesz też dodawać aplikacje Firebase do dotychczasowego projektu Firebase w konsoli Firebase.
Wybierz typ aplikacji w Firebase, którą chcesz dodać do projektu w Firebase.
iOS+
Do istniejącego projektu Firebase możesz dodać aplikację Firebase na iOS.
WYŚLIJ PROŚBĘ
Zadzwoń pod numer projects.iosApps.create.
Oto jak utworzyć treść żądania:
Wymagane:
bundleId: kanoniczny identyfikator pakietu aplikacji na iOS, który pojawia się w sklepie iOS App Store.
Rozwiązanie opcjonalne, ale zalecane:
displayName: przypisana przez użytkownika wyświetlana nazwa aplikacji. Ta wartość jest przydatna do późniejszego znajdowania aplikacji w konsoli Firebase.appStoreId: automatycznie wygenerowany identyfikator Apple ID przypisany do aplikacji przez Apple. PodajappStoreId, jeśli został już przypisany przez Apple.
W treści żądania w naszym przykładzie użyjemy tylko parametrów displayName i bundleId:
{
"displayName": "My Firebase iOS App",
"bundleId": "com.firebase.ios"
}
Oto przykład dodawania aplikacji Firebase na iOS do projektu Firebase w Node.js:
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']);
}
}
WYNIK
Wynikiem wywołania projects.iosApps.create jest Operation. Zanim będzie można wywołać inne punkty końcowe związane z Firebase dla projektu, operacja musi zakończyć się powodzeniem.
Aby sprawdzić, czy operacja się powiodła, możesz wywołać operations.get, dopóki wartość done nie będzie wynosić true, a response nie będzie typu IosApp. Jeśli operacja się nie powiedzie, jej error zostanie ustawione na google.rpc.Status.
Oto treść odpowiedzi na wywołanie 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"
}
}
Ponieważ done to true, a typ response to IosApp, FirebaseProject ma teraz IosApp. Odpowiedź zawiera też inne przydatne informacje o nowo utworzonej aplikacji Firebase na iOS, takie jak unikalny identyfikator appId. Po zakończeniu Operation zostanie automatycznie usunięty.
Android
Do istniejącego projektu Firebase możesz dodać aplikację Firebase na Androida.
WYŚLIJ PROŚBĘ
Zadzwoń pod numer projects.androidApps.create.
Oto jak utworzyć treść żądania:
Wymagane:
packageName: kanoniczna nazwa pakietu aplikacji na Androida, która pojawia się w Konsoli Google Play.
Rozwiązanie opcjonalne, ale zalecane:
displayName: przypisana przez użytkownika wyświetlana nazwa aplikacji. Ta wartość jest przydatna do późniejszego znajdowania aplikacji w konsoli Firebase.
W treści żądania w naszym przykładzie użyjemy parametrów packageName i displayName:
{
"displayName": "My Firebase Android App"
"packageName": "com.firebase.android"
}
Oto przykład dodawania aplikacji Firebase na Androida do projektu Firebase w Node.js:
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']);
}
}
WYNIK
Wynikiem wywołania projects.androidApps.create jest Operation. Zanim będzie można wywołać inne punkty końcowe związane z Firebase dla projektu, operacja musi zakończyć się powodzeniem.
Aby sprawdzić, czy operacja się powiodła, możesz wywołać operations.get, dopóki wartość done nie będzie wynosić true, a response nie będzie typu AndroidApp. Jeśli operacja się nie powiedzie, jej error zostanie ustawione na google.rpc.Status.
Oto treść odpowiedzi na wywołanie 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"
}
}
Ponieważ done to true, a typ response to AndroidApp, FirebaseProject ma teraz AndroidApp. Odpowiedź zawiera też inne przydatne informacje o nowo utworzonej aplikacji Firebase na Androida, takie jak unikalny identyfikator Firebase appId. Po zakończeniu Operation jest automatycznie usuwany.
Dodawanie certyfikatów SHA
Certyfikaty SHA możesz dodać do dowolnej istniejącej aplikacji Firebase na Androida, wywołując metodę projects.androidApps.sha.create.
Treść żądania dla tego wywołania metody musi zawierać puste pole name.
Wynikiem tego wywołania jest nowo utworzona instancja ShaCertificate.
Podczas wywoływania projects.androidApps.sha.create musisz podać prawidłowy hasz certyfikatu SHA-1 lub SHA-256. Skrót SHA certyfikatu podpisywania możesz uzyskać za pomocą polecenia gradle signingReport:
./gradlew signingReport
Więcej informacji znajdziesz w artykule Interfejsy API Google na Androida.
Sieć
Do istniejącego projektu w Firebase możesz dodać aplikację internetową Firebase.
WYŚLIJ PROŚBĘ
Zadzwoń pod numer projects.webApps.create.
Oto jak utworzyć treść żądania:
Opcjonalnie:
displayName: przypisana przez użytkownika wyświetlana nazwa aplikacji. Ta wartość jest przydatna do późniejszego znajdowania aplikacji w konsoli Firebase.
Niezalecane:
appUrls: pełne adresy URL, pod którymi hostowana jest aplikacja. Gdy aplikacja internetowa Firebase jest powiązana z witryną Firebase Hosting, Firebase automatycznie wypełnia te pola, więc pozostaw je puste w treści żądania.
W naszym przykładzie w treści żądania podamy tylko displayName:
{
"displayName": "My Firebase Web App"
}
Oto przykład dodawania aplikacji internetowej Firebase do projektu Firebase w Node.js:
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']);
}
}
WYNIK
Wynikiem wywołania projects.webApps.create jest Operation. Zanim będzie można wywołać inne punkty końcowe związane z Firebase dla projektu, operacja musi zakończyć się powodzeniem.
Aby sprawdzić, czy operacja się powiodła, możesz wywołać operations.get, dopóki wartość done nie będzie wynosić true, a response nie będzie typu WebApp. Jeśli operacja się nie powiedzie, jej error zostanie ustawione na google.rpc.Status.
Oto treść odpowiedzi na wywołanie 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"
}
}
Ponieważ done to true, a typ response to WebApp, FirebaseProject ma teraz WebApp. Odpowiedź zawiera też inne przydatne informacje o nowo utworzonej aplikacji internetowej Firebase, takie jak unikalny identyfikator appId. Po zakończeniu Operation zostanie automatycznie usunięty.
Łączenie projektu w Firebase z kontem Google Analytics (opcjonalnie)
Możesz automatycznie połączyć istniejące konto Google Analytics z istniejącym kontem FirebaseProject. Pamiętaj, że możesz też połączyć dotychczasowy projekt w Firebase z Google Analytics na karcie Integracje w Ustawieniach projektu.
Wywołanie projects.addGoogleAnalytics wymaga parametru analytics_resource, który może być wartością analyticsAccountId lub analyticsPropertyId:
Podaj istniejący
analyticsAccountId, aby udostępnić nową usługę w Google Analytics na określonym koncie i powiązać ją z projektem w Firebase.Podaj istniejący identyfikator
analyticsPropertyId, aby powiązać usługę w Google Analytics z projektem Firebase.
Zarówno analyticsAccountId, jak i dotychczasowe analyticsPropertyId znajdziesz w witrynie Google Analytics.
Gdy dzwonisz pod numer projects.addGoogleAnalytics:
Pierwsza kontrola określa, czy istniejące strumienie danych w usłudze w Google Analytics odpowiadają istniejącym aplikacjom w Firebase w
FirebaseProject(na podstawiepackageNamelubbundleIdpowiązanych ze strumieniem danych). Następnie strumienie danych i aplikacje zostaną połączone. Pamiętaj, że to automatyczne łączenie dotyczy tylko aplikacji na Androida i aplikacji na iOS.Jeśli nie zostaną znalezione żadne odpowiednie strumienie danych dla aplikacji Firebase, w usłudze w Google Analytics zostaną utworzone nowe strumienie danych dla każdej z aplikacji Firebase. Pamiętaj, że dla aplikacji internetowej zawsze jest udostępniany nowy strumień danych, nawet jeśli była ona wcześniej powiązana ze strumieniem danych w usłudze w Analytics.
Więcej informacji o hierarchii i strukturze kont Google Analytics znajdziesz w dokumentacji Analytics.
WYŚLIJ PROŚBĘ
Zadzwoń pod numer projects.addGoogleAnalytics.
W treści żądania przykładowego wywołania project.addGoogleAnalytics podamy nasze konto Google Analytics analyticsAccountId. To wywołanie spowoduje udostępnienie nowej usługi w Google Analytics i powiązanie jej z FirebaseProject.
{
"analyticsAccountId": "<your-google-analytics-account-id>"
}
Oto przykład kodu w Node.js, który łączy projekt w Firebase z kontem 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']);
}
}
WYNIK
Wynikiem wywołania projects.addGoogleAnalytics jest Operation. Zanim będzie można wywołać inne punkty końcowe związane z Firebase dla projektu, operacja musi zakończyć się powodzeniem.
Aby sprawdzić, czy operacja się powiodła, możesz wywołać operations.get na operacji, dopóki wartość done nie będzie wynosić true, a response nie będzie typu analyticsDetails. Jeśli operacja się nie powiedzie, jej error zostanie ustawione na google.rpc.Status.
Oto treść odpowiedzi na wywołanie operations.get:
{
"name": "operations/...",
"none": true,
"response": {
"@type": "type.googleapis.com/google.firebase.service.v1beta1.AnalyticsDetails",
"analyticsProperty": [
{
"id": "...",
"displayName": "..."
}
],
"streamMappings": [
{
"app": "...",
"streamId": "...",
"measurementId": "..."
}
]
}
}
Ponieważ done ma wartość true, a typ response to analyticsDetails, FirebaseProject jest teraz połączony z podanym kontem Google Analytics. Po zakończeniu zadania Operation jest automatycznie usuwany.