How fbsamples/audience-network works
Project Type and Purpose
• This is an open-source repository containing sample applications that demonstrate how to integrate and use Facebook’s Audience Network SDK on Android and iOS, and how to interact with the Facebook Audience Reporting API via Python scripts.
• It is not a single monolithic system but rather three distinct sample modules (Android, iOS, Python) all exercising the same external service (Audience Network).
File Structure Analysis
• Top-level:
• .github/workflows/main.yml → CI build & test
• README.md, CONTRIBUTING.md, LICENSE
• samples/android
• samples/ios
• samples/python
• Android samples: two variants (Java and Kotlin) each containing:
• build.gradle, Gradle wrapper, libs (AudienceNetwork.aar, DebugSettings.aar), source tree (Activities, Fragments, Adapters, Models)
• iOS samples: two variants (Objective-C AdUnitsSample and Swift FANSample) each containing:
• Xcode project files, Podfile, source (ViewControllers, Storyboards, Extensions, Utils)
• Python samples:
• reporting API scripts (adnw_requests.py, adnw_response.py, utility modules)
Key Insights from README
• Three sample categories: Android, iOS, Reporting API (Python)
• Purpose: demonstrate SDK initialization, ad unit loading/display, and reporting API usage
• External dependencies: Facebook Audience Network service endpoints and SDK binaries (AAR, CocoaPods)
Main Components
a. Sample Client Modules
• Android (Java), Android (Kotlin)
• iOS (Objective-C), iOS (Swift)
• Python reporting scripts
b. External Dependencies
• Facebook Audience Network SDK (distributed as AAR for Android, CocoaPods for iOS)
• Facebook Audience Network Ad Servers (ad request, ad response)
• Facebook Audience Reporting API endpoint
c. CI/CD
• GitHub Actions (build and smoke-test samples)
Relationships and Interactions
• Each sample client initializes the Audience Network SDK (via AudienceNetworkInitializeHelper on Android and Pod-provided APIs on iOS), then:
• Sends HTTP(S) ad requests to Audience Network servers
• Receives ad creative (JSON/XML/media)
• Renders ads in UI components (Fragments/Activities on Android, ViewControllers on iOS)
• Python scripts:
• Construct API calls to Reporting API
• Authenticate (via access tokens, parameters)
• Fetch and parse metrics data
• CI pipeline:
• Triggers builds of Android projects via Gradle and iOS via xcodebuild
• Runs linter/tests on Python scripts
Architectural Patterns and Principles
• Modular separation by platform
• Clear “Sample App → SDK → Remote Service” flow
• UI layer decoupled from SDK initialization and network logic
• Utility/helper modules centralize common tasks (logging, configuration, HTTP requests)
Essential Elements
• Annotations for protocols (Gradle, CocoaPods, pip), configuration files (Podfile, build.gradle) and CI triggers.