Stay organized with collections
Save and categorize content based on your preferences.
Builder
class Builder
A builder for WebTriggerParams.
Summary
Public constructors
Builder
Builder(registrationUri: Uri)
Builder constructor for WebTriggerParams. mIsDebugKeyAllowed is assigned false by default.
| Parameters |
registrationUri |
Uri: URI that the Attribution Reporting API sends a request to in order to obtain trigger registration parameters This value cannot be null. |
| Exceptions |
java.lang.IllegalArgumentException |
if the scheme for registrationUri is not HTTPS |
Public methods
setDebugKeyAllowed
fun setDebugKeyAllowed(debugKeyAllowed: Boolean): WebTriggerParams.Builder
Setter for debug allow/disallow flag. Setting it to true will allow parsing debug keys from registration responses and their addition in the generated reports.
| Parameters |
debugKeyAllowed |
Boolean: used by the browser to indicate whether the debug key obtained from the registration URI is allowed to be used |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 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-02-10 UTC."],[],[],null,["# WebTriggerParams.Builder\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [Ad Services Extensions 4](https://developer.android.com/sdkExtensions)\n\nBuilder\n=======\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/adservices/measurement/WebTriggerParams.Builder \"View this page in Java\") \n\n```\nclass Builder\n```\n\n|---|--------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.adservices.measurement.WebTriggerParams.Builder](#) |\n\nA builder for [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams).\n\nSummary\n-------\n\n| Public constructors ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [Builder](#Builder(android.net.Uri))`(`registrationUri:` `[Uri](../../net/Uri.html#)`)` Builder constructor for [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams). |\n\n| Public methods ||\n|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams) | [build](#build())`()` Builds immutable [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams). |\n| [WebTriggerParams.Builder](#) | [setDebugKeyAllowed](#setDebugKeyAllowed(kotlin.Boolean))`(`debugKeyAllowed:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Setter for debug allow/disallow flag. |\n\nPublic constructors\n-------------------\n\n### Builder\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [Ad Services Extensions 4](https://developer.android.com/sdkExtensions) \n\n```\nBuilder(registrationUri: Uri)\n```\n\nBuilder constructor for [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams). `mIsDebugKeyAllowed` is assigned false by default.\n\n| Parameters ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `registrationUri` | [Uri](../../net/Uri.html#): URI that the Attribution Reporting API sends a request to in order to obtain trigger registration parameters This value cannot be `null`. |\n\n| Exceptions ||\n|--------------------------------------|--------------------------------------------------|\n| `java.lang.IllegalArgumentException` | if the scheme for `registrationUri` is not HTTPS |\n\nPublic methods\n--------------\n\n### build\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [Ad Services Extensions 4](https://developer.android.com/sdkExtensions) \n\n```\nfun build(): WebTriggerParams\n```\n\nBuilds immutable [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams).\n\n| Return ||\n|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams) | immutable [WebTriggerParams](/reference/kotlin/android/adservices/measurement/WebTriggerParams) This value cannot be `null`. |\n\n### setDebugKeyAllowed\n\nAdded in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [Ad Services Extensions 4](https://developer.android.com/sdkExtensions) \n\n```\nfun setDebugKeyAllowed(debugKeyAllowed: Boolean): WebTriggerParams.Builder\n```\n\nSetter for debug allow/disallow flag. Setting it to true will allow parsing debug keys from registration responses and their addition in the generated reports.\n\n| Parameters ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `debugKeyAllowed` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html): used by the browser to indicate whether the debug key obtained from the registration URI is allowed to be used |\n\n| Return ||\n|-------------------------------|--------------------------------------|\n| [WebTriggerParams.Builder](#) | builder This value cannot be `null`. |"]]
