Plug-in do Gradle para os serviços do Google e arquivo de configuração JSON

Como parte da adição do Firebase ao seu projeto Android, é necessário adicionar o plug-in google-services do Gradle e um arquivo de configuração google-services.json ao projeto.

Se você adicionar o Firebase ao seu projeto Android usando o console do Firebase, a API REST de gerenciamento ou a CLI do Firebase, adicione manualmente o plug-in do Gradle e o arquivo de configuração JSON ao seu projeto. No entanto, se você usar o Firebase Assistant for Android Studio, essas tarefas serão feitas de maneira automática para você durante a configuração.

Adicionar o plug-in do Gradle

Adicione o plug-in do Gradle para Serviços do Google (google-services) ao seu arquivo build.gradle:

dependencies {
    classpath 'com.google.gms:google-services:4.5.0'
    // ...
}

O plug-in do Gradle para Serviços do Google tem duas funções principais:

  • Processa o arquivo de configuração google-services.json e produz recursos do Android que podem ser usados no código do app.

  • Adiciona dependências para bibliotecas básicas necessárias aos serviços que você ativou. Nesta etapa, é necessário aplicar o plug-in do Gradle para Serviços do Google no arquivo app/build.gradle, assim:
    apply plugin: 'com.google.gms.google-services'

    Para conferir o resultado dessa etapa, execute ./gradlew :app:dependencies.

Adicionar o arquivo de configuração JSON

O arquivo de configuração google-services.json geralmente é colocado no diretório app/ (na raiz do módulo do app Android Studio). A partir da versão 2.2.0 o plug-in é compatível com arquivos JSON específicos do tipo de build e da variação de produto. Todas as estruturas de diretório a seguir são válidas:

// dogfood and release are build types.
app/
    google-services.json
    src/dogfood/google-services.json
    src/release/google-services.json
    ...

Quando os variantes de produto estão em uso, essas estruturas de diretório mais complicadas também são válidas.

// free and paid are product flavors.
app/
    google-services.json
    src/dogfood/paid/google-services.json
    src/release/free/google-services.json
    ...

Como o arquivo de configuração JSON é processado

O arquivo de configuração google-services.json tem a seguinte estrutura básica:

{
  "project_info": {...},
  "client": [...],
}

O objeto project_info contém informações gerais sobre seu projeto, enquanto cada membro da matriz client contém informações sobre os clientes (apps Android) que você adicionou ao projeto.

Ao processar o arquivo JSON do seu app Android, o plug-in usa apenas o objeto client que corresponde ao nome do pacote (para o tipo de build atual) com base na seguinte lógica:

  • Para cada membro da matriz client, o plug-in verifica o valor de client_info/android_client_info/package_name. Se o nome do pacote corresponder a esse valor, ele vai retornar o objeto de membro.

  • Se nenhum dos membros de client corresponder ao nome do pacote, o plug-in vai gerar uma exceção.

O restante deste documento usa YOUR_CLIENT para se referir ao membro da matriz client determinado pela lógica descrita acima.

Produção de arquivos XML

O principal resultado do processamento JSON é a produção de dois arquivos XML que podem ser referenciados como recursos do Android no seu código. Confira exemplos de cada arquivo:

  • app/build/generated/res/google-services/{build_type}/values/values.xml

    <?xml version="1.0" encoding="utf-8"?>
<resources>

    <! -- Present in all applications -->
    <string name="google_app_id" translatable="false">1:1035469437089:android:73a4fb8297b2cd4f</string>

    <! -- Present in applications with the appropriate services configured -->
    <string name="gcm_defaultSenderId" translatable="false">1035469437089</string>
    <string name="default_web_client_id" translatable="false">337894902146-e4uksm38sne0bqrj6uvkbo4oiu4hvigl.apps.googleusercontent.com</string>
    <string name="ga_trackingId" translatable="false">UA-65557217-3</string>
    <string name="firebase_database_url" translatable="false">https://example-url.firebaseio.com</string>
    <string name="google_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="google_crash_reporting_api_key" translatable="false">AIzbSyCILMsOuUKwN3qhtxrPq7FFemDJUAXTyZ8</string>
    <string name="project_id" translatable="false">mydemoapp</string>

</resources>

  • app/build/generated/res/google-services/{flavor}/{build_type}/xml/global_tracker.xml

    <?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="ga_trackingId" translatable="false">UA-65557218-3</string>
</resources>

Valores nos arquivos XML

Todos os valores nos arquivos XML estão presentes no arquivo de configuração google-services.json nos locais listados abaixo. Se o projeto do Android tiver alguma configuração que impeça o uso do plug-in do Gradle google-services, recrie os arquivos XML manualmente usando esses valores.

  • google_app_id

    YOUR_CLIENT/client_info/mobilesdk_app_id

  • gcm_defaultSenderId

    project_info/project_number

  • default_web_client_id

    YOUR_CLIENT/oauth_client/client_id (client_type == 3)

  • ga_trackingId

    YOUR_CLIENT/services/analytics-service/analytics_property/tracking_id

  • firebase_database_url

    project_info/firebase_url

  • google_api_key

    YOUR_CLIENT/api_key/current_key

  • google_crash_reporting_api_key

    YOUR_CLIENT/api_key/current_key

  • project_id

    project_info/project_id

Solução de problemas

Ao criar, recebo a seguinte mensagem de erro: File google-services.json is missing from module root folder. The Google Services Plugin cannot function without it.

O console Firebase ajuda você a baixar o arquivo de configuração google-services.json.

Depois de baixar o arquivo de configuração google-services.json, copie-o para a pasta app/ do seu projeto do Android Studio ou para a pasta app/src/{build_type} se você estiver usando vários tipos de build.

Não consigo encontrar os símbolos R.string.gcm_defaultSenderId ou R.xml.global_tracker.

Verifique se o nome do pacote no arquivo build.gradle corresponde ao nome do pacote inserido ao criar o arquivo google-services.json. Se não tiver certeza, refaça o fluxo de início e receba um novo arquivo JSON.