GoogleMobileAds Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Create an instance of this class to set additional parameters for each custom event object. The
additional parameters for a custom event are keyed by the custom event label. These extras are
passed to your implementation of GADCustomEventBanner or GADCustomEventInterstitial.
-
Set additional parameters for the custom event with label |label|. To remove additional
parameters associated with |label|, pass in nil for |extras|.
Declaration
Swift
func setExtras(_ extras: [AnyHashable : Any]?, forLabel label: String)
Objective-C
- (void)setExtras:(nullable NSDictionary *)extras
forLabel:(nonnull NSString *)label;
-
Retrieve the extras for |label|.
Declaration
Swift
func extras(forLabel label: String) -> [AnyHashable : Any]?
Objective-C
- (nullable NSDictionary *)extrasForLabel:(nonnull NSString *)label;
-
Removes all the extras set on this instance.
Declaration
Swift
func removeAllExtras()
Objective-C
- (void)removeAllExtras;
-
Returns all the extras set on this instance.
Declaration
Swift
func allExtras() -> [AnyHashable : Any]
Objective-C
- (nonnull NSDictionary *)allExtras;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eGADCustomEventExtras\u003c/code\u003e allows setting additional parameters for custom event objects, keyed by the custom event label.\u003c/p\u003e\n"],["\u003cp\u003eThese extras are passed to your custom event implementations (like \u003ccode\u003eGADCustomEventBanner\u003c/code\u003e or \u003ccode\u003eGADCustomEventInterstitial\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eYou can set, retrieve, and remove extras for specific labels or all extras at once using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eThis class helps pass custom data to your ad network adapters for advanced customization.\u003c/p\u003e\n"]]],["`GADCustomEventExtras` manages additional parameters for custom event objects, keyed by a label. You can set parameters using `setExtras:forLabel:`, providing a dictionary for a specific label. Retrieve parameters for a label with `extrasForLabel:`. `removeAllExtras` clears all set parameters. `allExtras` returns a dictionary of all currently set extras. These extras are utilized in the implementations of `GADCustomEventBanner` or `GADCustomEventInterstitial`.\n"],null,["# GoogleMobileAds Framework Reference\n\nGADCustomEventExtras\n====================\n\n\n @interface GADCustomEventExtras : NSObject \u003c../Protocols.html#/c:objc(pl)GADAdNetworkExtras\u003e\n\nCreate an instance of this class to set additional parameters for each custom event object. The\nadditional parameters for a custom event are keyed by the custom event label. These extras are\npassed to your implementation of GADCustomEventBanner or GADCustomEventInterstitial.\n- `\n ``\n ``\n `\n\n ### [-setExtras:forLabel:](#/c:objc(cs)GADCustomEventExtras(im)setExtras:forLabel:)\n\n `\n ` \n Set additional parameters for the custom event with label \\|label\\|. To remove additional\n parameters associated with \\|label\\|, pass in nil for \\|extras\\|. \n\n #### Declaration\n\n Swift \n\n func setExtras(_ extras: [AnyHashable : Any]?, forLabel label: String)\n\n Objective-C \n\n - (void)setExtras:(nullable NSDictionary *)extras\n forLabel:(nonnull NSString *)label;\n\n- `\n ``\n ``\n `\n\n ### [-extrasForLabel:](#/c:objc(cs)GADCustomEventExtras(im)extrasForLabel:)\n\n `\n ` \n Retrieve the extras for \\|label\\|. \n\n #### Declaration\n\n Swift \n\n func extras(forLabel label: String) -\u003e [AnyHashable : Any]?\n\n Objective-C \n\n - (nullable NSDictionary *)extrasForLabel:(nonnull NSString *)label;\n\n- `\n ``\n ``\n `\n\n ### [-removeAllExtras](#/c:objc(cs)GADCustomEventExtras(im)removeAllExtras)\n\n `\n ` \n Removes all the extras set on this instance. \n\n #### Declaration\n\n Swift \n\n func removeAllExtras()\n\n Objective-C \n\n - (void)removeAllExtras;\n\n- `\n ``\n ``\n `\n\n ### [-allExtras](#/c:objc(cs)GADCustomEventExtras(im)allExtras)\n\n `\n ` \n Returns all the extras set on this instance. \n\n #### Declaration\n\n Swift \n\n func allExtras() -\u003e [AnyHashable : Any]\n\n Objective-C \n\n - (nonnull NSDictionary *)allExtras;"]]
