Skip to content

AdMobConfiguration.md

Latest commit

 

History

History
56 lines (36 loc) · 2.81 KB

AdMobConfiguration.md

File metadata and controls

56 lines (36 loc) · 2.81 KB
Raw

AdMob Configuration

Debug builds always use Google's official test application ID and test ad-unit IDs. Do not test with production units during development.

Release builds read production IDs from local files that are intentionally ignored by Git. The IDs are included in the distributed app and are therefore not secret credentials, but this arrangement keeps them out of the public repository.

Local Release Builds

Create the local files from the committed templates:

cp src/MothballMobile/Properties/AdMob.Release.props.example src/MothballMobile/Properties/AdMob.Release.props
cp src/MothballMobile/Properties/appsettings.Release.example.json src/MothballMobile/Properties/appsettings.Release.json

Set the iOS application ID in AdMob.Release.props:

<AdMobApplicationId>ca-app-pub-YOUR_PUBLISHER_ID~YOUR_APPLICATION_ID</AdMobApplicationId>

Set the iOS app-open and banner unit IDs in appsettings.Release.json:

{
  "AdMob": {
    "AppOpenAdUnitId": "ca-app-pub-YOUR_PUBLISHER_ID/YOUR_APP_OPEN_UNIT_ID",
    "BannerAdUnitId": "ca-app-pub-YOUR_PUBLISHER_ID/YOUR_BANNER_UNIT_ID"
  }
}

AdMob.Release.props provides the build-time value required in the generated iOS Info.plist. appsettings.Release.json is packaged as a MAUI asset and provides the unit IDs at runtime. A Release app throws a clear startup error when the JSON file is missing or incomplete.

CI Builds

In CI, create the same two files from encrypted CI variables before building. Alternatively, pass the application ID as an MSBuild property:

dotnet build src/MothballMobile/MothballMobile.csproj -c Release -f net10.0-ios \
  -p:AdMobApplicationId=ca-app-pub-YOUR_PUBLISHER_ID~YOUR_APPLICATION_ID

The runtime JSON file is still required for Release banner and app-open units.

Do Not Store

Never add Google service-account JSON keys, OAuth client secrets, AdMob API refresh tokens, or backend credentials to either file. Those are actual secrets and belong in a backend or the CI provider's encrypted secret store.

Runtime Behavior

AdMob is initialized only for iOS and Android builds. Debug builds configure Google's official test IDs and disable the consent check; Release builds configure production IDs and retain the normal consent behavior.

BasePage adds a fixed-height banner host below each page's existing content on supported platforms. The host displays a development placeholder until a banner loads and restores the placeholder when loading fails. This preserves page layout and makes ad-loading failures non-blocking for the app's core inventory workflows.

Mac Catalyst and Windows do not create AdMob banner controls. AdMobSettings returns empty values for those targets so shared application composition can still resolve the settings service without platform-specific branching in feature view models.