GoogleMobileAds Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
GADCustomEventRequest
@interface GADCustomEventRequest : NSObject
Specifies optional ad request targeting parameters that are provided by the publisher and are
forwarded to custom events for purposes of populating an ad request to a 3rd party ad network.
-
Keywords set in GADRequest. Returns nil if no keywords are set.
Declaration
Swift
var userKeywords: [Any]? { get }
Objective-C
@property (nonatomic, copy, readonly, nullable) NSArray *userKeywords;
-
The additional parameters set by the application. This property lets you pass additional
information from your application to your Custom Event object. To do so, create an instance of
GADCustomEventExtras to pass to GADRequest -registerAdNetworkExtras:. The instance should have
an NSDictionary set for a particular custom event label. That NSDictionary becomes the
additionalParameters here.
Declaration
Swift
var additionalParameters: [AnyHashable : Any]? { get }
Objective-C
@property (nonatomic, copy, readonly, nullable) NSDictionary *additionalParameters;
-
Indicates whether the testing property has been set in GADRequest.
Declaration
Swift
var isTesting: Bool { get }
Objective-C
@property (nonatomic, readonly) BOOL isTesting;
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.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eGADCustomEventRequest\u003c/code\u003e objects pass optional ad request data from publishers to custom events, used for sending requests to third-party ad networks.\u003c/p\u003e\n"],["\u003cp\u003ePublishers can provide keywords, additional parameters, and testing indicators through a \u003ccode\u003eGADCustomEventRequest\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003euserKeywords\u003c/code\u003e are taken from the \u003ccode\u003eGADRequest\u003c/code\u003e and passed to custom event; \u003ccode\u003eadditionalParameters\u003c/code\u003e offer a way to send custom data; \u003ccode\u003eisTesting\u003c/code\u003e reflects the testing status from \u003ccode\u003eGADRequest\u003c/code\u003e.\u003c/p\u003e\n"]]],["`GADCustomEventRequest` provides ad request targeting parameters to custom events. It includes `userKeywords`, which are publisher-defined keywords from `GADRequest`. `additionalParameters` passes extra information as a dictionary from the application via `GADCustomEventExtras`. The `isTesting` property indicates if the testing flag was set in the original `GADRequest`. These parameters are read-only properties accessible in both Swift and Objective-C. The object is designed to allow a publisher to forward data to a third-party ad network.\n"],null,["# GoogleMobileAds Framework Reference\n\nGADCustomEventRequest\n=====================\n\n\n @interface GADCustomEventRequest : NSObject\n\nSpecifies optional ad request targeting parameters that are provided by the publisher and are\nforwarded to custom events for purposes of populating an ad request to a 3rd party ad network.\n- `\n ``\n ``\n `\n\n ### [userKeywords](#/c:objc(cs)GADCustomEventRequest(py)userKeywords)\n\n `\n ` \n Keywords set in GADRequest. Returns nil if no keywords are set. \n\n #### Declaration\n\n Swift \n\n var userKeywords: [Any]? { get }\n\n Objective-C \n\n @property (nonatomic, copy, readonly, nullable) NSArray *userKeywords;\n\n- `\n ``\n ``\n `\n\n ### [additionalParameters](#/c:objc(cs)GADCustomEventRequest(py)additionalParameters)\n\n `\n ` \n The additional parameters set by the application. This property lets you pass additional\n information from your application to your Custom Event object. To do so, create an instance of\n GADCustomEventExtras to pass to GADRequest -registerAdNetworkExtras:. The instance should have\n an NSDictionary set for a particular custom event label. That NSDictionary becomes the\n additionalParameters here. \n\n #### Declaration\n\n Swift \n\n var additionalParameters: [AnyHashable : Any]? { get }\n\n Objective-C \n\n @property (nonatomic, copy, readonly, nullable) NSDictionary *additionalParameters;\n\n- `\n ``\n ``\n `\n\n ### [isTesting](#/c:objc(cs)GADCustomEventRequest(py)isTesting)\n\n `\n ` \n Indicates whether the testing property has been set in GADRequest. \n\n #### Declaration\n\n Swift \n\n var isTesting: Bool { get }\n\n Objective-C \n\n @property (nonatomic, readonly) BOOL isTesting;"]]