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

Protected Audience API açık artırma raporları oluşturmak için satıcı ve alıcı rehberi.

Bu makale, deneysel Protected Audience API'nin mevcut iterasyonunda kullanılan Protected Audience API açık artırma kazançlarını kapsayan raporların oluşturulmasıyla ilgili teknik referans niteliğindedir.

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 için Protected Audience API açıklayıcısına bakın.

Geliştirici değil misiniz? Protected Audience API'ye genel bakış sayfasını inceleyin.

Protected Audience API neyi raporlar?

İki kullanılabilir Protected Audience API raporu vardır:

  • Satıcı raporu: Satıcıyı, reklam açık artırmasının kazananı hakkında bilgilendirir.
  • Alıcı raporu: Yalnızca kazanan alıcılar tarafından, açık artırmayı kazandıklarını öğrenmek için kullanılabilir.

Uzun vadeli plan, tarayıcının Private Aggregation API API'lerini kullanarak satıcı ve alıcılar için açık artırma sonuçlarını raporlamasına izin vermektir. Etkinlik düzeyinde geçici bir raporlama mekanizması olarak satıcı için reportResult() ve kazanan teklif veren için reportWin() uygulayan kod, sendReportTo() işlevini çağırabilir. Bu işlem için tek bir bağımsız değişken gerekir: 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()

Satıcının decisionLogicUrl içinde sağlanan JavaScript'i (aynı zamanda scoreAd() sağlar), açık artırma sonucunu raporlamak için bir reportResult() işlevi içerebilir.

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

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

auctionConfig

Açık artırma yapılandırma nesnesi navigator.runAdAuction() öğesine aktarıldı.

browserSignals

Tarayıcı tarafından oluşturulan ve açık artırmayla ilgili 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ürülen değeri, kazanan teklif verenin reportWin() işlevi için sellerSignals bağımsız değişkeni olarak kullanılır.

Alıcı: reportWin()

Kazanan teklif verenin JavaScript'i (generateBid() tarafından da sağlanır), açık artırma sonucunu raporlamak 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() öğesine aynı değerler iletildi.

sellerSignals

Satıcıya, alıcıya bilgi iletme fırsatı veren reportResult() iade değeri.

browserSignals

Tarayıcı tarafından oluşturulan ve açık artırmayla ilgili 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 açık artırma raporlaması için geçici olarak kullanılabilecek iki yöntem 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. Bunlar hem scoreAd() hem de generateBid() içinde farklı URL bağımsız değişkenleriyle birden çok kez çağrılabilir.

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

chrome://flags/#privacy-sandbox-ads-apis etkinse bu yöntemler Chrome'da varsayılan olarak kullanılabilir. Ancak, Protected Audience API'yi etkinleştirmek için Chrome'u komut satırı işaretleriyle çalıştırıyorsanız BiddingAndScoringDebugReportingAPI işaretini ekleyerek bu yöntemleri açıkça etkinleştirmeniz gerekir. İşaret etkinleştirilmemişse yöntemler yine kullanılabilir ancak hiçbir şey yapmaz.

Tüm Protected Audience 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.