Skip to content

Commit

Permalink
Internal change
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 551255742
  • Loading branch information
Justin Malandruccolo authored and maddevrelgithubbot committed Jul 26, 2023
1 parent 49dafb2 commit 011a5f8
Show file tree
Hide file tree
Showing 11 changed files with 67 additions and 232 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2014 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2014 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2014 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -26,23 +26,15 @@ NS_ASSUME_NONNULL_BEGIN

@property(class, atomic, readonly, strong, nonnull) GoogleMobileAdsConsentManager *sharedInstance;
@property(nonatomic, readonly) BOOL canRequestAds;
@property(nonatomic, readonly) BOOL isFormAvailable;
@property(nonatomic, readonly) BOOL isPrivacyOptionsFormRequired;

/// Helper method to call the UMP SDK methods to request consent information and load/present a
/// consent form if necessary.
///
/// @param viewController The view controller to present the user consent form on screen.
/// @param completionHandler The block to execute after consent gathering finishes.
- (void)gatherConsentFromConsentPresentationViewController:(UIViewController *)viewController
consentGatheringComplete:
(void (^)(NSError *_Nullable error))completionHandler;

/// Helper method to call the UMP SDK method to present the privacy options form.
///
/// Attempts to load a new privacy options form upon completion.
///
/// @param viewController The view controller to present the privacy options form on screen.
/// @param completionHandler The block to execute after the presentation finishes.
- (void)presentPrivacyOptionsFormFromViewController:(UIViewController *)viewController
completionHandler:
(void (^)(NSError *_Nullable error))completionHandler;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2014 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand All @@ -19,12 +19,6 @@
#import <GoogleMobileAds/GoogleMobileAds.h>
#import <UserMessagingPlatform/UserMessagingPlatform.h>

@interface GoogleMobileAdsConsentManager ()

/// The UMP SDK consent form.
@property(nonatomic, strong) UMPConsentForm *form;

@end

@implementation GoogleMobileAdsConsentManager

Expand All @@ -38,12 +32,12 @@ + (instancetype)sharedInstance {
}

- (BOOL)canRequestAds {
return UMPConsentInformation.sharedInstance.consentStatus == UMPConsentStatusNotRequired ||
UMPConsentInformation.sharedInstance.consentStatus == UMPConsentStatusObtained;
return UMPConsentInformation.sharedInstance.canRequestAds;
}

- (BOOL)isFormAvailable {
return UMPConsentInformation.sharedInstance.formStatus == UMPFormStatusAvailable;
- (BOOL)isPrivacyOptionsFormRequired {
return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus ==
UMPPrivacyOptionsRequirementStatusRequired;
}

- (void)gatherConsentFromConsentPresentationViewController:(UIViewController *)viewController
Expand All @@ -56,104 +50,31 @@ - (void)gatherConsentFromConsentPresentationViewController:(UIViewController *)v
// debugSettings.geography = UMPDebugGeographyEEA;
parameters.debugSettings = debugSettings;

__weak __typeof__(self) weakSelf = self;
// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
requestConsentInfoUpdateWithParameters:parameters
completionHandler:^(NSError *_Nullable requestConsentError) {
if (requestConsentError) {
consentGatheringComplete(requestConsentError);
} else {
[weakSelf handleRequestConsentInfoFromViewController:viewController
completionHandler:
consentGatheringComplete];
[UMPConsentForm
loadAndPresentIfRequiredFromViewController:viewController
completionHandler:^(
NSError
*_Nullable loadAndPresentError) {
// Consent has been gathered.
consentGatheringComplete(
loadAndPresentError);
}];
}
}];
}

- (void)handleRequestConsentInfoFromViewController:(UIViewController *_Nonnull)viewController
completionHandler:
(void (^_Nonnull)(NSError *_Nullable))completionHandler {
__weak __typeof__(self) weakSelf = self;
[self loadAndPresentFormFromViewControllerIfRequired:viewController
completionHandler:^(NSError *_Nullable loadAndPresentError) {
// Consent has been gathered.
completionHandler(loadAndPresentError);
// Your app needs to allow the user to change their consent
// status at any time. Load another form and store it so
// it's ready to be displayed immediately after the user
// clicks your app's privacy settings button.
[weakSelf loadPrivacyOptionsFormIfRequired];
}];
}

- (void)loadAndPresentFormFromViewControllerIfRequired:(UIViewController *)viewController
completionHandler:
(void (^)(NSError *_Nullable))completionHandler {
// Determine the consent-related action to take based on the UMPConsentStatus.
if (UMPConsentInformation.sharedInstance.consentStatus == UMPConsentStatusNotRequired ||
UMPConsentInformation.sharedInstance.consentStatus == UMPConsentStatusObtained) {
// Consent has already been gathered or not required.
completionHandler(nil);
return;
}

[UMPConsentForm loadWithCompletionHandler:^(UMPConsentForm *_Nullable consentForm,
NSError *_Nullable loadError) {
if (loadError) {
completionHandler(loadError);
} else {
[consentForm presentFromViewController:viewController
completionHandler:^(NSError *_Nullable formError) {
completionHandler(formError);
}];
}
}];
}

- (void)loadPrivacyOptionsFormIfRequired {
// No privacy options form needed if consent form is not available.
if (!self.isFormAvailable) {
return;
}

__weak __typeof__(self) weakSelf = self;
[UMPConsentForm loadWithCompletionHandler:^(UMPConsentForm *_Nullable consentForm,
NSError *_Nullable loadError) {
if (loadError) {
// See UMPFormErrorCode for more info.
return NSLog(@"Error: %@", [loadError localizedDescription]);
} else {
weakSelf.form = consentForm;
}
}];
}

- (void)presentPrivacyOptionsFormFromViewController:(UIViewController *)viewController
completionHandler:
(void (^)(NSError *_Nullable))completionHandler {
if (!self.form) {
completionHandler([NSError
errorWithDomain:@"com.google"
code:0
userInfo:@{NSLocalizedDescriptionKey : @"No form available."}]);

// Your app needs to allow the user to change their consent status at any
// time. Load another form and store it so it's ready to be displayed
// immediately after the user clicks your app's privacy settings button.
[self loadPrivacyOptionsFormIfRequired];
return;
}

[self.form presentFromViewController:viewController
completionHandler:^(NSError *_Nullable formError) {
completionHandler(formError);

// Your app needs to allow the user to change their consent status at any
// time. Load another form and store it so it's ready to be displayed
// immediately after the user clicks your app's privacy settings button.
[self loadPrivacyOptionsFormIfRequired];
}];
[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
completionHandler:completionHandler];
}

@end
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2014 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down
10 changes: 5 additions & 5 deletions Objective-C/admob/BannerExample/BannerExample/ViewController.m
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2014 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -76,20 +76,20 @@ - (void)viewDidLoad {
}

if (GoogleMobileAdsConsentManager.sharedInstance.canRequestAds) {
[strongSelf startGoogleMobileAdsSDKOnce];
[strongSelf startGoogleMobileAdsSDK];
}

[strongSelf.privacySettingsButton
setEnabled:GoogleMobileAdsConsentManager.sharedInstance
.isFormAvailable];
.isPrivacyOptionsFormRequired];
}];

if (GoogleMobileAdsConsentManager.sharedInstance.canRequestAds) {
[self startGoogleMobileAdsSDKOnce];
[self startGoogleMobileAdsSDK];
}
}

- (void)startGoogleMobileAdsSDKOnce {
- (void)startGoogleMobileAdsSDK {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// Initialize the Google Mobile Ads SDK.
Expand Down
24 changes: 12 additions & 12 deletions Objective-C/admob/BannerExample/Podfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,30 @@ PODS:
- GoogleUtilities/Network (~> 7.11)
- "GoogleUtilities/NSData+zlib (~> 7.11)"
- nanopb (< 2.30910.0, >= 2.30908.0)
- GoogleUserMessagingPlatform (2.0.1)
- GoogleUtilities/AppDelegateSwizzler (7.11.1):
- GoogleUserMessagingPlatform (2.1.0)
- GoogleUtilities/AppDelegateSwizzler (7.11.4):
- GoogleUtilities/Environment
- GoogleUtilities/Logger
- GoogleUtilities/Network
- GoogleUtilities/Environment (7.11.1):
- GoogleUtilities/Environment (7.11.4):
- PromisesObjC (< 3.0, >= 1.2)
- GoogleUtilities/Logger (7.11.1):
- GoogleUtilities/Logger (7.11.4):
- GoogleUtilities/Environment
- GoogleUtilities/MethodSwizzler (7.11.1):
- GoogleUtilities/MethodSwizzler (7.11.4):
- GoogleUtilities/Logger
- GoogleUtilities/Network (7.11.1):
- GoogleUtilities/Network (7.11.4):
- GoogleUtilities/Logger
- "GoogleUtilities/NSData+zlib"
- GoogleUtilities/Reachability
- "GoogleUtilities/NSData+zlib (7.11.1)"
- GoogleUtilities/Reachability (7.11.1):
- "GoogleUtilities/NSData+zlib (7.11.4)"
- GoogleUtilities/Reachability (7.11.4):
- GoogleUtilities/Logger
- nanopb (2.30909.0):
- nanopb/decode (= 2.30909.0)
- nanopb/encode (= 2.30909.0)
- nanopb/decode (2.30909.0)
- nanopb/encode (2.30909.0)
- PromisesObjC (2.2.0)
- PromisesObjC (2.3.1)

DEPENDENCIES:
- Google-Mobile-Ads-SDK
Expand All @@ -62,10 +62,10 @@ SPEC REPOS:
SPEC CHECKSUMS:
Google-Mobile-Ads-SDK: 69daa7fb42061b425340706e382e87fab3e666a3
GoogleAppMeasurement: 2d800fab85e7848b1e66a6f8ce5bca06c5aad892
GoogleUserMessagingPlatform: 5f8b30daf181805317b6b985bb51c1ff3beca054
GoogleUtilities: 9aa0ad5a7bc171f8bae016300bfcfa3fb8425749
GoogleUserMessagingPlatform: dce302b8f1b84d6e945812ee7a15c3f65a102cbf
GoogleUtilities: c63691989bf362ba0505507da00eeb326192e83e
nanopb: b552cce312b6c8484180ef47159bc0f65a1f0431
PromisesObjC: 09985d6d70fbe7878040aa746d78236e6946d2ef
PromisesObjC: c50d2056b5253dadbd6c2bea79b0674bd5a52fa4

PODFILE CHECKSUM: 1a20a497bcb7223f0fd3886913b5dce10e17dcb5

Expand Down
6 changes: 4 additions & 2 deletions Swift/admob/BannerExample/BannerExample/AppDelegate.swift
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//
// Copyright (C) 2015 Google LLC
// Copyright (C) 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -27,7 +27,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {

print("Google Mobile Ads SDK version: \(GADMobileAds.sharedInstance().sdkVersion)")
print(
"Google Mobile Ads SDK version: \(GADGetStringFromVersionNumber(GADMobileAds.sharedInstance().versionNumber))"
)

return true
}
Expand Down
Loading

0 comments on commit 011a5f8

Please sign in to comment.