Attribution Reporting API: przewodnik po integracji

Podczas lektury dokumentacji Piaskownicy prywatności na Androida użyj przycisku Podgląd dla programistów lub Beta, aby wybrać wersję programu, z której korzystasz (instrukcje mogą się różnić).


Interfejs Attribution Reporting API obsługuje kluczowe przypadki użycia atrybucji i pomiaru konwersji w aplikacjach i w internecie bez korzystania z własnych identyfikatorów użytkowników. W porównaniu z typowymi schematami osoby implementujące interfejs Attribution Reporting API powinny wziąć pod uwagę kilka ważnych kwestii ogólnych:

  • Raporty na poziomie zdarzenia zawierają niedokładne dane o konwersjach. Mała liczba wartości konwersji sprawdza się dobrze.
  • Raporty agregujące zawierają bardziej precyzyjne dane o konwersjach. Klucze agregacji powinny być zaprojektowane w sposób dostosowany do wymagań Twojej firmy i limitu 128-bitowego.
  • Modele danych i przetwarzanie danych w rozwiązaniu powinny uwzględniać limity szybkości dotyczące dostępnych aktywatorów, opóźnienia w wysyłaniu zdarzeń reguły oraz szumy stosowane przez interfejs API.

Aby pomóc Ci w planowaniu integracji, w tym przewodniku znajdziesz kompleksowe informacje, które mogą obejmować funkcje, które nie są jeszcze wdrożone na obecnym etapie Piaskownicy prywatności w wersji przedpremierowej dla programistów aplikacji na Androida. W takich przypadkach przedstawiamy wytyczne dotyczące harmonogramu.

Na tej stronie używamy słowa źródło do reprezentowania kliknięcia lub wyświetlenia, a reguły do reprezentowania konwersji.

Wykres poniżej przedstawia różne opcje przepływu pracy podczas integracji atrybucji. Sekcje wymienione w tej samej kolumnie (zakreślone na zielono) można pracować równolegle, np. w tym samym czasie co atrybucja na poziomie zdarzenia na poziomie zdarzenia i zaangażowanie partnera.

Diagram przepływu pracy integracji atrybucji

Rysunek 1. Proces integracji atrybucji.

Wymagania wstępne i konfiguracja

Wykonaj czynności z tej sekcji, aby lepiej poznać interfejs Attribution Reporting API. Opisane tu czynności pozwolą Ci uzyskiwać wartościowe wyniki podczas korzystania z interfejsu API w ekosystemie technologii reklamowych.

Zapoznanie się z interfejsem API

  1. Zapoznaj się z propozycją projektu, aby zapoznać się z interfejsem Attribution Reporting API i jego możliwościami.
  2. Informacje o tym, jak uwzględnić kod i wywołania interfejsu API, których potrzebujesz w swoich zastosowaniach, znajdziesz w przewodniku dla programistów.
  3. Prześlij opinię na temat dokumentacji, zwłaszcza w przypadku pytań otwartych.
  4. Zarejestruj się, aby otrzymywać najnowsze informacje o interfejsie Attribution Reporting API. Dzięki temu będziesz na bieżąco z nowymi funkcjami wprowadzonymi w kolejnych wersjach.

Konfigurowanie i testowanie przykładowej aplikacji

  1. Gdy wszystko będzie gotowe do rozpoczęcia integracji, skonfiguruj najnowszą wersję przedpremierową dla programistów w Android Studio.
  2. Konfigurowanie pozorowanych punktów końcowych serwera na potrzeby rejestracji wydarzeń i dostarczania raportów. Przygotowaliśmy przykłady, których możesz używać razem z narzędziami dostępnymi online.
  3. Pobierz i uruchom kod w naszej przykładowej aplikacji, aby zapoznać się ze źródłami i aktywatorami rejestracji.
    1. Ustaw przedział czasu wysyłania raportów. Interfejs API obsługuje okna o długości 2 dni, 7 dni lub niestandardowy okres od 2 do 30 dni.
    2. Po zarejestrowaniu źródeł i aktywatorów poprzez uruchomienie przykładowej aplikacji i użycie jej oraz upłynięcie wyznaczonego okresu sprawdź, czy dotarł do Ciebie raport na poziomie zdarzenia i zaszyfrowany raport zbiorczy. Jeśli musisz debugować raporty, możesz wygenerować je szybciej, wymuszając wykonywanie zadań raportowania.
    3. Sprawdź wyniki atrybucji między aplikacją a aplikacją. Sprawdź, czy dane w tych wynikach są zgodne z oczekiwaniami zarówno w przypadku ostatniej interakcji, jak i po instalacji.

  4. Gdy już zorientujesz się, jak współdziałają interfejs API klienta i serwer, posłuż się przykładową aplikacją, aby przeprowadzić własną integrację. Skonfiguruj własny serwer produkcyjny i dodaj do swoich aplikacji wywołania rejestracji zdarzeń.

Wstępna integracja

Zarejestruj organizację w Piaskownicy prywatności na Androida. Rejestracja ta ma na celu zapobieganie niepotrzebnemu powielaniu platform technologii reklamowych, co umożliwiłoby dostęp do większej ilości informacji o działaniach użytkownika niż jest to konieczne.

Zaangażowanie partnera

Partnerzy w zakresie technologii reklamowych (MMP/SSP/DSP) często tworzą zintegrowane rozwiązania atrybucji. Instrukcje z tej sekcji pomogą Ci przygotować się do skutecznego nawiązywania kontaktu z partnerami w dziedzinie technologii reklamowych.

  1. Umów się na rozmowę z najważniejszymi partnerami świadczącymi usługi pomiarowe, aby omówić testowanie i wdrażanie interfejsu Attribution Reporting API. Partnerzy świadczący usługi pomiarowe mogą obejmować sieci technologii reklamowych, platformy SSP, platformy DSP, reklamodawców i wszelkich innych partnerów, z którymi obecnie współpracujesz lub z którymi chcesz współpracować.
  2. Współpracuj z partnerami świadczącymi usługi pomiarowe, aby określić ramy czasowe integracji – od wstępnego testowania do wdrażania.
  3. Uzgodnij z partnerami świadczącymi usługi pomiarowe, jakie obszary zastosowań każda z nich będzie omawiać w projekcie atrybucji.
  4. Stwórz kanały komunikacji między partnerami świadczącymi usługi pomiarowe, aby synchronizować je na osi czasu i prowadzić kompleksowe testy.
  5. Zaprojektuj ogólne przepływy danych między partnerami świadczącymi usługi pomiaru. Oto najważniejsze kwestie, które należy wziąć pod uwagę:
    • W jaki sposób partnerzy świadczący usługi pomiarowe będą rejestrować źródła atrybucji za pomocą interfejsu Attribution Reporting API?
    • W jaki sposób sieci technologii reklamowych będą rejestrować reguły w interfejsie Attribution Reporting API?
    • W jaki sposób poszczególne technologie reklamowe będą weryfikować żądania do interfejsu API i zwracać odpowiedzi dotyczące kompletnych źródeł i aktywować rejestracje?
    • Czy są jakieś raporty, które trzeba udostępniać partnerom spoza Attribution Reporting API?
    • Czy między partnerami są potrzebne jakieś inne punkty integracji lub uzgodnienia? Na przykład: czy Ty i Twoi partnerzy musicie pracować nad duplikowaniem konwersji czy ujednolicaniem kluczy agregacji?
  6. Jeśli ma zastosowanie atrybucja z aplikacji do witryny, zaplanuj w internecie dyskusję z partnerami świadczącymi usługi pomiarowe, aby omówić projektowanie, testowanie i wdrażanie interfejsu Attribution Reporting API. Zaczynając rozmowy z partnerami internetowymi, zapoznaj się z pytaniami z poprzedniego kroku.

Prototypowa atrybucja konwersji na poziomie zdarzenia między aplikacją a aplikacją

Ta sekcja pomoże Ci skonfigurować podstawową atrybucję między aplikacją a aplikacją za pomocą raportów na poziomie zdarzenia w aplikacji lub pakiecie SDK. Musisz wypełnić tę sekcję, zanim zaczniesz używać modelu atrybucji serwera agregacji.

  1. Skonfiguruj serwer zbierający rekordy zdarzeń. Możesz to zrobić, korzystając z podanej specyfikacji, aby wygenerować próbny serwer, lub skonfigurować własny serwer, używając przykładowego kodu serwera.
  2. Dodaj do pakietu SDK lub aplikacji wywołania zdarzenia źródła rejestracji w trakcie wyświetlania reklam.
    • Oto najważniejsze kwestie, które należy wziąć pod uwagę:
      • Upewnij się, że identyfikatory zdarzeń źródłowych są dostępne i przekazywane prawidłowo do wywołań interfejsu API rejestracji źródeł.
      • Sprawdź, czy możesz też przekazać zdarzenie „InputEvent”, aby zarejestrować źródła kliknięć.
      • Określ, jak skonfigurować priorytet źródła w przypadku różnych typów zdarzeń. Wysoki priorytet możesz na przykład przypisać zdarzeniom o dużej wartości, takim jak kliknięcia czy wyświetlenia.
      • Domyślna wartość okresu ważności jest odpowiednia do testowania. Możesz też skonfigurować inne okresy ważności.
      • Filtry i okna atrybucji można pozostawić jako domyślne na potrzeby testowania.
    • Opcjonalne uwagi:
      • Zaprojektuj klucze agregacji, jeśli gotowe.
      • Ustalając, jak chcesz współpracować z innymi partnerami świadczącymi usługi pomiaru, zastanów się nad strategią przekierowania.
  3. Aby rejestrować zdarzenia konwersji, dodaj do pakietu SDK lub aplikacji rejestrujące zdarzenia aktywujące.
    • Oto najważniejsze kwestie, które należy wziąć pod uwagę:
    • Opcjonalne uwagi:
      • Pomiń tworzenie kluczy do deduplikacji, dopóki nie przeprowadzisz testów dokładności.
      • Pomiń tworzenie kluczy i wartości agregacji, dopóki obsługa testowania symulacji nie będzie gotowa.
      • Pomiń przekierowania, dopóki nie ustalisz, jak chcesz współpracować z innymi partnerami świadczącymi usługi pomiaru.
      • Priorytet aktywatora nie jest wymagany do testowania.
      • Filtry mogą być ignorowane na etapie wstępnego testowania.
  4. Sprawdź, czy zdarzenia źródłowe są generowane dla reklam i czy te reguły prowadzą do tworzenia raportów o zdarzeniach.

Testowanie symulacji

W tej sekcji dowiesz się, jaki wpływ na systemy raportowania i optymalizacji może mieć przeniesienie obecnych konwersji do raportów zdarzeń i raportów zbiorczych. Umożliwi Ci to rozpoczęcie testowania wpływu przed zakończeniem integracji.

Testowanie polega na symulowaniu generowania raportów zdarzeń i agregacji raportów na podstawie historycznych rekordów konwersji, a następnie pobierania zagregowanych wyników z symulowanego serwera agregacji. Wyniki można porównać z historycznymi liczbami konwersji, by sprawdzić, jak zmieni się dokładność raportów.

Na podstawie tych raportów można wytrenować modele optymalizacji, np. obliczanie przewidywanego współczynnika konwersji, aby porównywać dokładność tych modeli z dokładnością tych modeli w porównaniu z modelami opartymi na bieżących danych. Jest to również okazja do eksperymentowania z różnymi strukturami kluczy agregacji oraz ich wpływem na wyniki.

  1. Skonfiguruj bibliotekę symulacji pomiarów na komputerze lokalnym.
  2. Przeczytaj spec dotyczącą formatu danych o konwersjach, aby były one zgodne z symulowanym generatorem raportów.
  3. Zaprojektuj klucze agregacji zgodnie z wymaganiami biznesowymi.
    • Oto najważniejsze kwestie, które należy wziąć pod uwagę:
      • Zastanów się, jakie wymiary kluczowe muszą mieć Twoi klienci lub partnerzy, i skoncentruj się na nich podczas oceny.
      • Określ minimalną liczbę zagregowanych wymiarów i mocy zbioru, która jest wymagana do spełnienia Twoich wymagań.
      • Upewnij się, że fragmenty klucza po stronie źródła i aktywatora nie przekraczają 128 bitów.
      • Jeśli Twoje rozwiązania obejmują udział w kilku wartościach na zdarzenie aktywujące, pamiętaj, aby przeskalować te wartości do maksymalnego budżetu darowizny, czyli poziomu L1. Pomoże to zminimalizować wpływ szumu.
      • Oto przykład, który pokazuje, jak skonfigurować klucz do zbierania zbiorczych danych o liczbie konwersji na poziomie kampanii oraz klucz do zbierania zbiorczych wartości zakupów na poziomie geograficznym.
  4. Uruchom generator raportów, by utworzyć raporty o zdarzeniach i raporty zbiorcze.
  5. Generowanie raportów zbiorczych za pomocą symulowanych serwerów agregacji, aby uzyskać raporty podsumowujące.
  6. Przeprowadzaj eksperymenty użytkowe:
    • Możesz porównywać łączne liczby konwersji z raportów podsumowujących i na poziomie zdarzenia z historycznymi danymi o konwersjach, aby sprawdzić dokładność raportowania konwersji. Aby uzyskać najlepsze wyniki, przeprowadzaj testy raportowania i porównania na szerokiej, reprezentatywnej części bazy reklamodawców.
    • Ponownie wytrenuj modele na podstawie danych do raportów na poziomie zdarzenia i potencjalnie zebranych danych z raportów. Porównaj dokładność z modelami opartymi na historycznych danych do trenowania.
    • Wypróbuj różne strategie grupowania i zobacz, jak wpływają na Twoje wyniki.
      • Oto najważniejsze kwestie, które należy wziąć pod uwagę:
      • Terminowość raportów podsumowujących dotyczących dostosowywania stawek.
      • Średnia częstotliwość przypisanych zdarzeń na urządzeniu. Na przykład nieaktywni użytkownicy powracający na podstawie historycznych danych zdarzeń zakupu.
      • Poziom hałasu. Im więcej wsadów, tym mniejsza agregacja, a mniejsza agregacja, tym większa ilość szumu.

Atrybucja serwera agregacji opartego na prototypie: konfiguracja

Dzięki temu będziesz otrzymywać zbiorcze raporty o zdarzeniach źródłowych i regułach.

  1. Skonfiguruj serwer agregacji:
    • Skonfiguruj konto AWS.
    • Zarejestruj się w usłudze agregacji razem z koordynatorem.
    • Skonfiguruj serwer agregacji na AWS, korzystając z udostępnionych plików binarnych.
  2. Zaprojektuj klucze agregacji zgodnie z wymaganiami biznesowymi. Jeśli to zadanie zostało już przez Ciebie wykonane w sekcji zdarzenia z aplikacji na poziom zdarzenia, możesz pominąć ten krok.
  3. Skonfigurowanie serwera zbierającego dane do raportów zbiorczych. Jeśli w sekcji na poziomie zdarzenia typu aplikacja-to aplikacja masz już utworzoną regułę, możesz ją ponownie wykorzystać.

Atrybucja serwera agregacji prototypu: integracja

Aby przejść dalej, musisz wypełnić sekcję Prototypowanie atrybucji serwera agregacji: konfiguracja lub prototypowanie atrybucji z aplikacji do atrybucji na poziomie zdarzenia w aplikacji**.

  1. Dodaj dane klucza agregacji do zdarzenia źródłowego i reguły. Prawdopodobnie będzie to wymagało przekazania do pakietu SDK lub aplikacji większej ilości danych o zdarzeniu reklamowym, np. identyfikatora kampanii, które zostaną uwzględnione w kluczu agregacji.
  2. Zbieraj połączone raporty ze źródła i aktywuj zdarzenia powiązane z aplikacjami, które zostały zarejestrowane z użyciem danych kluczy agregacji.
  3. Przetestuj różne strategie grupowania, generując raporty zbiorcze na serwerze agregacji, i sprawdź, jak wpływają one na Twoje wyniki.

Ulepszona architektura z opcjonalnymi funkcjami

Poniżej znajdziesz dodatkowe funkcje, które możesz uwzględnić w swoim rozwiązaniu pomiarowym.

  1. Skonfigurowanie klucza debugowania umożliwi Ci otrzymywanie niezmienionego raportu o źródle lub zdarzeniu aktywatora w niezmienionej postaci, a także raportów wygenerowanych przez interfejs Attribution Reporting API. Kluczy debugowania możesz używać do porównywania raportów i znajdowania błędów podczas integracji.

Dostosuj zachowania atrybucji

  1. Atrybucja reguł po instalacji
    • Tej funkcji można użyć w przypadku, gdy reguły po instalacji muszą być przypisane do tego samego źródła atrybucji, które doprowadziło do instalacji, nawet jeśli później istnieją inne odpowiednie źródła atrybucji.
    • Użytkownik może na przykład kliknąć reklamę, która doprowadziła do instalacji. Po jej zainstalowaniu użytkownik klika kolejną reklamę i dokonuje zakupu. W takim przypadku firma zajmująca się technologiami reklamowymi może chcieć, aby zakup był przypisywany do pierwszego kliknięcia, a nie do kliknięcia ponownego zaangażowania.
  2. Używanie filtrów do dopasowywania danych w raportach na poziomie zdarzenia
    • Filtry konwersji można skonfigurować tak, aby ignorowały wybrane reguły i wykluczały je z raportów o zdarzeniach. Istnieją ograniczenia liczby reguł na źródło atrybucji, więc filtry umożliwiają uwzględnianie w raportach zdarzeń tylko tych reguł, które dostarczają najbardziej użytecznych informacji.
    • Filtry mogą też służyć do selektywnego odfiltrowywania niektórych reguł, dzięki czemu możesz je skutecznie ignorować. Jeśli np. masz kampanię kierowaną na instalacje aplikacji, możesz odfiltrowywać reguły powiązane z instalacją, tak aby nie były przypisywane do źródeł z tej kampanii.
    • Za pomocą filtrów możesz też dostosować dane reguły na podstawie danych źródłowych. Na przykład źródło może zawierać parametr "product" : ["1234"], gdzie produkt to klucz filtra, a 1234 to wartość. Każda reguła z kluczem filtra „produkt” o wartości innej niż „1234” jest ignorowana.
  3. Dostosowanie priorytetu źródła i reguły
    • Jeśli z regułą można powiązać wiele źródeł atrybucji lub do źródła można przypisać wiele reguł, możesz użyć 64-bitowej liczby całkowitej, aby nadać priorytet określonym atrybucjom źródła/reguł.

Współpraca z MMP i innymi firmami

  1. Przekierowuje do innych firm zewnętrznych w przypadku zdarzeń źródła i aktywatorów
    • Możesz ustawić przekierowania, tak by wiele platform technologii reklamowych mogło zarejestrować żądanie. Pozwala to włączyć usuwanie duplikatów między sieciami w atrybucji.
  2. Klucze deduplikacji
    • Jeśli reklamodawca używa wielu platform technologii reklamowych do rejestrowania tego samego zdarzenia reguły, można użyć klucza deduplikacji, aby wyodrębnić powtarzające się raporty. Jeśli nie podasz klucza do usuwania duplikatów, zduplikowane reguły mogą być raportowane na każdej platformie technologii reklamowych jako unikalne.

Praca z pomiarami na wielu platformach

  1. Atrybucja w różnych aplikacjach i w witrynach (dostępna pod koniec IV kwartału)
    • Obsługuje przypadki użycia, w których użytkownik widzi reklamę w aplikacji, a potem dokonuje konwersji w przeglądarce na urządzeniu mobilnym lub w aplikacji lub odwrotnie.