Skip to content

Developer Documentation

Jump to bottom
Michael Prentice edited this page Jul 26, 2015 · 16 revisions

Developer Documentation

Build System

The project is using the gradle build system.

Configuration

All secret API keys are stored in keys.xml

Furthermore, you need to use the settings/debug.keystore for signing as it is whitelisted for Google Plus Sign-in.

###play_app_id The play app id is used in the Android manifest for

  • com.google.android.gms.games.APP_ID
  • com.google.android.gms.appstate.APP_ID

If the key is missing G+ sign-in will not work. This has to come from one of the GDG-X team members after you have signed and submitted the CLA.

###android_simple_api_access_key This key is used for Google maps (com.google.android.maps.v2.API_KEY) and to initialise the YouTubePlayerSupportFragment.

Generate your developer key by creating a Cloud Console API project and then going to APIs & auth and Credentials. Then Public API access->Create new key->Android Key.

###ip_simple_api_access_key This key is used to query the G+ API.

If the key is missing most content, like G+ profile images can't be loaded.

In your Cloud Console API project, go to APIs & auth and Credentials. Then Public API access->Create new key->Server Key.

###gcm_sender_id This id is the project id of the GDG[x] Hub.

mGcm.register(BuildConfig.GCM_SENDER_ID)

If the key is missing push notifications are not delivered. This will block the ability to log into the app unless you uncheck the GCM box when doing the initial sign in. Disabling GCM like this is recommended for most contributors.

###android_backup_key This key is used for the backup key in the Android manifest com.google.android.backup.api_key.

If the key is missing backup after re-install is not working.

You can register for the Android Backup Service to get a key.

###hub_client_id The hub client it is used to get a scoped auth token. This token is send to the hub for GCM.

scope = "audience:server:client_id:" + BuildConfig.HUB_CLIENT_ID

If the key is missing push notifications are not delivered. This has to come from one of the GDG-X team members after you have signed and submitted the CLA.

###Debug Build If the Game on Google Play Console is not published, only the registered testers can use the Google+ login in the debug build.

Contact a GDG-X member in Gitter to have your email added to the list of registered Play Games testers for the app.

GDG-X Hub/Google Developers Groups API

Event data are received from developers.google.com.

Tagged events are received from the GDG-X Hub server.

All api calls are wrapped in a ApiRequest.

Clone this wiki locally