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 yinelemesinde kullanılan Protected Audience API açık artırma kazanımları için raporlar 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) ile ilgili ayrıntılı bir açıklama için Protected Audience API açıklayıcısına bakın.

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

Protected Audience API raporu nedir?

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

  • Satıcı raporu: Reklam açık artırmasının kazananı satıcıyı bilgilendirir.
  • Alıcı raporu: Yalnızca kazanan alıcılar tarafından, açık artırmayı kazandığı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ı bildirmesine izin vermektir. Satıcı için reportResult() ve kazanan teklif veren için reportWin() uygulayan kod, etkinlik düzeyinde geçici bir raporlama mekanizması olarak sendReportTo() işlevini çağırabilir. Bu işlem tek bir bağımsız değişkeni alır: Açık artırma tamamlandıktan sonra getirilen ve raporlanacak etkinlik düzeyindeki bilgileri kodlayan URL'yi temsil eden bir 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 bildirmek 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() işlevine aktarıldı.

browserSignals

Açık artırma hakkında bilgi sağlayan, tarayıcı tarafından oluşturulan 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() özelliğini de sağladı), açık artırma sonucunu bildirmek için 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() adlı reklam kaynağına aynı değerler iletildi.

sellerSignals

Satıcıya, alıcıya bilgi iletme fırsatı sunan reportResult() dönüş değeri.

browserSignals

Açık artırma hakkında bilgi sağlayan, tarayıcı tarafından oluşturulan 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ılabilen iki yöntem vardır:

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

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

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

Bu yöntemler, chrome://settings/adPrivacy altındaki 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 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ştirilmezse yöntemler kullanılabilir durumda kalır ancak hiçbir şey yapılmaz.

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.