Protected Audience API açık artırma raporları

Protected Audience API açık artırma verilerini ve sonuçlarını ölçme

Bu makalede, Protected Audience API açık artırma verilerini sunucunuza bildirmek için kullanabileceğiniz çeşitli mekanizmalar ve alternatif çözümler hazır olana kadar taşıma işlemi sırasında şu anda kullanabileceğiniz geçiş mekanizmaları hakkında genel bilgiler bulabilirsiniz.

Protected Audience API, reklam açık artırmasından topladığınız önemli metrikleri raporlamak için şu araçlarla çalışır:

  • Özet raporları oluşturmak için açık artırma sinyallerini ve sonuçlarını toplayan Özel Toplama.
  • Ads Reporting API, çitlenmiş çerçeveler ve iFrame'ler için kullanılır. Bu API, Protected Audience API iş uygulamalarıyla iletişim kurmak üzere çerçevelerin içinde yer alan bir kanaldır. API, etkinlik düzeyindeki verilerin açık artırma sinyalleriyle ilişkilendirilmesine olanak tanır. Ads Reporting API'nin etkinlik düzeyinde raporlama özelliği, daha gizli bir raporlama mekanizması tasarlanana kadar bir geçiş mekanizmasıdır.
  • Dönüşüm verilerini açık artırma sinyalleriyle ilişkilendirmenize olanak tanıyan İlişkilendirme Raporları.
  • Kaynaklar arası depolama alanına açık artırma sinyalleri yazmanıza ve daha sonra Özel Toplama'yı kullanarak bu verileri raporlamanıza olanak tanıyan Paylaşılan Depolama.

Protected Audience API raporlarına genel bakış

Protected Audience genel iş akışı
Protected Audience genel iş akışı

Protected Audience API açık artırma akışındaki verilerin sunucunuza bildirilebileceği üç temel dönem vardır: açık artırmanın yayıncı sitesinden yürütüleceği açık artırma zamanı, reklamın yayıncı sitesinde sınırlı bir çerçeve veya iframe olarak oluşturulduğunda oluşturma süresi ve kullanıcının başka bir sitede açık artırmayla ilişkilendirilebilecek bir işlem gerçekleştirdiği dönüşüm süresi.

Açık artırma sırasında, raporlama iş akışlarını kullanarak açık artırma verilerini raporlayabilirsiniz. Oluşturma süresi boyunca, etkileşim verilerini bir iframe'den veya sınırlanmış bir çerçeveden bildirebilirsiniz. Dönüşüm sırasında, Attribution Reporting API'yi kullanarak hedef sayfadaki ilişkilendirme verilerini raporlayabilirsiniz.

Konum bildirme

Bir açık artırmada, alıcılar generateBid() ve reportWin() iş akışlarında bulunan sinyalleri, satıcılar ise scoreAd() ve reportResult() içinde bulunan sinyalleri raporlayabilir. Alıcılar ve satıcılar, açık artırmanın dışında, reklamı oluşturan çerçeveden ve dönüşümün gerçekleştiği siteden alınan verileri raporlayabilir.

Dönem Hedef Konum Veriler kullanılabilir Reporting API'ler kullanıma sunuldu
Açık artırma Alım sorumlusu generateBid() Sinyaller, açık artırma sonuçları ve açık artırma performansı Gizli Toplama API'sı
reportWin() Private Aggregation API
Ads Reporting API
Satıcı scoreAd() Gizli Toplama API'sı
reportResult() Private Aggregation API
Ads Reporting API
Oluştur Alıcı / Satıcı Yayıncı sitesindeki çerçeve Reklam çerçevesi içindeki etkinlik düzeyinde veriler Private Aggregation API
Ads Reporting API
Dönüşüm Alıcı / Satıcı Dönüşüm sitesi Dönüşüm sitesinden alınan dönüşüm ve etkinlik düzeyi verileri Attribution Reporting API
Private Aggregation API
Ads Reporting API

Listelenen dönemlerin her birinde alıcılar ve satıcılar; açık artırma sinyalleri, etkinlik düzeyindeki veriler ve dönüşüm verileri gibi verileri raporlamak için kullanılabilen çeşitli raporlama API'lerine erişebilir.

Protected Audience API açık artırmasında kullanılabilen veriler

Aşağıdaki veriler, açık artırma sırasında Protected Audience API iş uygulamasından raporlanabilir.

Sinyaller

Sinyaller teklif oluşturmak, reklam puanlamak ve açık artırmanın sonuçlarını raporlamak için bir iş akışı içinde alıcı ve satıcılara sunulan açık artırma bağlam verileri, kullanıcı verileri, gerçek zamanlı veriler ve tarayıcı verileridir.

Sinyal Açıklama Konumu ayarla Kullanıcı sayısı Kullanılabilirlik
auctionSignals Açık artırmanın yapıldığı bağlamda kullanılabilen veriler. Bu veriler arasında sayfa içeriği bilgileri, birinci taraf kullanıcı verileri ve daha fazlası olabilir. Açık artırma yapılandırmasında yayıncı sitesinden satıcı tarafından ayarlanır. Alıcı
Satıcı
oluşturTeklif puanıReklam raporuKazan raporuSonuç
directFromSellerSignals auctionSignals, perBuyerSignals, sellerSignals için aynı veriler, ancak sinyallerin belirtilen satıcıdan gelmesi garanti edilir. Satıcıdan gelen HTTP yanıt başlıkları aracılığıyla ayarlanır Alıcı
Satıcı
oluşturTeklif puanıReklam raporuKazan raporuSonuç
browserSignals Tarayıcı tarafından sağlanan çeşitli veriler (topWindowHostname, interestGroupOwner, renderUrl, adComponents, biddingDurationMsec, IGJoinCount, IGRecency, modelingSignals). Tarayıcı tarafından ayarlanır. Alıcı
Satıcı
oluşturTeklif puanıReklam raporuKazan raporuSonuç
sellerSignals Reklam puanlaması için satıcıya sağlanan sinyaller. Açık artırma yapılandırmasında yayıncı sitesinden satıcı tarafından ayarlanır. Satıcı puanReklam
raporWin
raporSonuç
trustedScoringSignals Reklam puanlaması için satıcıya sağlanan gerçek zamanlı sinyaller. URL, açık artırma yapılandırmasında yayıncı sitesinden satıcı tarafından ayarlanır. Satıcı puanReklam raporuSonuç
perBuyerSignals Belirli alıcılara sağlanan açık artırma içeriğe dayalı verileri. Satıcı, açık artırma başlamadan önce alıcıların değerlerini alabilir. Bu, alıcının reklam fırsatı hakkındaki bilgisidir. Açık artırma yapılandırmasında yayıncı sitesinden satıcı tarafından ayarlanır. Alım sorumlusu oluşturTeklif puanıReklam raporuKazan raporuSonuç
trustedBiddingSignals Reklam teklifleri için alıcılara sağlanan gerçek zamanlı sinyaller. URL, ilgi alanı grubu ayarlandığında reklamveren sitesindeki alıcı tarafından belirlenir. Alım sorumlusu generateBid
userBiddingSignals Alıcı tarafından sağlanan kullanıcı verileri. İlgi alanı grubu ayarlandığında reklamveren sitesinden alıcı tarafından ayarlanır . Alım sorumlusu generateBid

auction config nesnesi, iş akışlarında sinyal olarak kullanılabilir olması için sağlanan verilerin birincil kaynağıdır. Yayıncı ve satıcı, açık artırma yapılandırmasında içeriğe dayalı veriler ve birinci taraf verileri sağlayabilir. Bu sinyaller; alıcıdan gelen ilgi alanı grubu verileri, reklam oluşturma çerçevesinden alınan etkinlik düzeyindeki veriler ve tıklama sayfasındaki ilişkilendirme verileriyle zenginleştirilebilir. Bildirilen veriler; alıcı/satıcı raporlaması, faturalandırma, bütçe oluşturma, makine öğrenimi modeli eğitimi ve daha birçok işlem için kullanılabilir.

Kullanılabilen diğer veriler

  • Kazanan teklif fiyatı ve teklifin reddedilme nedeni gibi açık artırma kazanma ve kaybetme verileriyle ilgili sonuç verileri.
  • Teklif iş akışını getirmenin ve yürütmenin ne kadar sürdüğü gibi gecikme bilgilerini içeren performans verileri.

Protected Audience API açık artırmasının dışında kullanılabilen veriler

Protected Audience API açık artırmasının dışında, verilerin raporlanabileceği iki dönem vardır.

Oluşturma süresi boyunca, reklam yayıncı sitesinde oluşturulduğunda iframe'in veya sınırlanmış çerçevenin içindeki etkinlik düzeyindeki veriler Protected Audience API açık artırma verileriyle ilişkilendirilebilir ve sunucunuza raporlanabilir. Etkinlik düzeyindeki örnek veriler, reklam gösterimi, tıklama, fareyle üzerine gelme ve çerçeve içinde gerçekleşen diğer etkinlikleri içerir.

Dönüşüm sırasında bir kullanıcı, açık artırmayla ilişkilendirilen tıklama sayfasında bir işlem gerçekleştirdiğinde, dönüşüm sayfasındaki etkinlik düzeyindeki veriler Protected Audience API açık artırma verileriyle ilişkilendirilebilir ve sunucunuza raporlanabilir.

Etkinlik düzeyinde raporlama

Etkinlik düzeyinde raporlarda, bir veya daha fazla etkinlikle ilgili ayrıntılı bilgiler verilir. Etkinlik; açık artırma kazancı, reklam gösterimi veya dönüşüm olabilir. En az 2026'ya kadar, etkinlik düzeyinde açık artırma kazanan raporları kullanılmaya devam edecek, Protected Audience reklamı oluşturmak için sınırlanmış çerçeveler gerekmeyecek ve kısıtlanmamış ağ erişimine sahip bir iframe etkinlik düzeyinde raporlama için kullanılabilir. Ayrıca Ads Reporting API, açık artırma ve dönüşüm verilerini bu çerçevedeki etkinlik düzeyinde verilerle ilişkilendirmeniz için sınırlanmış çerçeveler ve iframe'ler halinde mevcuttur. Bu özellik, sisteminizi Protected Audience'a taşırken mevcut raporlama altyapınızı en az 2026'ya kadar kullanmaya devam edebileceğiniz için ekosistemin geçiş sürecini daha kolay hale getirmek için tasarlanmıştır.

sendReportTo() ile etkinlik düzeyinde açık artırma kazanma raporları

Korunan Kitle açık artırmasında etkinlik düzeyindeki verileri raporlamak için kullanılabilen mekanizma, açık artırma kazancındaki sendReportTo() function'dir. İşlev, alıcı ve satıcı raporlama iş akışlarında kullanılabilir ve tarayıcı, reklam oluşturma başladığında sağlanan URL dizesine bir GET isteğinde bulunur. İş uygulamalarınızda bulunan herhangi bir sinyali URL'nin sorgu parametreleri olarak kodlayabilirsiniz.

Örneğin, alıcı kazanan teklif tutarını faturalandırma amacıyla reportWin() iş akışından bildirebilir:

// Buyer reporting worklet
function reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals, directFromSellerSignals) {
  sendReportTo(`https://buyer-reporting-server.example/reporting?bid=${browserSignals.bid}`);
}

sendReportTo() işlevi, reportResult() içinden çağrıldığında satıcı için bir kazanma raporu ve reportWin() üzerinden çağrıldığında alıcı için bir kazanma raporu oluşturmak üzere kullanılabilir. sendReportTo() işlevi en azından 2026'ya kadar kullanılabilir.

Etkileşim raporu

Etkileşim raporu, reklam öğesinden alınan ve reklamı oluşturan Protected Audience API açık artırmasının sinyalleriyle ilişkili gösterim veya tıklama verileri gibi etkinlik düzeyindeki verileri içerir. Açık artırma sona erdikten sonra reklam oluşturulduğundan, reklamı oluşturan çerçeve içinde açık artırma sinyalleri bulunmaz. Bu verileri farklı dönemlere ait veriler ile ilişkilendirmek için etkileşim raporları oluşturabileceğiniz iki geçiş mekanizması sağlıyoruz.

Yukarıda açıklanan sendReportTo() işlevi, açık artırma verilerini bir iframe'den alınan etkinlik düzeyindeki verilerle ilişkilendirmek için kullanılabilir. Ancak, yerleştiren ile sınırlanmış çerçeve arasındaki iletişim sınırlı olduğundan benzersiz bir kimlik yerleştiriciden aktarılamayacağından sınırlı bir çerçevede çalışmaz. Açık artırma verilerini, sınırlı çerçeveli bir reklamdan alınan etkinlik düzeyindeki verilerle ilişkilendirmek için Ads Reporting API kullanılabilir.

Kısıtlanmış çerçeveler ve iframe'ler için Ads Reporting API

Sınırlandırılmış çerçeveler ve iframe'ler için Ads Reporting API, bir reklam çerçevesinden kullanıcı etkinliği düzeyindeki verileri Protected Audience açık artırmasındaki sinyallerle ilişkilendirmenizi sağlayan bir mekanizma sağlar.

Protected Audience API raporlama iş akışında, registerAdBeacon() işleviyle bir reklam işaretçisi kaydedebilir ve sorgu parametreleri olarak eklenen sinyallerle raporlama URL'nizi aktarabilirsiniz. Ayrıca, raporlama URL'si ile ilişkilendirmek istediğiniz özel etkinliği de belirtirsiniz. Daha sonra reklam sınırlı bir çerçeve içinde oluşturulduğunda window.fence.reportEvent() işlevini çağırarak özel etkinliği tetikleyebilirsiniz. Sınırla çevrili çerçeve içinde bulunan veriler yük olarak eklenebilir.

registerAdBeacon() işlevi yalnızca raporlama işlevlerinde kullanılabilir; alıcının teklif verme ve satıcının puanlama mantığında kullanılamaz.

Aşağıdaki örnekte kampanya kimliği, tıklama koordinatlarıyla etkinlik düzeyindeki bir yük ile ilişkilendirilir:

// Protected Audience API buyer win reporting worklet
function reportWin(auctionSignals) {
  const { campaignId } = auctionSignals

  registerAdBeacon({
    click: `https://buyer-server.example/report/click?campaignId=${campaignId}`
  })
}
// Protected Audience API seller reporting worklet
function reportResult(auctionConfig) {
  const { campaignId } = auctionConfig.auctionSignals;

  registerAdBeacon({
    click: `https://seller-server.example/report/click?campaignId=${campaignId}`
  })
}
// Ad frame
window.fence.reportEvent({
  eventType: 'click',
  eventData: JSON.stringify({'clickX': '123', 'clickY': '456'}),
  destination:['buyer', 'seller']
});

Ayrıca, kazanç raporlamasıyla aynı nedenlerle 2026'ya kadar Fenced Frames Ads Reporting API'yi de kullanabilirsiniz.

Daha ayrıntılı bilgi için açıklamaya bakın.

Sınırlandırılmamış ağ erişimi

Kısıtlanmış çerçeveler, ağ kaynaklarının iframe'le aynı şekilde yüklenmesine olanak tanır. Siz de içeriğinize sınırlanmış çerçeveler içindeki etkinlik düzeyinde verileri gönderebilirsiniz. Daha sonra, sınırlanmış bir çerçeveden alınan etkinlik düzeyindeki verileri, yukarıdaki açık artırma etkinlik düzeyindeki raporlama mekanizması bölümünde açıklanan, sendReportTo() ile gönderilen açık artırma verileriyle ilişkilendirerek sunucu tarafında etkinlik düzeyinde raporlar oluşturabilirsiniz.

Ağ erişimi, üçüncü taraf çerezleri için destek sonlandırıldıktan bir süre sonra kısıtlanacaktır.

Şu anda Protected Audience API'de bulunan etkinlik düzeyinde raporlama mekanizmaları geçiş mekanizmalarıdır ve mevcut kullanım alanlarını daha iyi desteklemek için alternatif bir çözüm tasarlanacaktır.

İlişkilendirme raporu

İlişkilendirme raporu, bir web sitesindeki dönüşümü Protected Audience API açık artırmasından seçilen bir reklamla ilişkilendirmenize olanak tanır. Örneğin, bir kullanıcı sunduğunuz bir ürün reklamını tıklayabilir, reklamverenin sitesine yönlendirilebilir, oradan alışveriş yapabilir ve siz de satın alma işlemini gösterilen reklamla ilişkilendirmek isteyebilirsiniz. Attribution Reporting API, yayıncı sitesindeki açık artırma verilerini ve reklamveren sitesindeki dönüşüm verilerini birleştirmek için Protected Audience API ile entegre edilecektir.

Biz daha kalıcı bir çözüm tasarlaysak da İlişkilendirme Raporlama ile etkinlik düzeyinde ve toplanabilir bir rapor oluşturmak üzere geçici bir mekanizma olarak sınırlanmış çerçeveler için Ads Reporting API'yi kullanabilirsiniz. Bu raporların dönüşümü ölçmek için olduğunu, ayrıca açık artırma ve reklam çerçevesinden oluşturulan etkinlik düzeyinde ve toplanabilir etkileşim raporlarından ayrı olduğunu unutmayın. Hazır olduğunda daha kalıcı bir çözüm için açıklayıcı bir açıklama yayınlayacağız.

Geçiş mekanizması

Bir reklam işaretçisini kaydederken reserved.top_navigation anahtar kelimesini kullanabilirsiniz. Bu anahtar kelime, işaretçinin ilişkilendirme kaynağı olarak kaydedilmeye uygun hale gelmesi için otomatik olarak Attribution-Reporting-Eligible üstbilgisini ekler.

registerAdBeacon({
 'reserved.top_navigation': 'https://adtech.example/click?buyer_event_id=123',
});

Kaydettiğiniz işaretçiye etkinlik düzeyinde veri eklemek için etkinlik yüküyle birlikte sınırlı çerçeveden setReportEventDataForAutomaticBeacons() çağırabilirsiniz.

window.fence.setReportEventDataForAutomaticBeacons({
  eventType: 'reserved.top_navigation',
  eventData: 'data from the frame',
  destination:['seller', 'buyer']
})

Daha fazla bilgi edinmek için Ads Reporting API açıklayıcısının İlişkilendirme Raporlama bölümüne bakın.

Etkileşim ve dönüşüm raporlama örneği

Bu örnekte, açık artırma, reklam çerçevesi ve dönüşüm sitesindeki verileri birlikte ilişkilendirmek isteyen alıcı perspektifinden bakacağız.

Bu iş akışında, alıcı, açık artırmaya benzersiz bir kimlik göndermek için satıcıyla koordinasyon kurar. Açık artırma sırasında alıcı, açık artırma verileriyle birlikte bu benzersiz kimliği gönderir. Oluşturma ve dönüştürme süresinde, sınırlanmış çerçeveden veya iframe'den gelen veriler de aynı benzersiz kimlikle gönderilir. Daha sonra, bu raporları birlikte ilişkilendirmek için benzersiz kimlik kullanılabilir.

İş akışı:

  1. Açık artırma başlamadan önce alıcı, programatik gerçek zamanlı teklif verme ("GZT") teklif yanıtının bir parçası olarak satıcıya benzersiz bir kimlik gönderir. Kimlik, auctionId gibi bir değişken olarak ayarlanabilir. Kimlik, auctionConfig içinde perBuyerSignals olarak aktarılır ve alıcının iş akışlarında kullanılabilir hale gelir.
  2. Açık artırma sırasında alıcı, reklam oluşturma süresi ve dönüşüm zamanında (registerAdBeacon()) tetiklenecek bir reklam işaretçisi kaydedebilir.
    1. Bir reklam çerçevesi etkinliği için açık artırma sinyallerini ilişkilendirmek üzere auctionId özelliğini, işaretçi URL'sinin sorgu parametresi olarak ayarlayın.
    2. Bir dönüşüm etkinliğiyle açık artırma sinyallerini ilişkilendirmek için işaretçi URL'de auctionId özelliğini ayarlayın.
  3. Reklam oluşturma süresinde, açık artırma zamanında kaydettiğiniz işaretçiler tetiklenebilir veya etkinlik düzeyindeki verilerle geliştirilebilir.
    1. Kare etkinliğini reportEvent() ile tetikleyin ve etkinlik düzeyindeki verileri iletin.
    2. setReportEventDataForAutomaticBeacons() ile ilişkilendirme işaretçisine etkinlik düzeyinde yük ekleyin
    3. Attribution-Reporting-Register-Source başlığıyla reklam işaretçisi isteklerine yanıt vererek reklamı Attribution Reporting API'ye kaydedin.
  4. Dönüşüm zamanında, açık artırma zamanında kaydettiğiniz kaynağı tetikleyebilirsiniz.

Yukarıdaki işlemden sonra, alıcı, birbirleriyle ilişkilendirmek için kullanılabilecek tek bir benzersiz anahtarla birbirine bağlanmış bir açık artırma raporu, etkileşim raporu ve dönüşüm raporuna sahip olur.

Benzer iş akışı, ilişkilendirme verilerine erişmesi gereken satıcılar için de geçerlidir. Satıcı, registerAdBeacon() ile gönderim yapmak için benzersiz bir kimlik de kullanabilir. Çerçeveden, reportEvent() çağrısı, raporu hem alıcıya hem de satıcıya göndermek için kullanılabilecek bir hedef mülk içerir. Tetikleyicinin kaynakla ilişkilendirilmesi için STP'nin açılış sayfasında da bulunması gerektiğini unutmayın.

Protected Audience verilerini toplama

Private Aggregation API, gruplarda toplanan verilerin toplu ve gürültülü bir raporu olan özet raporu oluşturmak amacıyla Korunan Kitle verilerini bildirmek için kullanılan mekanizmadır. Paket, toplama anahtarıyla temsil edilir ve bazı bilgiler anahtara kodlanabilir.

Örneğin, bir reklam gösterimi etkinliği, her bir grubun farklı bir reklam kampanyasını temsil ettiği farklı gruplarda sayılabilir. Özet rapor, her bir etkinlikle ilgili bilgi vermemesi açısından etkinlik düzeyindeki raporlardan farklıdır. Etkinlik düzeyinde bir raporla, A, B ve C kullanıcılarının 123 numaralı kampanyayı gördüğünü belirleyebilirsiniz. Özet raporları kullanarak 123. kampanyayı gören ve kullanıcı gizliliğini korumak için gürültü eklenen kullanıcıların sayısını ölçebilirsiniz.

API hakkında daha fazla bilgi için Gizli Toplama makalesine bakın.

Açık artırma sinyallerini toplama

Özel Toplama'yı kullanarak iş parçalarında bulunan sinyalleri sunucunuzda toplayabilirsiniz. Sinyal toplama için alıcı teklif verme iş akışında, satıcı puanlama iş akışında ve alıcı/satıcı raporlama iş akışlarında bulunan privateAggregation.contributeToHistogram() yöntemini kullanabilirsiniz.

Bu örnekte, kazanan teklif ilgi alanı grubu sahibi grubunda toplanır:

function convertBuyerToBucket(igOwner) {}
function convertWinningBidToValue(winningBid) {}

function reportResult(auctionConfig, browserSignals) {
  privateAggregation.contributeToHistogram({
    bucket: convertBuyerToBucket(browserSignals.interestGroupOwner),
    value: convertWinningBidToValue(browserSignals.bid)
  });
} 

Bu, toplamak istediğiniz sinyaller etkinlik düzeyindeki verilerle ilişkili olmadığı ve açık artırma dışındaki bir etkinlik tarafından tetiklenmediği durumlarda kullanılan genel mekanizmadır. Açık artırma sinyallerini raporlama hakkında daha fazla bilgi edinmek için açıklamaya bakın.

Açık artırma sinyallerini etkinlik verileriyle toplama

Açık artırma sinyallerini bir reklam çerçevesinde gerçekleşen bir etkinlik hakkında sınırlı bilgiyle toplayabilirsiniz. Örneğin, bir kampanya reklamının aldığı tıklama sayısını, söz konusu kampanyayı ve tıklama etkinliğini temsil eden bir paket oluşturarak toplu olarak ölçebilirsiniz. Reklam çerçevesinden hangi etkinliğin gerçekleştiğini belirtebileceğinizi ancak etkinlik düzeyinde yük ekleyemeyeceğinizi unutmayın.

Açık artırma sinyallerini etkinliklere göre toplamak için, etkinlik tetiklendiğinde raporlanacak katkıyı ve etkinlik türünü belirten bir dize alan privateAggregation.contributeToHistogramOnEvent(eventType, contribution) kullanabilirsiniz. Yöntemi bir özel etkinlik türüyle çağırabilir, ardından gönderilecek raporu tetiklemek için reklam çerçevesinden window.fence.reportEvent(eventType) çağırabilirsiniz.

Bir kampanya reklamının aldığı tıklama sayısını ölçmek istediğinizi varsayalım.

// Protected Audience API worklet
function getClickReportBucketForCampaign(campaignId) {
  // return a bucket for the campaign ID and the click event
}

function generateBid(interestGroup) {
  privateAggregation.contributeToHistogramOnEvent('click', {
    bucket: getClickReportBucketForCampaign(interestGroup.ads.metadata.campaignId), 
    value: 1
  });
}

Teklif oluşturma işlevinde, bir grubu kampanya kimliği ile tıklama etkinliğinin kombinasyonu olarak tanımlayabilir ve ardından etkinlik her tetiklendiğinde bu grubun değerini 1 artırabilirsiniz.

// Ad frame
window.fence.reportEvent('click');

Daha sonra, daha sonra reklam çerçevesinden reportEvent(eventType) çağırarak rapor gönderimini tetikleyebilirsiniz:

Açıklayıcıdan bir kareden Gizli Toplama katkılarını tetikleme hakkında daha fazla bilgi edinin.

Açık artırma sonuçlarını ve performansını raporlama

Ayrıca, ayrılmış etkinlik türündeki bir anahtar kelimeyi (reserved.win, reserved.loss ve reserved.always) geçtiğinizde contributeToHistogramOnEvent(eventType, contribution) ile bir açık artırma kazanma veya kaybetme etkinliği tarafından tetiklendiğinde açık artırma sonuçlarını birleştirebilirsiniz.

Gizli Toplama, katkınızın grubunu ve değerini hesaplayabileceğiniz temel değerlerin listesini sağlar. Açık artırma sonuçları için kullanılabilen taban değerler; kazanan reklamın teklif değeri, en yüksek ikinci olarak puanlanan teklif değeri ve bir teklifin açık artırmada reddedilme nedenidir.

Kazanan teklif tutarı gibi bir taban değer sağlandığında, bu değere ne kadar ekleme veya çıkarma yapacağınızı belirleyebilir ve ardından nihai değeri raporlayabilirsiniz. Örneğin, taban değer olarak 5 TL'lik kazanan teklif sağlanırsa, açık artırmanızı kaybettiğiniz 3 TL'lik gerçek değeri hesaplamak için 2 TL'lik teklifinizi çıkarabilirsiniz.

Açık artırma sonuçlarını raporlama

Bir açık artırmayı kaybettiğiniz ve teklifinizin açık artırma fiyatından ne kadar uzakta olduğunu öğrenmek istediğiniz bir örneği inceleyelim.

Açık artırmayı ne kadar kaybettiğinizi öğrenmek için teklif fiyatınızı kazanan teklif fiyatından çıkarabilirsiniz:

function generateBid() {
  const bid = calculateBidAmount();

  privateAggregation.contributeToHistogramOnEvent('reserved.loss', {
    bucket: getBucketForCampaign(interestGroup.ads.metadata.campaignId),
    value: {
      baseValue: 'winning-bid',
      scale: 1 // Scale the value to minimize noise-to-signal ratio 
      offset: -bid, // Numbers added to browser value after scaling 
    }
  });
}

Rapor gönderildiğinde, bildirilen gerçek değer offset değeri ile kaydırılan baseValue değeri olur. Daha fazla bilgi edinmek için açıklayıcıya bakın.

Performans raporları

Alıcılar ve satıcılar, bir komut dosyasının çalışmasının ne kadar sürdüğünü ve güvenilir sinyalleri getirmenin ne kadar sürdüğünü raporlayabilir. Satıcılar, izin alarak her bir alıcının teklif oluşturma zamanını ve güvenilir teklif sinyal zamanını toplayabilir.

Daha fazla bilgi edinmek için açıklayıcıya bakın.

Açık artırma sinyallerini Paylaşılan Depolama'da depolama

Paylaşılan depolama, serbestçe yazabileceğiniz bölümlendirilmemiş ve kaynaklar arası bir depolama alanıdır. Ancak depolanan değerler okunurken ve işlenirken kapılarla korunur. Shared Storage API için kullanılabilen kapılardan biri Gizli Toplama'dır. Paylaşılan depolama alanındaki değerleri yalnızca bir iş uygulamasının içinden okuyabilir ve bu değerleri, iş akışından Gizli Toplama'yı kullanarak bildirebilirsiniz.

Ayrıca Protected Audience API teklif, puanlama ve raporlama iş akışlarından paylaşılan depolama alanına veri yazabilirsiniz. Daha sonra, Özel Toplama 'yı kullanarak paylaşılan depolama alanındaki bu değerleri sunucunuza raporlayabilirsiniz . Depolanan değerleri URL Seçimi işlemi için de kullanabilirsiniz.

Protected Audience API iş uygulamasından, paylaşılan depolama alanına anahtar ve değer yazabilirsiniz:

// Protected Audience API worklet
function generateBid() {
  sharedStorage.set('test-bucket', 123);
}

Daha sonra, paylaşılan bir depolama iş akışı yükleyerek değeri Özel Toplama ile okuyup gönderebilirsiniz:

// Shared Storage worklet
class SendReachReport{
  async run() {
    const testBucket = await this.sharedStorage.get('test-bucket');

    privateAggregation.contributeToHistogram({
      bucket: testBucket,
      value: 1
    });
  }
}

register('send-report', SendReachReport);

Paylaşılan depolama alanı hakkında daha fazla bilgi edinmek için Protected Audience API raporlama geliştirici kılavuzunun paylaşılan depolama alanı bölümünü, açıklamayı, canlı demoyu ve GitHub'daki demo kodunu inceleyin.

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.