firebase::gma::RequestConfiguration

#include <types.h>

Global configuration that will be used for every AdRequest.

Summary

Set the configuration via SetRequestConfiguration.

Public types
MaxAdContentRating{
  kMaxAdContentRatingUnspecified = -1,
  kMaxAdContentRatingG,
  kMaxAdContentRatingMA,
  kMaxAdContentRatingPG,
  kMaxAdContentRatingT
} 		enum
A maximum ad content rating, which may be configured via max_ad_content_rating.
TagForChildDirectedTreatment{
  kChildDirectedTreatmentUnspecified = -1,
  kChildDirectedTreatmentFalse,
  kChildDirectedTreatmentTrue
} 		enum
Specify whether you would like your app to be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).
TagForUnderAgeOfConsent{
  kUnderAgeOfConsentUnspecified = -1,
  kUnderAgeOfConsentFalse,
  kUnderAgeOfConsentTrue
} 		enum
Configuration values to mark your app to receive treatment for users in the European Economic Area (EEA) under the age of consent.

Public attributes
max_ad_content_rating
Sets a maximum ad content rating.
tag_for_child_directed_treatment
Allows you to specify whether you would like your app to be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - http://business.ftc.gov/privacy-and-security/childrens-privacy.
tag_for_under_age_of_consent
This value allows you to mark your app to receive treatment for users in the European Economic Area (EEA) under the age of consent.
test_device_ids
std::vector< std::string >
Sets a list of test device IDs corresponding to test devices which will always request test ads.

Public types

MaxAdContentRating

 firebase::gma::RequestConfiguration::MaxAdContentRating

A maximum ad content rating, which may be configured via max_ad_content_rating.

Properties
kMaxAdContentRatingG

Content suitable for general audiences, including families.

kMaxAdContentRatingMA

Content suitable only for mature audiences.

kMaxAdContentRatingPG

Content suitable for most audiences with parental guidance.

kMaxAdContentRatingT

Content suitable for teen and older audiences.

kMaxAdContentRatingUnspecified

No content rating has been specified.

TagForChildDirectedTreatment

 firebase::gma::RequestConfiguration::TagForChildDirectedTreatment

Specify whether you would like your app to be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

Values defined here may be configured via tag_for_child_directed_treatment.

Properties
kChildDirectedTreatmentFalse

Indicates that your app should not be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

kChildDirectedTreatmentTrue

Indicates that your app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

kChildDirectedTreatmentUnspecified

Indicates that ad requests will include no indication of how you would like your app treated with respect to COPPA.

TagForUnderAgeOfConsent

 firebase::gma::RequestConfiguration::TagForUnderAgeOfConsent

Configuration values to mark your app to receive treatment for users in the European Economic Area (EEA) under the age of consent.

Values defined here should be configured via tag_for_under_age_of_consent.

Properties
kUnderAgeOfConsentFalse

Indicates the publisher specified that the ad request should not receive treatment for users in the European Economic Area (EEA) under the age of consent.

kUnderAgeOfConsentTrue

Indicates the publisher specified that the ad request should receive treatment for users in the European Economic Area (EEA) under the age of consent.

kUnderAgeOfConsentUnspecified

Indicates that the publisher has not specified whether the ad request should receive treatment for users in the European Economic Area (EEA) under the age of consent.

Public attributes

max_ad_content_rating

MaxAdContentRating firebase::gma::RequestConfiguration::max_ad_content_rating

Sets a maximum ad content rating.

GMA ads returned for your app will have a content rating at or below that level.

tag_for_child_directed_treatment

TagForChildDirectedTreatment firebase::gma::RequestConfiguration::tag_for_child_directed_treatment

Allows you to specify whether you would like your app to be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA) - http://business.ftc.gov/privacy-and-security/childrens-privacy.

If you set this value to RequestConfiguration.kChildDirectedTreatmentTrue, you will indicate that your app should be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

If you set this value to RequestConfiguration.kChildDirectedTreatmentFalse, you will indicate that your app should not be treated as child-directed for purposes of the Children’s Online Privacy Protection Act (COPPA).

If you do not set this value, or set this value to RequestConfiguration.kChildDirectedTreatmentUnspecified, ad requests will include no indication of how you would like your app treated with respect to COPPA.

By setting this value, you certify that this notification is accurate and you are authorized to act on behalf of the owner of the app. You understand that abuse of this setting may result in termination of your Google account.

TagForUnderAgeOfConsent firebase::gma::RequestConfiguration::tag_for_under_age_of_consent

This value allows you to mark your app to receive treatment for users in the European Economic Area (EEA) under the age of consent.

This feature is designed to help facilitate compliance with the General Data Protection Regulation (GDPR). Note that you may have other legal obligations under GDPR. Please review the European Union's guidance and consult with your own legal counsel. Please remember that Google's tools are designed to facilitate compliance and do not relieve any particular publisher of its obligations under the law.

When using this feature, a Tag For Users under the Age of Consent in Europe (TFUA) parameter will be included in all ad requests. This parameter disables personalized advertising, including remarketing, for that specific ad request. It also disables requests to third-party ad vendors, such as ad measurement pixels and third-party ad servers.

If you set this value to RequestConfiguration.kUnderAgeOfConsentTrue, you will indicate that you want your app to be handled in a manner suitable for users under the age of consent.

If you set this value to RequestConfiguration.kUnderAgeOfConsentFalse, you will indicate that you don't want your app to be handled in a manner suitable for users under the age of consent.

If you do not set this value, or set this value to kUnderAgeOfConsentUnspecified, your app will include no indication of how you would like your app to be handled in a manner suitable for users under the age of consent.

test_device_ids

std::vector< std::string > firebase::gma::RequestConfiguration::test_device_ids

Sets a list of test device IDs corresponding to test devices which will always request test ads.