GoogleMobileAds Framework Reference

  • GADCustomEventExtras allows setting additional parameters for custom event objects, keyed by the custom event label.

  • These extras are passed to your custom event implementations (like GADCustomEventBanner or GADCustomEventInterstitial).

  • You can set, retrieve, and remove extras for specific labels or all extras at once using the provided methods.

  • This class helps pass custom data to your ad network adapters for advanced customization.

GADCustomEventExtras


@interface GADCustomEventExtras : NSObject <GADAdNetworkExtras>

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;