Skip to content

Commit 66887d6

Browse files
Googlera-maurice
Googler
authored andcommitted
Add Ad Impression constants to public header
PiperOrigin-RevId: 334451358
1 parent 0acec23 commit 66887d6

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

analytics/ios_headers/FIREventNames.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,19 @@ static NSString *const kFIREventAddToCart NS_SWIFT_NAME(AnalyticsEventAddToCart)
6969
static NSString *const kFIREventAddToWishlist NS_SWIFT_NAME(AnalyticsEventAddToWishlist) =
7070
@"add_to_wishlist";
7171

72+
/// Ad Impression event. This event signifies when a user sees an ad impression. Params:
73+
///
74+
/// <ul>
75+
/// <li>@c kFIRParameterAdPlatform (NSString) (optional)</li>
76+
/// <li>@c kFIRParameterAdFormat (NSString) (optional)</li>
77+
/// <li>@c kFIRParameterAdSource (NSString) (optional)</li>
78+
/// <li>@c kFIRParameterAdUnitName (NSString) (optional)</li>
79+
/// <li>@c kFIRParameterCurrency (NSString) (optional)</li>
80+
/// <li>@c kFIRParameterValue (double as NSNumber) (optional)</li>
81+
/// </ul>
82+
static NSString *const kFIREventAdImpression NS_SWIFT_NAME(AnalyticsEventAdImpression) =
83+
@"ad_impression";
84+
7285
/// App Open event. By logging this event when an App becomes active, developers can understand how
7386
/// often users leave and return during the course of a Session. Although Sessions are automatically
7487
/// reported, this event can provide further clarification around the continuous engagement of

analytics/ios_headers/FIRParameterNames.h

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,17 @@
3939
static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParameterAchievementID) =
4040
@"achievement_id";
4141

42+
/// The ad format (e.g. Banner, Interstitial, Rewarded, Native, Rewarded Interstitial, Instream).
43+
/// (NSString).
44+
/// <pre>
45+
/// NSDictionary *params = @{
46+
/// kFIRParameterAdFormat : @"Banner",
47+
/// // ...
48+
/// };
49+
/// </pre>
50+
static NSString *const kFIRParameterAdFormat NS_SWIFT_NAME(AnalyticsParameterAdFormat) =
51+
@"ad_format";
52+
4253
/// Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format.
4354
/// <pre>
4455
/// NSDictionary *params = @{
@@ -49,6 +60,36 @@ static NSString *const kFIRParameterAchievementID NS_SWIFT_NAME(AnalyticsParamet
4960
static NSString *const kFIRParameterAdNetworkClickID
5061
NS_SWIFT_NAME(AnalyticsParameterAdNetworkClickID) = @"aclid";
5162

63+
/// The ad platform (e.g. MoPub, IronSource) (NSString).
64+
/// <pre>
65+
/// NSDictionary *params = @{
66+
/// kFIRParameterAdPlatform : @"MoPub",
67+
/// // ...
68+
/// };
69+
/// </pre>
70+
static NSString *const kFIRParameterAdPlatform NS_SWIFT_NAME(AnalyticsParameterAdPlatform) =
71+
@"ad_platform";
72+
73+
/// The ad source (e.g. AdColony) (NSString).
74+
/// <pre>
75+
/// NSDictionary *params = @{
76+
/// kFIRParameterAdSource : @"AdColony",
77+
/// // ...
78+
/// };
79+
/// </pre>
80+
static NSString *const kFIRParameterAdSource NS_SWIFT_NAME(AnalyticsParameterAdSource) =
81+
@"ad_source";
82+
83+
/// The ad unit name (NSString).
84+
/// <pre>
85+
/// NSDictionary *params = @{
86+
/// kFIRParameterAdUnitName : @"Banner_03",
87+
/// // ...
88+
/// };
89+
/// </pre>
90+
static NSString *const kFIRParameterAdUnitName NS_SWIFT_NAME(AnalyticsParameterAdUnitName) =
91+
@"ad_unit_name";
92+
5293
/// A product affiliation to designate a supplying company or brick and mortar store location
5394
/// (NSString). <pre>
5495
/// NSDictionary *params = @{

0 commit comments

Comments
 (0)