Enumerations
This section describes all enumerations used throughout the PloxTools: Google AdMob plugin.
Enumerations define fixed sets of values used to represent consent state, privacy requirements, banner configuration, ad errors, and runtime ad events. They are available in both Blueprint and C++.
Each enumeration is documented with its possible values and a description of its purpose.
Consent & Privacy
EConsentStatus
Represents the current Google UMP consent status.
This enumeration is returned by consent-related functions such as RequestConsent and GetConsentStatus.
| Value | Description |
|---|---|
| Unknown | The user's consent status is unknown. |
| Required | User consent is required but has not yet been obtained. |
| Not Required | User consent is not required. |
| Obtained | The required user consent has been obtained. |
EPrivacyOptionsRequirementStatus
Represents whether the application should provide a user-accessible entry point to the privacy options form.
This enumeration is returned by GetPrivacyOptionsRequirementStatus.
| Value | Description |
|---|---|
| Unknown | The privacy options requirement status has not yet been determined. |
| Required | The application must provide a way for the user to open the privacy options form. |
| Not Required | A privacy options entry point is not required. |
EAgeRestrictedTreatment
Defines the age-related treatment applied to subsequent Google Mobile Ads requests.
This enumeration is used by SetAgeRestrictedTreatment.
| Value | Description |
|---|---|
| Unspecified | No specific age-restricted treatment signal is applied to ad requests. |
| Child | Ad requests receive child age treatment. |
| Teen | Ad requests receive teen age treatment. |
EFormErrorCode
Represents an error returned while requesting or displaying a Google UMP form.
This enumeration is returned through consent and privacy form failure delegates.
| Value | Description |
|---|---|
| Unknown | An unknown consent form error occurred. |
| Internal Error | An internal SDK error occurred while requesting or showing the consent form. |
| Internet Error | A network connection error occurred while requesting or showing the consent form. |
| Invalid Operation | The consent form operation is invalid or was requested at an unexpected time. |
| Time Out | The consent form request timed out. |
Banner Configuration
EBannerAdSize
Defines the size used when loading a banner ad.
This enumeration is passed to LoadBanner.
| Value | Description |
|---|---|
| Banner | Standard 320 × 50 banner ad size. |
| Large Banner | Large 320 × 100 banner ad size. |
| Medium Rectangle | Medium rectangle 300 × 250 banner ad size. |
| Full Banner | Full banner 468 × 60 ad size. |
| Leaderboard | Leaderboard 728 × 90 banner ad size. |
| Anchored Adaptive | Anchored adaptive banner size that automatically adjusts to the current screen width. |
EBannerGravity
Defines the screen position used when displaying a banner.
This enumeration is passed to ShowBanner. Horizontal and vertical offsets can be applied in addition to the selected position.
| Value | Description |
|---|---|
| Top Left | Displays the banner in the top-left corner of the screen. |
| Top Center | Displays the banner at the top-center of the screen. |
| Top Right | Displays the banner in the top-right corner of the screen. |
| Middle Left | Displays the banner at the middle-left side of the screen. |
| Middle Center | Displays the banner at the center of the screen. |
| Middle Right | Displays the banner at the middle-right side of the screen. |
| Bottom Left | Displays the banner in the bottom-left corner of the screen. |
| Bottom Center | Displays the banner at the bottom-center of the screen. |
| Bottom Right | Displays the banner in the bottom-right corner of the screen. |
Ad Errors
EAdErrorCode
Represents an error returned while loading or displaying an ad.
This enumeration is returned through ad load and show failure delegates.
| Value | Description |
|---|---|
| Internal Error | An internal SDK error occurred while loading or displaying the ad. |
| Invalid Request | The ad request is invalid, for example because of incorrect parameters or an invalid Ad Unit ID. |
| Network Error | A network connection error occurred while loading the ad. |
| No Fill | No ad inventory is currently available for the request. |
| App ID Missing | The AdMob App ID is missing or was not configured correctly. |
| Mediation No Fill | The mediation adapter did not return an ad. |
| Request ID Mismatch | The ad callback belongs to an outdated or mismatched request. |
| Invalid Ad String | The provided ad string is invalid. |
| Already Loading | The requested ad is already loading. |
| Already Loaded | The requested ad is already loaded. |
| Ad Unit ID Missing | The Ad Unit ID is missing or empty. |
| Unknown | An unknown or unsupported ad error occurred. |
Ad Events
EBannerAdEventType
Represents a runtime event reported by a banner ad.
This enumeration is returned through the banner event delegate.
| Value | Description |
|---|---|
| Opened | The banner ad has been opened or expanded. |
| Clicked | The user clicked the banner ad. |
| Closed | The banner ad was closed. |
| Impression | An impression was recorded for the banner ad. |
EFullScreenAdEventType
Represents a runtime event reported by a fullscreen ad.
This enumeration is used by Interstitial, Rewarded, Rewarded Interstitial, and App Open ad event delegates.
| Value | Description |
|---|---|
| Clicked | The user clicked the fullscreen ad. |
| Impression | An impression was recorded for the fullscreen ad. |