Zarejestruj źródła atrybucji

Dowiedz się, jak zarejestrować źródła, aby przypisywać kliknięcia i wyświetlenia do odpowiednich zdarzeń.

Źródło atrybucji to zdarzenie związane z reklamą (kliknięcie lub wyświetlenie), do którego technika reklamowa może dołączać następujące informacje: – Dane raportowania kontekstowego, np. identyfikator kreacji, informacje o kampanii lub dane geograficzne. – miejsce docelowe konwersji, np. witryna, w której oczekujesz konwersji od użytkownika;

Wykonując czynności opisane w tym dokumencie, możesz rejestrować źródła (wyświetlenia lub kliknięcia reklam), do których przeglądarka przypisuje konwersje.

Metody rejestracji

Aby zarejestrować źródła atrybucji, użyj elementów HTML lub wywołań JavaScript:

  • Tag <a>
  • Tag <img>
  • Tag <script>
  • fetch komponent do wykonywania połączeń
  • XMLHttpRequest
  • window.open

Spowoduje to wygenerowanie żądań sieciowych, na które odpowiadasz za pomocą nagłówka odpowiedzi HTTP rejestracji źródłowej.

Rejestrowanie źródeł kliknięć lub wyświetleń

Aby zarejestrować źródło atrybucji dla kliknięć lub wyświetleń, wykonaj czynności opisane tutaj. Postępuj zgodnie z instrukcjami. Oto podsumowanie:

  1. Rozpocznij rejestrację źródła. Wyślij żądanie za pomocą elementu HTML lub wywołania JavaScript. Ten krok różni się w przypadku kliknięć i wyświetleń, jak zauważysz w sekcjach poniżej.

  2. Dokończ rejestrację źródła, odpowiadając za pomocą nagłówka źródłowej rejestracji. Po otrzymaniu tego żądania wyślij w odpowiedzi nagłówek Attribution-Reporting-Register-Source. W nagłówku wpisz pożądaną konfigurację raportowania atrybucji. Ten krok jest taki sam w przypadku kliknięć i wyświetleń.

    Przykład raportów podsumowujących:

    {
  "aggregation_keys": {
    "campaignCounts": "0x159", 
    "geoValue": "0x5" 
  },
  "aggregatable_report_window": "86400",
  "destination": "https://example.com"
}

    Przykładowe raporty na poziomie zdarzenia:

    {
  "source_event_id": "12340873456",
  "destination": "[eTLD+1]",
  "expiry": "[64-bit signed integer]",
  "priority": "[64-bit signed integer]",
  "event_report_window": "[64-bit signed integer]"
}

Atrybuty wymagane i opcjonalne

Do rejestrowania źródeł używasz elementów HTML lub wywołań JavaScriptu, dlatego może być konieczne użycie metody attributionsrc lub attributionReporting. W tabeli poniżej znajdziesz szczegółowe informacje o tym, kiedy są one wymagane.

Gdy pole attributionsrc ma wartość opcjonalne, wskazuje, że żądanie kwalifikuje się do raportowania atrybucji. Jeśli użyjesz właściwości attributionsrc, przeglądarka wysyła nagłówek Attribution-Reporting-Eligible. Jest to też przydatne w przypadku pomiarów między aplikacją a stroną internetową: jeśli atrybut attributionsrc jest podany, przeglądarka wysyła nagłówek Attribution-Reporting-Support.

Metoda rejestracji Źródło
Tag <a> (źródło nawigacji)
Parametr attributionsrc jest wymagany.
Tag <img> (źródło zdarzenia)
Parametr attributionsrc jest wymagany.
Tag <script> (źródło zdarzenia)
Parametr attributionsrc jest wymagany.
fetch komponent do wykonywania połączeń Opcja attributionReporting jest wymagana.
XMLHttpRequest Opcja attributionReporting jest wymagana.
window.open() (źródło nawigacji)
Parametr attributionsrc jest wymagany.

Krok 1. Rozpocznij rejestrację źródła

Krok 1 jest inny w przypadku kliknięć i wyświetleń. Otwórz odpowiednią kartę każdego z nich.

Aby zarejestrować źródło atrybucji dla kliknięcia, możesz użyć tagu <a> lub JavaScriptu window.open().

Korzystanie z kotwicy

Dodaj attributionsrc do dotychczasowych tagów <a>, w których przypadku chcesz mierzyć wyświetlenia lub kliknięcia:

<a href="https://shoes.example/..." 
  attributionsrc>Click me</a>

Więcej informacji znajdziesz w przykładowym kodzie.

Za pomocą skryptu

Zadzwoń do użytkownika window.open(), używając numeru attributionsrc:

window.open(
  "https://shoes.example/...",
  "_blank",
  "attributionsrc");

Aby ta metoda została uwzględniona, trzeba ją wywołać w ciągu 5 sekund od interakcji użytkownika.

Zamiast dodawać element attributionsrc samodzielnie, dla obrazu lub skryptu możesz podać pojedynczą wartość adresu URL:

<a href=... attributionsrc="https://a.example/register-source">

Jeśli w przypadku JavaScriptu podasz wartość parametru attributionsrc, pamiętaj, by go zakodować. Adres URL może zawierać znaki specjalne, np. „=”, które mogłyby spowodować nieprawidłową analizę parametru.

Zakoduj w ten sposób: 

const encodedUrl = encodeURIComponent(
  'https://adtech.example/attribution_source?ad_id=...');
window.open(
  "https://shoes.example/landing",
   "_blank",
   attributionsrc=${encodedUrl});

attributionsrc może też pobrać listę adresów URL oddzielonych spacjami, jak pokazano tutaj za pomocą tagu kotwicy:

<!-- With an anchor tag -->
<a href=... attributionsrc="https://a.example/register-source 
  https://b.example/register-source">

lub tak jak tutaj, za pomocą funkcji window.open().

// With window.open()
window.open('...', '_blank', attributionsrc=${encodedUrl1}
  attributionsrc=${encodedUrl2})

W takich przypadkach oba adresy URL otrzymują żądania attributionsrc typu navigation-source-eligible (zawierające nagłówek Attribution-Reporting-Eligible).

attributionsrc z wartością lub bez niej

Jak widać, możesz określić pole attributionsrc bez adresu URL. Możesz też podać jeden adres URL. Dodatkowo w przypadku źródeł (nie dotyczy reguł) możesz użyć listy adresów URL rozdzielonych spacjami.

Korzystanie z adresów URL powoduje, że przeglądarka wysyła osobne żądanie pobierania podtrzymujące aktywność (po jednym na każdy adres URL), które obejmuje nagłówek żądania Attribution-Reporting-Eligible.

Jest to przydatne, gdy chcesz zarejestrować źródło, odpowiadając na żądanie, które jest niezależne od głównego żądania elementu.

Jeśli np. musisz zarejestrować źródła dla kliknięć elementu zakotwiczonego, możesz nie mieć kontroli nad miejscem docelowym. W tym przypadku potrzebujesz konfiguracji, w której wysyłasz nagłówek rejestracji źródłowej jako odpowiedź na żądanie, które jest niezależne od nawigacji i które możesz w pełni kontrolować. Określając jawną wartość atrybutu attributionsrc, informujesz przeglądarkę, że ma wykonać dodatkowe żądanie i skonfigurować miejsce docelowe.

W kroku 1 rejestracji widoków danych przejdź do kart i wybierz Widoki 1.

Aby zarejestrować źródło atrybucji dla widoku, możesz użyć tagu obrazu lub skryptu, do którego dodasz atrybut attributionsrc.

Możesz też użyć JavaScriptu fetch() lub XMLHttpRequest().

Z obrazem

<img attributionsrc
src="https://adtech.example/attribution_source?ad_id=..."/>

Za pomocą skryptu

<script attributionsrc
  src="https://adtech.example/attribution_source?ad_id=..."/>

Opcjonalnie możesz określić adres URL attributionsrc w taki sam sposób jak w przypadku kliknięć. Na przykład w przypadku obrazu lub skryptu możesz ustawić adres URL attributionsrc lub te adresy URL w ten sposób:

Za pomocą jednego adresu URL:

 attributionsrc="https://adtech.example/attribution_source?ad_id=123"

Dzięki liście adresów URL:

  attributionsrc="https://a.example/register-source
    https://b.example/register-source"

Używasz fetch() lub XMLHttpRequest()

Ten kod skutecznie symuluje działanie żądania HTML z użyciem elementu attributionsrc:

// With fetch
const attributionReporting = {
  eventSourceEligible: true,
  triggerEligible: false,
};

// Optionally set keepalive to ensure the request outlives the page.
window.fetch("https://adtech.example/attribution_source?my_ad_id=123", { 
  keepalive: true, attributionReporting });

// With XHR
const attributionReporting = {
  eventSourceEligible: true,
  triggerEligible: false,
};

const req = new XMLHttpRequest();
  req.open('GET', url);
  req.setAttributionReporting(
    attributionReporting);
  req.send();

Aby rozpocząć pierwszy krok rejestracji kliknięć, otwórz karty i wybierz Kliknięcia krok 1.

Krok 2. Odpowiedz nagłówkiem (kliknięcia i wyświetlenia)

Następnym krokiem w przypadku kliknięć i wyświetleń jest przesłanie w odpowiedzi nagłówka Attribution-Reporting-Register-Source.

Więcej informacji znajdziesz w przykładowym kodzie.

Gdy serwer odbierze żądanie przeglądarki, odpowiedz i dołącz do odpowiedzi nagłówek Attribution-Reporting-Register-Source.

 res.set(
  'Attribution-Reporting-Register-Source',    
  JSON.stringify({
    // Use source_event_id to map it to any granular information
      // you need at ad-serving time
      source_event_id: '412444888111012',
      destination: 'https://advertiser.example',
      // Optional fields
      expiry: '604800',
      priority: '100',
      debug_key: '122939999'
    })
 );

Po utworzeniu ciągu znaków nagłówek będzie wyglądać tak:

{"source_event_id":"412444888111012","destination":"https://advertiser.example","expiry":"604800","priority":"100","debug_key":"122939999"}

Dalsze kroki

Dowiedz się, jak zarejestrować reguły atrybucji.