Wählen Sie in der Dokumentation zur Privacy Sandbox für Android mit der Schaltfläche Entwicklervorschau oder Beta die Programmversion aus, mit der Sie arbeiten. Die Anleitungen können sich unterscheiden.
Die Attribution Reporting API wurde entwickelt, um den Datenschutz für Nutzer zu verbessern. Dabei wird die Abhängigkeit von dienstleisterübergreifenden Nutzerkennungen entfernt und gleichzeitig werden wichtige Anwendungsfälle für die Attributions- und Conversion-Analyse in Apps unterstützt. In diesem Entwicklerhandbuch wird beschrieben, wie Sie die Attribution Reporting APIs konfigurieren und testen, um Anzeigenklicks, -aufrufe und Conversions zu erfassen. Dazu werden Methoden aufgerufen, die die entsprechenden Trigger und Quellen für solche Ereignisse registrieren.
In diesem Leitfaden erfahren Sie, wie Sie Serverendpunkte einrichten und eine Client-App erstellen, die diese Dienste aufruft. Weitere Informationen zum Gesamtdesign der Attribution Reporting API finden Sie im Designvorschlag.
Wichtige Begriffe
- Attributionsquellen beziehen sich auf Klicks oder Aufrufe.
- Trigger sind Ereignisse, die Conversions zugeordnet werden können.
- Berichte enthalten Daten zu einem Trigger und der entsprechenden Attributionsquelle. Diese Berichte werden als Reaktion auf Triggerereignisse gesendet. Die Attribution Reporting API unterstützt Berichte auf Ereignisebene und Berichte mit zusammengefassten Daten.
Hinweis
Wenn Sie die Attribution Reporting API verwenden möchten, müssen Sie die in den folgenden Abschnitten aufgeführten server- und clientseitigen Aufgaben ausführen.
Endpunkte für die Attribution Reporting API einrichten
Für die Attribution Reporting API sind mehrere Endpunkte erforderlich, auf die Sie von einem Testgerät oder Emulator aus zugreifen können. Erstellen Sie einen Endpunkt für jede der folgenden serverseitigen Aufgaben:
- Attributionsquelle (Aufruf oder Klick) registrieren
- Trigger (Conversion) registrieren
- Berichte auf Ereignisebene akzeptieren
- Zusammenfassungsfähige Berichte akzeptieren
Es gibt mehrere Möglichkeiten, die erforderlichen Endpunkte einzurichten:
- Am schnellsten können Sie die OpenAPI v3-Dienstdefinitionen aus unserem Beispielcode-Repository auf einer Mock- oder Mikrodienstplattform bereitstellen. Sie können Postman, Prism oder eine andere Mock-Server-Plattform verwenden, die dieses Format akzeptiert. Stellen Sie jeden Endpunkt bereit und notieren Sie sich die URIs, die Sie in Ihrer App verwenden möchten. Um die Berichtsübermittlung zu überprüfen, sehen Sie sich die zuvor an die Mock- oder serverlose Plattform gesendeten Aufrufe an.
- Sie können einen eigenen eigenständigen Server mit dem Spring Boot-basierten Kotlin-Beispiel ausführen. Stellen Sie diesen Server bei Ihrem Cloud-Anbieter oder in Ihrer internen Infrastruktur bereit.
- Verwenden Sie die Dienstdefinitionen als Beispiele, um die Endpunkte in Ihr bestehendes System einzubinden.
Quellregistrierung akzeptieren
Dieser Endpunkt sollte über einen URI wie den folgenden erreichbar sein:
https://adtech.example/attribution_source
Wenn eine Client-App eine Attributionsquelle registriert, gibt sie den URI für diesen Serverendpunkt an. Die Attribution Reporting API sendet dann eine Anfrage und enthält einen der folgenden Header:
Für Klickereignisse:
Attribution-Reporting-Source-Info: navigation
Für Aufrufe von Ereignissen:
Attribution-Reporting-Source-Info: event
Konfigurieren Sie Ihren Serverendpunkt so, dass er mit Folgendem antwortet:
// Metadata associated with attribution source.
Attribution-Reporting-Register-Source: {
"destination": "[app package name]",
"web_destination": "[eTLD+1]",
"source_event_id": "[64 bit unsigned integer]",
"expiry": "[64 bit signed integer]",
"event_report_window": "[64-bit signed integer]",
"aggregatable_report_window": "[64-bit signed integer]",
"priority": "[64 bit signed integer]",
"filter_data": {
"[key name 1]": ["key1 value 1", "key1 value 2"],
"[key name 2]": ["key2 value 1", "key2 value 2"],
// Note: "source_type" key will be automatically generated as
// one of {"navigation", "event"}.
},
// Attribution source metadata specifying histogram contributions in aggregate
// report.
"aggregation_keys": {
"[key1 name]": "[key1 value]",
"[key2 name]": "[key2 value]",
},
"debug_key": "[64-bit unsigned integer]",
"debug_reporting": [boolean]
}
// Specify additional ad tech URLs to register this source with.
Attribution-Reporting-Redirect: <Ad Tech Partner URI 1>
Attribution-Reporting-Redirect: <Ad Tech Partner URI 2>
Hier ein Beispiel mit hinzugefügten Beispielwerten:
Attribution-Reporting-Register-Source: {
"destination": "android-app://com.example.advertiser",
"source_event_id": "234",
"expiry": "259200",
"event_report_window": "172800",
"aggregatable_report_window": "172800",
"priority": "5",
"filter_data": {
"product_id": ["1234"]
},
"aggregation_keys": {
// Generates a "0x159" key piece named (low order bits of the key) for the key
// named "campaignCounts".
// User saw an ad from campaign 345 (out of 511).
"campaignCounts": "0x159",
// Generates a "0x5" key piece (low order bits of the key) for the key named
// "geoValue".
// Source-side geo region = 5 (US), out of a possible ~100 regions.
"geoValue": "0x5",
},
// Opts in to receiving verbose debug reports
"debug_reporting": true
}
Attribution-Reporting-Redirect:
https://adtechpartner1.example?their_ad_click_id=567
Attribution-Reporting-Redirect:
https://adtechpartner2.example?their_ad_click_id=890
Wenn Attribution-Reporting-Redirects
URIs von Anzeigentechnologiepartnern enthält, sendet die Attribution Reporting API eine ähnliche Anfrage an jeden URI. Jeder AdTech-Partner muss einen Server konfigurieren, der mit den folgenden Headern antwortet:
Attribution-Reporting-Register-Source: {
"destination": "[app package name]",
"web_destination": "[eTLD+1]",
"source_event_id": "[64 bit unsigned integer]",
"expiry": "[64 bit signed integer]",
"event_report_window": "[64-bit signed integer]",
"aggregatable_report_window": "[64-bit signed integer]",
"priority": "[64 bit signed integer]",
"filter_data": {
"[key name 1]": ["key1 value 1", "key1 value 2"],
"[key name 2]": ["key2 value 1", "key2 value 2"],
// Note: "source_type" key will be automatically generated as
// one of {"navigation", "event"}.
},
"aggregation_keys": {
"[key1 name]": "[key1 value]",
"[key2 name]": "[key2 value]",
}
}
// The Attribution-Reporting-Redirect header is ignored for ad tech partners.
Registrierung von Conversion-Triggern akzeptieren
Dieser Endpunkt sollte über einen URI wie den folgenden erreichbar sein:
https://adtech.example/attribution_trigger
Wenn eine Client-App ein Triggerereignis registriert, gibt sie den URI für diesen Serverendpunkt an. Die Attribution Reporting API sendet dann eine Anfrage und fügt einen der folgenden Header hinzu:
Konfigurieren Sie Ihren Serverendpunkt so, dass er mit Folgendem antwortet:
// Metadata associated with trigger.
Attribution-Reporting-Register-Trigger: {
"event_trigger_data": [{
// "trigger_data returned" in event reports is truncated to
// the last 1 or 3 bits, based on conversion type.
"trigger_data": "[unsigned 64-bit integer]",
"priority": "[signed 64-bit integer]",
"deduplication_key": "[signed 64-bit integer]",
// "filter" and "not_filters" are optional fields which allow configuring
// event trigger data based on source's filter_data. They consist of a
// filter set, which is a list of filter maps. An event_trigger_data object
// is ignored if none of the filter maps in the set match the source's
// filter data.
// Note: "source_type" can be used as a key in a filter map to filter based
// on the source's "navigation" or "event" type. The first
// Event-Trigger that matches (based on the filters/not_filters) will be
// used for report generation. If none of the event-triggers match, no
// event report will be generated.
"filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"],
// If a key is missing from filters or source's filter_data, it won't be
// used during matching.
"[key name 2]": ["key2 value 1", "key2 value 2"],
}],
"not_filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"],
// If a key is missing from not_filters or source's filter_data, it won't
// be used during matching.
"[key name 2]": ["key2 value 1", "key2 value 2"],
}]
}],
// Specify a list of dictionaries that generates aggregation keys.
"aggregatable_trigger_data": [
// Each dictionary entry independently adds pieces to multiple source keys.
{
"key_piece": "[key piece value]",
"source_keys": ["[key name the key piece value applies to]",
["list of IDs in source to match. Non-matching IDs are ignored"]]
// filters/not_filters are optional fields similar to event trigger data
// filter fields.
"filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"]
}],
"not_filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"],
"[key name 2]": ["key2 value 1", "key2 value 2"],
}]
},
..
],
// Specify an amount of an abstract value which can be integers in [1, 2^16]
// to contribute to each key that is attached to aggregation keys in the
// order they are generated.
"aggregatable_values": [
// Each source event can contribute a maximum of L1 = 2^16 to the
// aggregate histogram.
{
"[key_name]": [value]
},
..
],
aggregatable_deduplication_keys: [{
deduplication_key": [unsigned 64-bit integer],
"filters": {
"category": [filter_1, …, filter_H]
},
"not_filters": {
"category": [filter_1, …, filter_J]
}
},
...
{
"deduplication_key": [unsigned 64-bit integer],
"filters": {
"category": [filter_1, …, filter_D]
},
"not_filters": {
"category": [filter_1, …, filter_J]
}
}
]
"debug_key": "[64-bit unsigned integer]",
"debug_reporting": [boolean]
}
// Specify additional ad tech URLs to register this trigger with.
// Repeated Header field "Attribution-Reporting-Redirect"
Attribution-Reporting-Redirect: <Ad Tech Partner URI 1>
Attribution-Reporting-Redirect: <Ad Tech Partner URI 2>
Hier ein Beispiel mit hinzugefügten Beispielwerten:
Attribution-Reporting-Register-Trigger: {
"event_trigger_data": [{
"trigger_data": "1122", // Returns 010 for CTCs and 0 for VTCs in reports.
"priority": "3",
"deduplication_key": "3344"
"filters": [{ // Filter strings can not exceed 25 characters
"product_id": ["1234"],
"source_type": ["event"]
}]
},
{
"trigger_data": "4", // Returns 100 for CTCs and 0 for VTCs in reports.
"priority": "3",
"deduplication_key": "3344"
"filters": [{ // Filter strings can not exceed 25 characters
"product_id": ["1234"],
"source_type": ["navigation"]
}]
}],
"aggregatable_trigger_data": [
// Each dictionary independently adds pieces to multiple source keys.
{
// Conversion type purchase = 2 at a 9-bit offset, i.e. 2 << 9.
// A 9-bit offset is needed because there are 511 possible campaigns,
// which takes up 9 bits in the resulting key.
"key_piece": "0x400",// Conversion type purchase = 2
// Apply this key piece to:
"source_keys": ["campaignCounts"]
// Filter strings can not exceed 25 characters
},
{
// Purchase category shirts = 21 at a 7-bit offset, i.e. 21 << 7.
// A 7-bit offset is needed because there are ~100 regions for the geo
// key, which takes up 7 bits of space in the resulting key.
"key_piece": "0xA80",
// Apply this key piece to:
"source_keys": ["geoValue", "nonMatchingIdsAreIgnored"]
// source_key values must not exceed the limit of 25 characters
}
],
"aggregatable_values":
{
// Privacy budget for each key is L1 / 2 = 2^15 (32768).
// Conversion count was 1.
// Scale the count to use the full budget allocated: 1 * 32768 = 32768.
"campaignCounts": 32768,
// Purchase price was $52.
// Purchase values for the app range from $1 to $1,024 (integers only).
// Scaling factor applied is 32768 / 1024 = 32.
// For $52 purchase, scale the value by 32 ($52 * 32 = $1,664).
"geoValue": 1664
}
,
// aggregatable_deduplication_keys is an optional field. Up to 50 "keys"
// can be included in the aggregatable_deduplication_keys list. Filters, not
// filters, and deduplication_key are optional fields. If deduplication_key
// is omitted, it will be treated as a null value. See
// https://wicg.github.io/attribution-reporting-api/#triggering-aggregatable-attribution
aggregatable_deduplication_keys:
[
{
deduplication_key": 3,
"filters": {
"category": [A]
}
},
{
"deduplication_key": 4,
"filters": {
"category": [C, D]
},
"not_filters": {
"category": [F]
}
}
]
// Opts into receiving verbose debug reports
"debug_reporting": true
}
Attribution-Reporting-Redirect:https://adtechpartner.example?app_install=567
Pro Aggregationsschlüssel-ID und Filterstring gilt ein Limit von 25 Byte. Die IDs der Aggregationsschlüssel und die Filterstrings dürfen also maximal 25 Zeichen lang sein. In diesem Beispiel hat campaignCounts
14 Zeichen und ist daher eine gültige Aggregationsschlüssel-ID. 1234
hat 4 Zeichen und ist daher ein gültiger Filterstring.
Wenn eine ID des Aggregationsschlüssels oder ein Filterstring mehr als 25 Zeichen lang ist, wird der Trigger ignoriert.
Wenn Attribution-Reporting-Redirect
URIs von Anzeigentechnologiepartnern enthält, sendet die Attribution Reporting API eine ähnliche Anfrage an jeden URI. Jeder AdTech-Partner muss einen Server konfigurieren, der mit den folgenden Headern antwortet:
// Metadata associated with trigger.
Attribution-Reporting-Register-Trigger: {
"event_trigger_data": [{
// "trigger_data" returned in event reports is truncated to
// the last 1 or 3 bits, based on conversion type.
"trigger_data": "[unsigned 64-bit integer]",
"priority": "[signed 64-bit integer]",
"deduplication_key": "[signed 64-bit integer]",
// filter and not_filters are optional fields which allow configuring
// different event trigger data based on source's filter_data. They
// consist of a filter set, which is a list of filter maps. An
// event_trigger_data object is ignored if none of the filter maps in the
// set match the source's filter data. Note: "source_type" can be used as
// a key in a filter map to filter based on the source's "navigation" or
// "event" type. The first Event-Trigger that matches (based on the
// filters/not_filters) will be used for report generation. If none of the
// event-triggers match, no report will be generated.
"filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"],
// If a key is missing from filters or source's filter_data, it will not be
// used during matching.
"[key name 2]": ["key2 value 1", "key2 value 2"],
}],
"not_filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"],
// If a key is missing from not_filters or source's filter_data, it will not
// be used during matching.
"[key name 2]": ["key2 value 1", "key2 value 2"],
}]
}],
"aggregatable_trigger_data": [
// Each dictionary entry independently adds pieces to multiple source keys.
{
"key_piece": "[key piece value]",
"source_keys": ["[key name the key piece value applies to]",
["list of IDs in source to match. Non-matching IDs are ignored"]],
// filters/not_filters are optional fields similar to event trigger data
// filter fields.
"filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"]
}],
"not_filters": [{
"[key name 1]": ["key1 value 1", "key1 value 2"],
"[key name 2]": ["key2 value 1", "key2 value 2"],
}]
},
..
],
// Specify an amount of an abstract value which can be integers in [1, 2^16] to
// contribute to each key that is attached to aggregation keys in the order they
// are generated.
"aggregatable_values": [
// Each source event can contribute a maximum of L1 = 2^16 to the aggregate
// histogram.
{
"[key_name]": [value]
}
]
}
// The Attribution-Reporting-Redirect header is ignored for ad tech partners.
Berichte auf Ereignisebene akzeptieren
Dieser Endpunkt sollte über einen URI adressierbar sein. Weitere Informationen zum Registrieren von URIs finden Sie unter Privacy Sandbox-Konto registrieren. Der URI wird aus dem Ursprung der Server abgeleitet, die für die Annahme der Quellregistrierung und Triggerregistrierung verwendet werden. Anhand der Beispiel-URIs für Endpunkte, die die Registrierung von Quellen und die Registrierung von Triggern akzeptieren, lautet der URI dieses Endpunkts:
https://adtech.example/.well-known/attribution-reporting/report-event-attribution
Konfigurieren Sie diesen Server so, dass er JSON-Anfragen im folgenden Format akzeptiert:
{
"attribution_destination": "android-app://com.advertiser.example",
"source_event_id": "12345678",
"trigger_data": "2",
"report_id": "12324323",
"source_type": "navigation",
"randomized_trigger_rate": "0.02"
[Optional] "source_debug_key": "[64-bit unsigned integer]",
[Optional] "trigger_debug_key": "[64-bit unsigned integer]",
}
Mit Debug-Schlüsseln erhalten Sie zusätzliche Informationen zu Ihren Attributionsberichten. Weitere Informationen zur Konfiguration
Zusammenführbare Berichte akzeptieren
Dieser Endpunkt sollte über einen URI adressierbar sein. Weitere Informationen zum Registrieren von URIs finden Sie unter Privacy Sandbox-Konto registrieren. Der URI wird aus dem Ursprung der Server abgeleitet, die für die Annahme der Quellregistrierung und Triggerregistrierung verwendet werden. Anhand der Beispiel-URIs für Endpunkte, die die Registrierung von Quellen und die Registrierung von Triggern akzeptieren, lautet der URI dieses Endpunkts:
https://adtech.example/.well-known/attribution-reporting/report-aggregate-attribution
Sowohl die verschlüsselten als auch die unverschlüsselten Felder werden für aggregierbare Berichte ausgefüllt. Mit den verschlüsselten Berichten können Sie mit dem Aggregationsdienst beginnen, während das unverschlüsselte Feld Aufschluss darüber gibt, wie die Daten mithilfe der festgelegten Schlüssel/Wert-Paare strukturiert werden.
Konfigurieren Sie diesen Server so, dass er JSON-Anfragen im folgenden Format akzeptiert:
{
// Info that the aggregation services also need encoded in JSON
// for use with AEAD. Line breaks added for readability.
"shared_info": "{
\"api\":\"attribution-reporting\",
\"attribution_destination\": \"android-app://com.advertiser.example.advertiser\",
\"scheduled_report_time\":\"[timestamp in seconds]\",
\"source_registration_time\": \"[timestamp in seconds]\",
\"version\":\"[api version]\",
\"report_id\":\"[UUID]\",
\"reporting_origin\":\"https://reporter.example\" }",
// In the current Developer Preview release, The "payload" and "key_id" fields
// are not used because the platform does not yet encrypt aggregate reports.
// Currently, the "debug_cleartext_payload" field holds unencrypted reports.
"aggregation_service_payloads": [
{
"payload": "[base64 HPKE encrypted data readable only by the aggregation service]",
"key_id": "[string identifying public key used to encrypt payload]",
"debug_cleartext_payload": "[unencrypted payload]"
},
],
"source_debug_key": "[64 bit unsigned integer]",
"trigger_debug_key": "[64 bit unsigned integer]"
}
Mit Debug-Schlüsseln erhalten Sie zusätzliche Informationen zu Ihren Attributionsberichten. Weitere Informationen zur Konfiguration
Android-Client einrichten
Die Client-App registriert Attributionsquellen und ‑trigger und ermöglicht die Berichterstellung auf Ereignisebene und die Aggregation von Berichten. So bereiten Sie ein Android-Clientgerät oder einen Emulator für die Verwendung der Attribution Reporting API vor:
- Richten Sie Ihre Entwicklungsumgebung für die Privacy Sandbox auf Android ein.
- Installieren Sie ein System-Image auf einem unterstützten Gerät oder richten Sie einen Emulator ein, der die Privacy Sandbox auf Android unterstützt.
Aktivieren Sie den Zugriff auf die Attribution Reporting API, indem Sie den folgenden ADB-Befehl ausführen. (Die API ist standardmäßig deaktiviert.)
adb shell device_config put adservices ppapi_app_allow_list \"\*\"
Wenn Sie die Attribution Reporting API lokal testen (z. B. auf einem Gerät, auf das Sie physischen Zugriff haben), führen Sie diesen Befehl aus, um die Registrierung zu deaktivieren:
adb shell device_config put adservices disable_measurement_enrollment_check "true"
Fügen Sie die Berechtigung
ACCESS_ADSERVICES_ATTRIBUTION
in Ihre Android-Manifestdatei ein und erstellen Sie eine Konfiguration für Anzeigendienste für Ihre App, um die Attribution Reporting APIs zu verwenden:<uses-permission android:name="android.permission.ACCESS_ADSERVICES_ATTRIBUTION" />
Optional: Wenn Sie Debug-Berichte erhalten möchten, fügen Sie die Berechtigung
ACCESS_ADSERVICES_AD_ID
in Ihre Android-Manifestdatei ein:<uses-permission android:name="android.permission.ACCESS_ADSERVICES_AD_ID" />
Verweise im
<application>
-Element deines Manifests auf eine Anzeigendienstkonfiguration:<property android:name="android.adservices.AD_SERVICES_CONFIG" android:resource="@xml/ad_services_config" />
Geben Sie die XML-Ressource für Anzeigendienste an, auf die im Manifest verwiesen wird, z. B.
res/xml/ad_services_config.xml
. Weitere Informationen zu Berechtigungen für Werbedienste und SDK-Zugriffssteuerung<ad-services-config> <attribution allowAllToAccess="true" /> </ad-services-config>
Anzeigenereignisse registrieren
Ihre App sollte Quellen und Conversions bei jedem Auftreten registrieren, damit sie korrekt erfasst werden. Die Klasse MeasurementManager
bietet Methoden zum Registrieren von Ereignissen für Attributionsquellen und Conversion-Triggern.
Ereignis für Attributionsquelle registrieren
Wenn eine Anzeige aufgerufen oder angeklickt wird, ruft eine Publisher-App registerSource()
auf, um eine Attributionsquelle zu registrieren, wie im Code-Snippet dargestellt.
Die Attribution Reporting API unterstützt die folgenden Arten von Attributionsquellenereignissen:
- Klicks, die Sie in der Regel in einer Rückrufmethode ähnlich wie
onClick()
erfassen. Das entsprechende Triggerereignis tritt in der Regel kurz nach dem Klickereignis auf. Dieser Ereignistyp liefert mehr Informationen zur Nutzerinteraktion und ist daher eine gute Attributionsquelle, der eine hohe Priorität eingeräumt werden sollte. Ansichten, die Sie in der Regel in einer Rückrufmethode ähnlich wie
onAdShown()
registrieren. Das entsprechende Triggerereignis kann Stunden oder Tage nach dem Aufrufereignis auftreten.
Kotlin
companion object {
private val CALLBACK_EXECUTOR = Executors.newCachedThreadPool()
}
val measurementManager = context.getSystemService(MeasurementManager::class.java)
var exampleClickEvent: InputEvent? = null
// Use the URI of the server-side endpoint that accepts attribution source
// registration.
val attributionSourceUri: Uri =
Uri.parse("https://adtech.example/attribution_source?AD_TECH_PROVIDED_METADATA")
val future = CompletableFuture<Void>()
adView.setOnTouchListener(_: View?, event: MotionEvent?)) ->
exampleClickEvent = event
true
}
// Register Click Event
measurementManager.registerSource(
attributionSourceUri,
exampleClickEvent,
CALLBACK_EXECUTOR,
future::complete)
// Register View Event
measurementManager.registerSource(
attributionSourceUri,
null,
CALLBACK_EXECUTOR,
future::complete)
Java
private static final Executor CALLBACK_EXECUTOR = Executors.newCachedThreadPool();
private InputEvent exampleClickEvent;
MeasurementManager measurementManager =
context.getSystemService(MeasurementManager.class);
// Use the URI of the server-side endpoint that accepts attribution source
// registration.
Uri attributionSourceUri =
Uri.parse("https://adtech.example/attribution_source?AD_TECH_PROVIDED_METADATA");
CompletableFuture<Void> future = new CompletableFuture<>();
adView.setOnTouchListener(v, event)) -> {
exampleClickEvent = event;
return true;
}
// Register Click Event
measurementManager.registerSource(attributionSourceUri, exampleClickEvent,
CALLBACK_EXECUTOR, future::complete);
// Register View Event
measurementManager.registerSource(attributionSourceUri, null,
CALLBACK_EXECUTOR, future::complete);
Nach der Registrierung sendet die API eine HTTP-POST-Anfrage an den Dienstendpunkt unter der von attributionSourceUri
angegebenen Adresse. Die Antwort des Endpunkts enthält Werte für destination, source_event_id, expiry
und source_priority
.
Wenn die ursprüngliche Anzeigentechnologie Quellregistrierungen freigeben möchte, kann der URI der ursprünglichen Attributionsquelle Weiterleitungen zu anderen Anzeigentechnologie-Endpunkten enthalten. Die für die Weiterleitungen geltenden Einschränkungen und Regeln sind im technischen Vorschlag aufgeführt.
Unterstützung für Daisy-Chain-Weiterleitungen für registerSource
und registerTrigger
Zusätzlich zum Registrierungsheader kann der API-Nutzer jetzt eine HTTP-Weiterleitung als Serverantwort mit einem Statuscode 302 und einem „Location“-Header mit der nächsten URL bereitstellen, die für eine weitere Registrierung aufgerufen werden soll.
Nur das Feld „Ziel“, das beim ersten Besuch angegeben wird, wird in der Daisy-Chain verwendet. Die Anzahl der Besuche ist auf dieselbe Anzahl wie bei den Überschriften „Attribution-Reporting-Redirect“ beschränkt. Diese Weiterleitung wird zusätzlich zur bestehenden Unterstützung für „Attribution-Reporting-Redirect“ angeboten. Wenn beide vorhanden sind, wird „Attribution-Reporting-Redirect“ bevorzugt.
Conversion-Triggerereignis registrieren
Wenn Sie ein Conversion-Trigger-Ereignis registrieren möchten, rufen Sie in Ihrer App registerTrigger()
auf:
Kotlin
companion object {
private val CALLBACK_EXECUTOR = Executors.newCachedThreadPool()
}
val measurementManager = context.getSystemService(MeasurementManager::class.java)
// Use the URI of the server-side endpoint that accepts trigger registration.
val attributionTriggerUri: Uri =
Uri.parse("https://adtech.example/trigger?AD_TECH_PROVIDED_METADATA")
val future = CompletableFuture<Void>()
// Register trigger (conversion)
measurementManager.registerTrigger(
attributionTriggerUri,
CALLBACK_EXECUTOR,
future::complete)
Java
private static final Executor CALLBACK_EXECUTOR = Executors.newCachedThreadPool();
MeasurementManager measurementManager =
context.getSystemService(MeasurementManager.class);
// Use the URI of the server-side endpoint that accepts trigger registration.
Uri attributionTriggerUri =
Uri.parse("https://adtech.example/trigger?AD_TECH_PROVIDED_METADATA");
CompletableFuture<Void> future = new CompletableFuture<>();
// Register trigger (conversion)
measurementManager.registerTrigger(
attributionTriggerUri,
CALLBACK_EXECUTOR,
future::complete)
Nach der Registrierung sendet die API eine HTTP-POST-Anfrage an den Dienstendpunkt unter der von attributionTriggerUri
angegebenen Adresse. Die Antwort des Endpunkts enthält Werte für Ereignis- und zusammengefasste Berichte.
Wenn die ursprüngliche Anzeigentechnologieplattform die Freigabe von Triggerregistrierungen zulässt, kann der URI Weiterleitungen zu URIs enthalten, die zu anderen Anzeigentechnologieplattformen gehören. Die für die Weiterleitungen geltenden Einschränkungen und Regeln sind im technischen Vorschlag aufgeführt.
App- und Webanalyse registrieren
Wenn sowohl eine App als auch ein Browser eine Rolle bei der Nutzerinteraktion von der Quelle bis zum Trigger spielen, gibt es bei der Registrierung von Anzeigenereignissen kleine Unterschiede. Wenn ein Nutzer eine Anzeige in einer App sieht und für eine Conversion zu einem Browser weitergeleitet wird, wird die Quelle von der App und die Conversion vom Webbrowser registriert. Wenn ein Nutzer beispielsweise in einem Webbrowser beginnt und zur Conversion zu einer App weitergeleitet wird, wird die Quelle vom Browser und die Conversion von der App erfasst.
Da die Organisation von Anzeigentechnologien im Web und auf Android-Geräten unterschiedlich ist, haben wir neue APIs hinzugefügt, um Quellen und Trigger zu registrieren, die in Browsern auftreten. Der Hauptunterschied zwischen diesen APIs und den entsprechenden appbasierten APIs besteht darin, dass wir davon ausgehen, dass der Browser den Weiterleitungen folgt, alle browserspezifischen Filter anwendet und die gültigen Registrierungen an die Plattform weitergibt, indem registerWebSource()
oder registerWebTrigger()
aufgerufen wird.
Das folgende Code-Snippet zeigt ein Beispiel für den API-Aufruf, den der Browser ausführt, um eine Attributionsquelle zu registrieren, bevor der Nutzer zu einer App weitergeleitet wird:
Kotlin
companion object {
private val CALLBACK_EXECUTOR = Executors.newCachedThreadPool()
}
val measurementManager =
context.getSystemService(MeasurementManager::class.java)
var exampleClickEvent: InputEvent? = null
// Use the URIs of the server-side endpoints that accept attribution source
// registration.
val sourceParam1 = WebSourceParams.Builder(Uri.parse(
"https://adtech1.example/attribution_source?AD_TECH_PROVIDED_METADATA"))
// True, if debugging is allowed for the ad tech.
.setDebugKeyAllowed(true)
.build()
val sourceParam2 = WebSourceParams.Builder(Uri.parse(
"https://adtech2.example/attribution_source?AD_TECH_PROVIDED_METADATA"))
.setDebugKeyAllowed(false)
.build()
val sourceParam3 = WebSourceParams.Builder(Uri.parse(
"https://adtech3.example/attribution_source?AD_TECH_PROVIDED_METADATA"))
.build()
val sourceParams = Arrays.asList(sourceParam1, sourceParam2, sourceParam3)
val publisherOrigin = Uri.parse("https://publisher.example")
val appDestination = Uri.parse("android-app://com.example.store")
val webDestination = Uri.parse("https://example.com")
val future = CompletableFuture<Void>()
adView.setOnTouchListener {_: View?, event: MotionEvent? ->
exampleClickEvent = event
true
}
val clickRegistrationRequest = WebSourceRegistrationRequest.Builder(
sourceParams,
publisherOrigin)
.setAppDestination(appDestination)
.setWebDestination(webDestination)
.setInputEvent(event)
.build()
val viewRegistrationRequest = WebSourceRegistrationRequest.Builder(
sourceParams,
publisherOrigin)
.setAppDestination(appDestination)
.setWebDestination(webDestination)
.setInputEvent(null)
.build()
// Register a web source for a click event.
measurementManager.registerWebSource(
clickRegistrationRequest,
CALLBACK_EXECUTOR,
future::complete)
// Register a web source for a view event.
measurementManager.registerWebSource(
viewRegistrationRequest,
CALLBACK_EXECUTOR,
future::complete)
Java
private static final Executor CALLBACK_EXECUTOR =
Executors.newCachedThreadPool();
private InputEvent exampleClickEvent;
MeasurementManager measurementManager =
context.getSystemService(MeasurementManager.class);
// Use the URIs of the server-side endpoints that accept attribution source
// registration.
WebSourceParams sourceParam1 = WebSourceParams.Builder(Uri.parse(
"https://adtech1.example/attribution_source?AD_TECH_PROVIDED_METADATA"))
// True, if debugging is allowed for the ad tech.
.setDebugKeyAllowed(true)
.build();
WebSourceParams sourceParam2 = WebSourceParams.Builder(Uri.parse(
"https://adtech2.example/attribution_source?AD_TECH_PROVIDED_METADATA"))
.setDebugKeyAllowed(false)
.build();
WebSourceParams sourceParam3 = WebSourceParams.Builder(Uri.parse(
"https://adtech3.example/attribution_source?AD_TECH_PROVIDED_METADATA"))
.build();
List<WebSourceParams> sourceParams =
Arrays.asList(sourceParam1, sourceParam2, sourceParam3);
Uri publisherOrigin = Uri.parse("https://publisher.example");
Uri appDestination = Uri.parse("android-app://com.example.store");
Uri webDestination = Uri.parse("https://example.com");
CompletableFuture<Void> future = new CompletableFuture<>();
adView.setOnTouchListener(v, event) -> {
exampleClickEvent = event;
return true;
}
WebSourceRegistrationRequest clickRegistrationRequest =
new WebSourceRegistrationRequest.Builder(sourceParams, publisherOrigin)
.setAppDestination(appDestination)
.setWebDestination(webDestination)
.setInputEvent(event)
.build();
WebSourceRegistrationRequest viewRegistrationRequest =
new WebSourceRegistrationRequest.Builder(sourceParams, publisherOrigin)
.setAppDestination(appDestination)
.setWebDestination(webDestination)
.setInputEvent(null)
.build();
// Register a web source for a click event.
measurementManager.registerWebSource(clickRegistrationRequest,
CALLBACK_EXECUTOR, future::complete);
// Register a web source for a view event.
measurementManager.registerWebSource(viewRegistrationRequest,
CALLBACK_EXECUTOR, future::complete);
Das folgende Code-Snippet zeigt ein Beispiel für den API-Aufruf, den der Browser ausführt, um eine Conversion zu erfassen, nachdem der Nutzer von der App weitergeleitet wurde:
Kotlin
companion object {
private val CALLBACK_EXECUTOR = Executors.newCachedThreadPool()
}
val measurementManager = context.getSystemService(MeasurementManager::class.java)
// Use the URIs of the server-side endpoints that accept trigger registration.
val triggerParam1 = WebTriggerParams.Builder(Uri.parse(
"https://adtech1.example/trigger?AD_TECH_PROVIDED_METADATA"))
// True, if debugging is allowed for the ad tech.
.setDebugKeyAllowed(true)
.build()
val triggerParam2 = WebTriggerParams.Builder(Uri.parse(
"https://adtech2.example/trigger?AD_TECH_PROVIDED_METADATA"))
.setDebugKeyAllowed(false)
.build()
val triggerParams = Arrays.asList(triggerParam1, triggerParam2)
val advertiserOrigin = Uri.parse("https://advertiser.example")
val future = CompletableFuture<Void>()
val triggerRegistrationRequest = WebTriggerRegistrationRequest.Builder(
triggerParams,
advertiserOrigin)
.build()
// Register the web trigger (conversion).
measurementManager.registerWebTrigger(
triggerRegistrationRequest,
CALLBACK_EXECUTOR,
future::complete)
Java
private static final Executor CALLBACK_EXECUTOR =
Executors.newCachedThreadPool();
MeasurementManager measurementManager =
context.getSystemService(MeasurementManager.class);
// Use the URIs of the server-side endpoints that accept trigger registration.
WebTriggerParams triggerParam1 = WebTriggerParams.Builder(Uri.parse(
"https://adtech1.example/trigger?AD_TECH_PROVIDED_METADATA"))
// True, if debugging is allowed for the ad tech.
.setDebugKeyAllowed(true)
.build();
WebTriggerParams triggerParam2 = WebTriggerParams.Builder(Uri.parse(
"https://adtech2.example/trigger?AD_TECH_PROVIDED_METADATA"))
.setDebugKeyAllowed(false)
.build();
List<WebTriggerParams> triggerParams =
Arrays.asList(triggerParam1, triggerParam2);
Uri advertiserOrigin = Uri.parse("https://advertiser.example");
CompletableFuture<Void> future = new CompletableFuture<>();
WebTriggerRegistrationRequest triggerRegistrationRequest =
new WebTriggerRegistrationRequest.Builder(
triggerParams, advertiserOrigin)
.build();
// Register the web trigger (conversion).
measurementManager.registerWebTrigger( triggerRegistrationRequest,
CALLBACK_EXECUTOR, future::complete);
Rauschen für mehr Datenschutz hinzufügen
Berichte auf Ereignisebene enthalten Daten zu Ziel, Attributionsquellen-ID und Trigger. Sie werden im ursprünglichen (unverschlüsselten) Format an den Ursprung der Meldung gesendet. Zum Schutz der Privatsphäre der Nutzer kann Rauschen hinzugefügt werden, um die Identifizierung einzelner Nutzer zu erschweren. Berichte mit Rauschen auf Ereignisebene werden gemäß dem Differential Privacy-Konzept generiert und gesendet. Dies sind die Standardwerte für den Prozentsatz des Rauschens für verschiedene Szenarien:
Quelltyp |
Wert für Quelle und Ziel |
Wahrscheinlichkeit für fehlerhafte Berichte pro Quellregistrierung |
Ansehen |
App oder Web |
0,0000025 |
Ansehen |
Apps und Web |
0,0000042 |
Klick |
App oder Web |
0.0024263 |
Klick |
Apps und Web |
0,0170218 |
Bei der App-zu-Web-Attributionsmessung, bei der Quellen sowohl zu App- als auch zu Webzielen führen können, kann in Berichten auf Ereignisebene angegeben werden, ob der Trigger in der App oder im Web ausgelöst wurde. Um diese zusätzlichen Details zu kompensieren, werden die generierten Berichte mit Rauschen bis zu etwa 7-mal für Klicks und etwa 1,7-mal für Aufrufe erstellt.
Bei einigen Anzeigentechnologien ist es nicht erforderlich, in Berichten auf Ereignisebene anzugeben, ob der Trigger in der App oder im Web ausgelöst wurde. Mit dem Feld coarse_event_report_destinations
unter der Überschrift Attribution-Reporting-Register-Source
können Anbieter von Anzeigentechnologien den Anteil an ungültigen Daten reduzieren. Wenn eine Quelle mit dem angegebenen Feld coarse_event_report_destinations
die Attribution erhält, enthält der resultierende Bericht sowohl App- als auch Webziele, ohne Unterscheidung, wo der tatsächliche Trigger ausgelöst wurde.
In den folgenden Beispielen klickt ein Nutzer auf eine Anzeige und diese Quelle ist bei der API registriert. Der Nutzer führt dann sowohl in der App des Werbetreibenden als auch auf der Website des Werbetreibenden eine Conversion aus. Beide Conversions werden als Trigger registriert und dem ursprünglichen Klick zugeordnet.
HTTP-Header für die Registrierung einer klickbasierten Quelle:
Attribution-Reporting-Register-Source: {
"destination": "android-app://com.advertiser.example",
"web_destination": "https://advertiser.com",
"source_event_id": "234",
"expiry": "60000",
"priority": "5",
// Ad tech opts out of receiving app-web destination distinction
// in event report, avoids additional noise
"coarse_event_report_destinations": "true"
}
In der App mit dem Paketnamen com.advertiser.example
wird ein Trigger registriert:
Attribution-Reporting-Register-Trigger: {
"event_trigger_data": [{
"trigger_data": "1",
"priority": "1"
}],
}
Ein Trigger wird über einen Browser auf der Website mit der eTLD+1-Domain registriert.
https://advertiser.com
:
Attribution-Reporting-Register-Trigger: {
"event_trigger_data": [{
"trigger_data": "2",
"priority": "2"
}],
}
Die daraus resultierenden Berichte auf Ereignisebene werden erstellt. Angenommen, beide Trigger werden der Quelle zugeordnet, werden die folgenden Berichte auf Ereignisebene generiert:
{
"attribution_destination": ["android-app://com.advertiser.example,https://advertiser.com"],
"scheduled_report_time": "800176400",
"source_event_id": "53234",
"trigger_data": "1",
// Can be "event" if source were registered by user viewing the ad
"source_type": "navigation",
// Would be 0.0170218 without coarse_event_report_destinations as true in the source
"randomized_trigger_rate": 0.0024263
}
Berichte erstellen und senden
Die Attribution Reporting API sendet Berichte an die Endpunkte auf Ihrem Server, die Berichte auf Ereignisebene und aggregierbare Berichte akzeptieren.
Berichtsjobs erzwingen
Nachdem Sie ein Ereignis für die Attributionsquelle oder ein Triggerereignis registriert haben, plant das System die Ausführung des Berichtsjobs. Standardmäßig wird dieser Job alle 4 Stunden ausgeführt. Zu Testzwecken können Sie die Berichtsjobs erzwingen oder die Intervalle zwischen den Jobs verkürzen.
Attributionsjob erzwingen:
adb shell cmd jobscheduler run -f com.google.android.adservices.api 5
So erzwingen Sie die Ausführung eines Jobs für Berichte auf Ereignisebene:
adb shell cmd jobscheduler run -f com.google.android.adservices.api 3
So erzwingen Sie die Ausführung eines aggregierbaren Berichtsjobs:
adb shell cmd jobscheduler run -f com.google.android.adservices.api 7
In der Ausgabe von logcat sehen Sie, wann die Jobs ausgeführt wurden. Es sollte in etwa so aussehen:
JobScheduler: executeRunCommand(): com.google.android.adservices.api/0 5 s=false f=true
Zustellung von Berichten erzwingen
Auch wenn der Berichtsjob erzwungen wird, sendet das System Berichte gemäß den geplante Lieferzeiten, die zwischen wenigen Stunden und mehreren Tagen liegen. Zu Testzwecken können Sie die Systemzeit des Geräts auf einen Zeitpunkt nach den geplanten Verzögerungen vorspulen, um die Berichtsübermittlung zu starten.
Berichte auf dem Server prüfen
Prüfen Sie nach dem Senden der Berichte, ob sie zugestellt wurden. Sehen Sie sich dazu die empfangenen Berichte und die entsprechenden Serverprotokolle an, z. B. den Verlauf des Mock-Servers oder Ihres benutzerdefinierten Systems.
Zusammengefassten Bericht entschlüsseln
Wenn Sie einen zusammengefassten Bericht erhalten, enthält das Feld debug_cleartext_payload
eine unverschlüsselte Version des zusammengefassten Berichts. Diese Version Ihres Berichts ist zwar unverschlüsselt, muss aber trotzdem decodiert werden.
Im folgenden Beispiel wird der Inhalt des Felds debug_cleartext_payload
in zwei Schritten decodiert: zuerst mit Base64- und dann mit CBOR-Dekodierung.
String base64DebugPayload = "omRkYXRhgqJldmFsdWVEAAAGgGZidWNrZXRQAAAAAAAAAAAAAAAAAAAKhaJldmFsdWVEAACAAGZidWNrZXRQAAAAAAAAAAAAAAAAAAAFWWlvcGVyYXRpb25paGlzdG9ncmFt";
byte[] cborEncoded = Base64.getDecoder().decode(base64DebugPayload);
// CbodDecoder comes from this library https://github.com/c-rack/cbor-java
final List<DataItem> dataItems = new CborDecoder(new ByteArrayInputStream(cborEncoded)).decode();
// In here you can see the contents, but the value will be something like:
// Data items: [{ data: [{ value: co.nstant.in.cbor.model.ByteString@a8b5c07a,
// bucket: co.nstant.in.cbor.model.ByteString@f812097d },
// { value: co.nstant.in.cbor.model.ByteString@a8b5dfc0,
// bucket: co.nstant.in.cbor.model.ByteString@f8120934 }], operation: histogram }]
Log.d("Data items : " + dataItems);
// In order to see the value for bucket and value, you can traverse the data
// and get their values, something like this:
final Map payload = (Map) dataItems.get(0);
final Array payloadArray = (Array) payload.get(new UnicodeString("data"));
payloadArray.getDataItems().forEach(i -> {
BigInteger value = new BigInteger(((ByteString) ((Map)i).get(new UnicodeString("value"))).getBytes());
BigInteger bucket = new BigInteger(((ByteString) ((Map)i).get(new UnicodeString("bucket"))).getBytes());
Log.d("value : " + value + " ;bucket : " + bucket);
});
Test
Als Einstieg in die Attribution Reporting API können Sie das Projekt MeasurementSampleApp auf GitHub verwenden. In dieser Beispielanwendung wird die Registrierung von Attributionsquellen und Triggern veranschaulicht.
Für Serverendpunkte können Sie die folgenden Referenzressourcen oder Ihre benutzerdefinierte Lösung verwenden:
- MeasurementAdTechServerSpec enthält OpenAPI-Dienstdefinitionen, die auf unterstützten Mock- oder Mikrodienstplattformen bereitgestellt werden können.
- MeasurementAdTechServer enthält eine Referenzimplementierung eines Mock-Servers, der auf einer Spring Boot-Anwendung für die Google App Engine basiert.
Vorbereitung
Stellen Sie Mock-APIs auf Remoteendpunkten bereit, auf die von Ihrem Testgerät oder Emulator aus zugegriffen werden kann. Für die Tests können Sie die Beispielprojekte MeasurementAdTechServerSpec und MeasurementAdTechServer verwenden.
Zu testende Funktion
- Attributionsquellen und Conversion-Trigger registrieren Prüfen Sie, ob serverseitige Endpunkte im richtigen Format antworten.
- Berichtsjobs ausführen
- Prüfen Sie die Zustellung von Berichten im Backend oder in der Konsole Ihres Testservers.
Geplante Funktionen
Flexible Konfiguration auf Ereignisebene
Die Standardkonfiguration für Berichte auf Ereignisebene wird für den Beginn von Nutzwerttests empfohlen, ist aber möglicherweise nicht für alle Anwendungsfälle ideal. Die Attribution Reporting API unterstützt optionale, flexiblere Konfigurationen, damit Anbieter von Anzeigentechnologien die Struktur ihrer Berichte auf Ereignisebene besser steuern und die Daten optimal nutzen können. Diese zusätzliche Flexibilität wird in zwei Phasen in die Attribution Reporting API eingeführt:
- Phase 1: Lite-Konfiguration auf Ereignisebene; Teilmenge von Phase 2.
- Phase 2: Vollständige Version der flexiblen Konfiguration auf Ereignisebene.
Phase 1: Lite-flexible Ereignisebene
Wir fügen dem JSON-Code in Attribution-Reporting-Register-Source
die folgenden beiden optionalen Parameter hinzu:
max_event_level_reports
event_report_windows
{
...
// Optional. This is a parameter that acts across all trigger types for the
// lifetime of this source. It restricts the total number of event-level
// reports that this source can generate. After this maximum is hit, the
// source is no longer capable of producing any new data. The use of
// priority in the trigger attribution algorithm in the case of multiple
// attributable triggers remains unchanged. Defaults to 3 for navigation
// sources and 1 for event sources
"max_event_level_reports": <int>,
// Optional. Represents a series of time windows, starting at 0. Reports
// for this source will be delivered an hour after the end of each window.
// Time is encoded as seconds after source registration. If
// event_report_windows is omitted, will use the default windows. This
// field is mutually exclusive with the existing `event_report_window` field.
// // End time is exclusive.
"event_report_windows": {
"start_time": <int>,
"end_times": [<int>, ...]
}
}
Beispiel für eine benutzerdefinierte Konfiguration
Diese Beispielkonfiguration unterstützt einen Entwickler, der Berichte in früheren Berichtszeiträumen erhalten möchte.
{
...
"max_event_level_reports": 2,
"event_report_windows": {
"end_times": [7200, 43200, 86400] // 2 hours, 12 hours, 1 day in seconds
}
}
Phase 2: Vollständig flexible Ereignisebene
Zusätzlich zu den Parametern, die in Phase 1 hinzugefügt wurden, fügen wir der JSON-Datei in Attribution-Reporting-Register-Source
einen zusätzlichen optionalen Parameter trigger_specs
hinzu.
{
// A trigger spec is a set of matching criteria, along with a scheme to
// generate bucketized output based on accumulated values across multiple
// triggers within the specified event_report_window. There will be a limit on
// the number of specs possible to define for a source.
"trigger_specs": [{
// This spec will only apply to registrations that set one of the given
// trigger data values (non-negative integers) in the list.
// trigger_data will still appear in the event-level report.
"trigger_data": [<int>, ...]
// Represents a series of time windows, starting at the source registration
// time. Reports for this spec will be delivered an hour after the end of
// each window. Time is encoded as seconds after source registration.
// end_times must consist of strictly increasing positive integers.
//
// Note: specs with identical trigger_data cannot have overlapping windows;
// this ensures that triggers match at most one spec. If
// event_report_windows is omitted, will use the "event_report_window" or
// "event_report_windows" field specified at the global level for the source
// (or the default windows if none are specified). End time is exclusive.
"event_report_windows": {
"start_time": <int>,
"end_times": [<int>, ...],
}
// Represents an operator that summarizes the triggers within a window
// count: number of triggers attributed within a window
// value_sum: sum of the value of triggers within a window
// The summary is reported as an index into a bucketization scheme. Defaults
// to "count"
"summary_window_operator": <one of "count" or "value_sum">,
// Represents a bucketization of the integers from [0, MAX_INT], encoded as
// a list of integers where new buckets begin (excluding 0 which is
// implicitly included).
// It must consist of strictly increasing positive integers.
//
// e.g. [5, 10, 100] encodes the following ranges:
// [[0, 4], [5, 9], [10, 99], [100, MAX_INT]]
//
// At the end of each reporting window, triggers will be summarized into an
// integer which slots into one of these ranges. Reports will be sent for
// every new range boundary that is crossed. Reports will never be sent for
// the range that includes 0, as every source is initialized in this range.
//
// If omitted, then represents a trivial mapping
// [1, 2, ... , MAX_INT]
// With MAX_INT being the maximum int value defined by the browser.
"summary_buckets": [<bucket start>, ...]
}, {
// Next trigger_spec
} ...],
// See description in phase 1.
"max_event_level_reports": <int>
// See description in phase 1.
"event_report_windows": {
"start_time": <int>,
"end_times": [<int>, ...]
}
}
Mit dieser Konfiguration wird der Ausgabebereich der Berichte auf Ereignisebene pro Quellregistrierung vollständig angegeben. Für jede Triggerspezifikation werden folgende Informationen angegeben:
- Eine Reihe von Übereinstimmungskriterien:
- Für welche Triggerdaten diese Spezifikation gilt. Diese Quelle kann nur mit Triggern abgeglichen werden, die einen der angegebenen
trigger_data
-Werte intrigger_specs
haben. Wenn der Trigger also mit dieser Quelle übereinstimmt, seintrigger_data
aber nicht zu den Werten in der Konfiguration der Quelle gehört, wird er ignoriert. - Wenn ein bestimmter Trigger dieser Spezifikation entspricht (
event_report_windows
verwenden). Hinweis: Der Trigger kann auch dann mit einer Quelle für aggregierbare Berichte abgeglichen werden, wenn er die beiden oben genannten Abgleichskriterien nicht erfüllt.
- Für welche Triggerdaten diese Spezifikation gilt. Diese Quelle kann nur mit Triggern abgeglichen werden, die einen der angegebenen
- Ein spezieller Algorithmus zum Zusammenfassen und Gruppieren aller Trigger innerhalb eines Attributionsfensters. So können Sie für Trigger einen
value
-Parameter angeben, der für eine bestimmte Spezifikation summiert, aber als Bucket-Wert erfasst wird.
Bei Triggern wird auch das Hinzufügen eines optionalen Wertparameters in den event_trigger_data
-Wörterbüchern unterstützt.
{
"event_trigger_data": [
{
"trigger_data": "2",
"value": 100, // Defaults to 1
"filters": ...
},
...
]
}
Jede Triggerregistrierung wird mit höchstens einer Triggerspezifikation abgeglichen und der zugehörige Zusammenfassungswert wird aktualisiert. Im Groben passiert bei der Auslösung Folgendes:
- Wenden Sie globale Attributionsfilter an.
- Bewerten Sie für jede Triggerspezifikation die
event_trigger_data
in der Spezifikation, um mithilfe derevent_reporting_window
der Spezifikation eine Übereinstimmung zu finden.event_reporting_windows
auf oberster Ebene dient als Standardwert, falls eine Triggerspezifikation das fehlende untergeordnete Feldevent_report_windows
ist. - Die erste übereinstimmende Spezifikation wird für die Attribution ausgewählt und der Summenwert wird um
value
erhöht.
Wenn der event_report_window
für eine Spezifikation abgeschlossen ist, ordnen wir den Wert der Zusammenfassung einem Bucket zu und senden für jedes Increment im Zusammenfassungs-Bucket, das durch zugeordnete Triggerwerte verursacht wurde, einen Bericht auf Ereignisebene. Die Berichte enthalten ein zusätzliches Feld: trigger_summary_bucket
.
{
...
"trigger_summary_bucket": [<bucket start>, <bucket end>],
}
Konfigurationen, die der aktuellen Version entsprechen
Die folgenden Konfigurationen sind jeweils für das aktuelle Ereignis und die Navigationsquellen der APIs gleichwertig. Insbesondere bei Navigationsquellen wird hier deutlich, warum die Rauschpegel im Vergleich zu Ereignisquellen so hoch sind, um dieselben Epsilonwerte beizubehalten: Navigationsquellen haben einen viel größeren Ausgaberaum.
Es ist möglich, dass es mehrere äquivalente Konfigurationen gibt, da einige Parameter als Standard festgelegt oder entfernt werden können.
Äquivalente Ereignisquellen
// Note: most of the fields here are not required to be explicitly listed.
// Here we list them explicitly just for clarity.
{
"trigger_specs": [
{
"trigger_data": [0, 1],
"event_report_windows": {
"end_times": [<30 days>]
},
"summary_window_operator": "count",
"summary_buckets": [1],
}],
"max_event_level_reports": 1,
...
// expiry must be greater than or equal to the last element of the end_times
"expiry": <30 days>,
}
Gleichwertige Navigationsquellen
// Note: most of the fields here are not required to be explicitly listed.
// Here we list them explicitly just for clarity.
{
"trigger_specs": [
{
"trigger_data": [0, 1, 2, 3, 4, 5, 6, 7],
"event_report_windows": {
"end_times": [<2 days>, <7 days>, <30 days>]
},
"summary_window_operator": "count",
"summary_buckets": [1, 2, 3],
}],
"max_event_level_reports": 3,
...
// expiry must be greater than or equal to the last element of the end_times
"expiry": <30 days>,
}
Beispiele für benutzerdefinierte Konfigurationen
Im Folgenden finden Sie einige zusätzliche Konfigurationen, die nicht zu den Standardeinstellungen gehören. Bei allen diesen Beispielen müssen Entwickler Kompromisse eingehen:
- Eine Dimension der Standardkonfiguration (Anzahl der Trigger, Kardinalität der Triggerdaten, Anzahl der Zeitfenster) reduzieren, um eine andere zu erhöhen und so den Rauschpegel beizubehalten
- Reduzierung einiger Dimensionen der Standardkonfiguration (Anzahl der Trigger, Kardinalität der Triggerdaten, Anzahl der Zeitfenster) für einen geringeren Anteil an Störfaktoren
Wertgruppen für Berichtstrigger festlegen
Diese Beispielkonfiguration unterstützt einen Entwickler, der Wertdaten nur für einen Berichtszeitraum (z. B. 7 Tage) optimieren möchte. So werden weniger Berichtszeiträume verwendet, um weniger Rauschen zu erzielen. In diesem Beispiel kann kein Trigger verwendet werden, bei dem trigger_data
auf einen anderen Wert als 0 festgelegt ist.
{
"trigger_specs": [
{
"trigger_data": [0],
"event_report_windows": {
"end_times": [604800, 1209600] // 7 days, 14 days represented in seconds
},
"summary_window_operator": "value_sum",
"summary_buckets": [5, 10, 100]
}],
}
Trigger können mit dem Feldsatz value
registriert werden, die dann summiert und in Bucket gruppiert werden. Beispiel: Innerhalb von sieben Tagen nach der Registrierung von Quellen gibt es drei Trigger mit den Werten 1, 3 und 4.
{ "event_trigger_data": [{"trigger_data": "0", "value": 1}] }
{ "event_trigger_data": [{"trigger_data": "0", "value": 3}] }
{ "event_trigger_data": [{"trigger_data": "0", "value": 4}] }
Die Werte werden zu 8 addiert und nach 7 Tagen und 1 Stunde in den folgenden Berichten erfasst:
// Report 1
{
...
"trigger_summary_bucket": [5, 9]
}
In den folgenden sieben Tagen werden die folgenden Trigger registriert:
{ "event_trigger_data": [{"trigger_data": "0", "value": 50}] }
{ "event_trigger_data": [{"trigger_data": "0", "value": 45}] }
Die Summe der Werte beträgt 8 + 50 + 45 = 103. Das sind die Berichte, die nach 14 Tagen und 1 Stunde verfügbar sind:
// Report 2
{
...
"trigger_summary_bucket": [10, 99]
},
// Report 3
{
...
"trigger_summary_bucket": [100, MAX_INT]
}
Triggeranzahl in Berichten
In diesem Beispiel wird gezeigt, wie ein Entwickler eine Quelle so konfiguriert, dass eine Triggeranzahl von bis zu 10 ermittelt wird.
{
"trigger_specs": [
{
"trigger_data": [0],
"event_report_windows": {
"end_times": [604800] // 7 days represented in seconds
},
// This field could be omitted to save bandwidth since the default is "count"
"summary_window_operator": "count",
"summary_buckets": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
}],
}
Zugeordnete Trigger, für die trigger_data
auf 0 festgelegt ist, werden gezählt und auf 10 begrenzt.
Der Triggerwert wird ignoriert, da summary_window_operator
auf „Zählen“ gesetzt ist. Wenn vier Trigger registriert und der Quelle zugeordnet sind, sieht der Bericht so aus:
// Report 1
{
...
"trigger_summary_bucket": [1, 1]
}
// Report 2
{
...
"trigger_summary_bucket": [2, 2]
}
// Report 3
{
...
"trigger_summary_bucket": [3, 3]
}
// Report 4
{
...
"trigger_summary_bucket": [4, 4]
}
Binär mit häufigerer Berichterstellung
Diese Beispielkonfiguration unterstützt einen Entwickler, der wissen möchte, ob in den ersten 10 Tagen mindestens eine Conversion stattgefunden hat (unabhängig vom Wert), aber Berichte in kürzeren Intervallen als standardmäßig erhalten möchte. Auch in diesem Beispiel kann kein Trigger verwendet werden, bei dem trigger_data
auf einen anderen Wert als 0 festgelegt wird. Daher wird dieser Anwendungsfall als binär bezeichnet.
{
"trigger_specs": [
{
"trigger_data": [0],
"event_report_windows": {
// 1 day, 2 days, 3 days, 5 days, 7 days, 10 days represented in seconds
"end_times": [86400, 172800, 259200, 432000, 604800, 864000]
},
// This field could be omitted to save bandwidth since the default is "count"
"summary_window_operator": "count",
"summary_buckets": [1]
}],
}
Triggerspezifikationen von Quelle zu Quelle variieren
{
"trigger_specs": [
{
"trigger_data": [0, 1, 2, 3],
"event_report_windows": {
"end_times": [172800, 604800, 2592000] // 2 days, 7 days, 30 days represented in seconds
}
}],
"max_event_level_reports": 3
}
{
"trigger_specs": [
{
"trigger_data": [4, 5, 6, 7],
"event_report_windows": {
"end_times": [172800, 604800, 2592000] // 2 days, 7 days, 30 days represented in seconds
}
}],
"max_event_level_reports": 3
}
Wir möchten Entwickler dazu ermutigen, uns verschiedene Anwendungsfälle für diese API-Erweiterung zu nennen. Wir aktualisieren diese Erläuterung dann mit Beispielkonfigurationen für diese Anwendungsfälle.
Netzwerkübergreifende Attribution ohne Weiterleitungen
AdTech-Anbieter sollten Weiterleitungen verwenden, um mehrere Trigger für Attributionsquellen zu registrieren und eine netzwerkübergreifende Attribution durchzuführen. Diese Funktion unterstützt die netzwerkübergreifende Attribution, wenn Weiterleitungen nicht netzwerkübergreifend möglich sind. Weitere Informationen
Anbieter von Anzeigentechnologien können in der Antwort auf die Triggerregistrierung eine Konfiguration senden, die darauf basiert, welche von anderen Anbietern von Anzeigentechnologien registrierten Quellen ausgewählt werden, um abgeleitete Quellen zu generieren. Diese abgeleiteten Quellen werden dann für die Attribution verwendet. Zusammengefasste Berichte werden generiert, wenn der Trigger einer abgeleiteten Quelle zugeordnet wird. Die Erstellung von Ereignisberichten für abgeleitete Quellen wird nicht unterstützt.
Anbieter von Anzeigentechnologien können aus den aggregation_keys
in ihren registrierten Quellen auswählen, die sie für Anbieter von Anzeigentechnologien freigeben möchten. Diese Schlüssel können im optionalen Feld shared_aggregation_keys
unter dem Header Attribution-Reporting-Register-Source
für die Quellenregistrierung deklariert werden:
"shared_aggregation_keys": ["[key name1]", "[key name2]"]
Abgeleitete Quellen werden basierend auf der Konfiguration unter dem Trigger-Registrierungsheader Attribution-Reporting-Register-Trigger
generiert:
// Specifies the configuration based on which derived sources should be
// generated. Those derived sources will be included for source matching at the
// time of attribution. For example, if adtech2 is registering a trigger with an
// attribution_config with source_network as adtech1, available sources
// registered by adtech1 will be considered with additional filtering criteria
// applied to that set as mentioned in the attribution_config. Derived
// sources can have different values to priority, post_install_exclusivity_window
// etc.
"attribution_config": [
{
// Derived sources are created from this adtech's registered sources
"source_network": "[original source's adtech enrollment ID]",
//(optional) Filter sources whose priority falls in this range
"source_priority_range": {
"start": [priority filter lower bound],
"end": [priority filter upper bound]
},
// (optional) Filter sources whose at least one of filter maps matches these
// filters
"source_filters": {
"key name 1": ["key1 value 1"]
},
// (optional) Filter sources whose none of filter map matches these
// filters
"source_not_filters": {
"key name 1": ["key1 value 1"]
},
// (optional) Apply this priority to the generated derived sources
"priority": "[64 bit signed integer]",
// (optional) The derived source will have expiry set as this or parent
// source's, whichever is earlier
"expiry": "[64 bit signed integer]",
// (optional) set on the derived source
"filter_data": {
"key name 1": ["key1 value 1"]
},
// (optional) set on the derived source
"post_install_exclusivity_window": "[64-bit unsigned integer]"
}
]
Hier ist eine Version mit hinzugefügten Beispielwerten:
"attribution_config": [
{
"source_network": "adtech1-enrollment-id",
"source_priority_range": {
"start": 50,
"end": 100
},
"source_filters": {
"source_type": ["NAVIGATION"]
},
"source_not_filters": {
"product_id": ["789"]
},
"priority": "30",
"expiry": "78901",
// (optional) set on the derived source
"filter_data": {
"product_id": ["1234"]
},
// (optional) set on the derived source
"post_install_exclusivity_window": "7890"
}
]
Es werden zwei neue optionale Felder hinzugefügt, um den Registrierungsheader auszulösen. Mit diesen Feldern können Sie die Kennung der ausgewählten Anzeigentechnologie in aggregierbare Berichtsschlüssel einfügen:
x_network_bit_mapping
: Bitzuordnung der Registrierungs-ID zur ID der Anzeigentechnologiex_network_data
: Offset (Linksverschiebung) für denx_network_bit_mapping
ODER-Vorgang der ausgewählten Anzeigentechnologie mit dem Triggerschlüssel
Beispiel:
"Attribution-Reporting-Register-Trigger": {
"attribution_config": [...],
"aggregatable_trigger_data": [
{
"key_piece": "0x400",
"source_keys": ["campaignCounts"]
"x_network_data" : {
"key_offset" : 12 // [64 bit unsigned integer]
}
}
…
]
…
"x_network_bit_mapping": {
// This mapping is used to generate trigger key pieces with AdTech identifier
// bits. eg. If AdTechA's sources wins the attribution then 0x1 here will be
// OR'd with the trigger key pieces to generate the final key piece.
"AdTechA-enrollment_id": "0x1", // Identifier bits in hex for A
"AdTechB-enrollment_id": "0x2" // Identifier bits in hex for B
}
…
}
Hier ist die resultierende Berechnung des Trigger-Schlüsselelements beim Erstellen eines Berichts für die Quelle von AdTechB:
key_piece
:0x400 (010000000000)
key_offset
:12
enrollment_id
-Wert von AdtechB:2 (010)
(vonx_network_bit_mapping
)- Trigger-Schlüssel für das Ergebnis:
0x400 | 0x2 << 12 = 0x2400
Beschränkungen
Eine Liste der in der Entwicklung befindlichen Funktionen für die SDK-Laufzeit finden Sie in den Versionshinweisen.
Fehler und Probleme melden
Ihr Feedback ist ein wichtiger Bestandteil der Privacy Sandbox für Android. Bitte teilen Sie uns Probleme oder Ideen zur Verbesserung der Privacy Sandbox für Android mit.