Protected Audience API açık artırma sonuçları hakkında rapor oluşturma

Protected Audience API açık artırma raporları oluşturmayla ilgili satıcı ve alıcı kılavuzu.

Bu makale, deneysel Protected Audience API'nin mevcut yinelemesinde kullanılan Protected Audience API açık artırma kazançları için rapor oluşturmayla ilgili teknik bir referanstır.

Protected Audience API'nin tüm yaşam döngüsü için geliştirici kılavuzunu okuyun ve etkinlik düzeyinde raporlama (geçici) hakkında ayrıntılı bilgi edinmek için Protected Audience API açıklayıcısına bakın.

Geliştirici değil misiniz? Protected Audience API'ye genel bakış başlıklı makaleyi inceleyin.

Protected Audience API neyi raporlar?

İki Protected Audience API raporu mevcuttur:

  • Satıcı raporu: Satıcıyı reklam açık artırması kazananı hakkında bilgilendirir.
  • Alıcı raporu: Yalnızca kazanan alıcılar tarafından kullanılabilir. Bu rapor, alıcılara bir açık artırmayı kazandıklarını bildirir.

Uzun vadeli plan, tarayıcının Private Aggregation API'leri ile satıcı ve alıcılar için açık artırma sonuçlarını bildirmesine izin vermektir. Geçici bir etkinlik düzeyinde raporlama mekanizması olarak, satıcı için reportResult() ve kazanan teklif sahibi için reportWin() uygulayan kod, sendReportTo() işlevini çağırabilir. Bu işlev tek bir bağımsız değişken alır: açık artırma tamamlandıktan sonra getirilen ve raporlanacak etkinlik düzeyindeki bilgileri kodlayan bir URL'yi temsil eden dize.

API işlevleri

Satıcı: reportResult()

decisionLogicUrl içinde sağlanan satıcının JavaScript'i (scoreAd() de sağlar) açık artırma sonucunu bildirmek için reportResult() işlevini içerebilir.

reportResult(auctionConfig, browserSignals) {
  ...
  return signalsForWinner;
}

Bu işleve iletilen bağımsız değişkenler şunlardır:

auctionConfig

navigator.runAdAuction()'ya iletilen açık artırma yapılandırma nesnesi.

browserSignals

Tarayıcı tarafından oluşturulan ve açık artırma hakkında bilgi sağlayan bir nesne. Örneğin:

  {
    'topWindowHostname': 'publisher.example',
    'interestGroupOwner': 'https://dsp.example',
    'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
    'bid': <bidValue>,
    'desirability': <winningAdScore>
  }

Bu işlevin döndürdüğü değer, kazanan teklif verenin reportWin() işlevi için sellerSignals bağımsız değişkeni olarak kullanılır.

Alıcı: reportWin()

Açık artırmayı kazanan teklif verenin JavaScript'i (generateBid() de sağlayan) açık artırma sonucunu bildirmek için bir reportWin() işlevi içerebilir.

reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
  ...
}

Bu işleve iletilen bağımsız değişkenler şunlardır:

auctionSignals ve perBuyerSignals

Kazanan teklif veren için generateBid()'ye iletilen değerlerle aynıdır.

sellerSignals

Satıcıya alıcıya bilgi aktarma fırsatı veren reportResult() öğesinin dönüş değeri.

browserSignals

Tarayıcı tarafından oluşturulan ve açık artırma hakkında bilgi sağlayan bir nesne. Örneğin:

{
  'topWindowHostname': 'publisher.example',
  'seller': 'https://ssp.example',
  'interestGroupOwner': 'https://dsp.example',
  'interestGroupName': 'custom-bikes',
  'renderUrl': 'https://cdn.example/winning-creative.wbn',
  'bid': <bidValue>
}

Geçici raporlama uygulaması

Chrome'da geçici olarak kullanılabilen iki açık artırma raporlama yöntemi vardır:

  • forDebuggingOnly.reportAdAuctionLoss()
  • forDebuggingOnly.reportAdAuctionWin()

Bu yöntemlerin her biri tek bir bağımsız değişken alır: açık artırma tamamlandıktan sonra getirilecek bir URL. Hem scoreAd() hem de generateBid() içinde farklı URL bağımsız değişkenleriyle birden çok kez çağrılabilirler.

Chrome, yalnızca bir açık artırma tamamlandığında hata ayıklama kaybı/kazanma raporları gönderir. Bir açık artırma iptal edilirse (ör. yeni bir gezinme nedeniyle) rapor oluşturulmaz.

Bu yöntemler, chrome://settings/adPrivacy bölümünde tüm reklam gizliliği API'lerini etkinleştirdiğinizde Chrome'da varsayılan olarak kullanılabilir. Protected Audience API'yi etkinleştirmek için komut satırı işaretleriyle Chrome'u çalıştırıyorsanız BiddingAndScoringDebugReportingAPI işaretini ekleyerek yöntemleri açıkça etkinleştirmeniz gerekir. İşaret etkinleştirilmemişse yöntemler kullanılabilir ancak hiçbir işlem yapmaz.

Tüm Protected Audience API API referansları

API referans kılavuzları mevcuttur:

Protected Audience API açıklayıcısı da özellik desteği ve kısıtlamalar hakkında ayrıntılı bilgi sağlar.

Sonraki adım

Herkesin yararlanabileceği bir API geliştirdiğimizden emin olmak için sizinle görüşmeler yapmak istiyoruz.

API'yi tartışın

Diğer Özel Korumalı Alan API'lerinde olduğu gibi bu API de belgelenmiş ve herkese açık olarak tartışılmıştır.

API ile deneme yapma

Protected Audience API hakkında denemeler yapabilir ve görüşmelere katılabilirsiniz.