सुरक्षित ऐप्लिकेशन सिग्नल के डेवलपर की गाइड

Protected App Signals API का इस्तेमाल करने के लिए, डेवलपर को इस दस्तावेज़ में एपीआई के सभी एपीआई के बारे में बताया गया है. साथ ही, इसमें टेस्टिंग एनवायरमेंट सेट अप करने का तरीका और कॉन्फ़िगरेशन और स्क्रिप्ट के उदाहरण भी दिए गए हैं.

ध्यान दें: सुरक्षित ऐप्लिकेशन सिग्नल को चलाने के लिए, बिडिंग और नीलामी सर्वर काम करना चाहिए. AWS या Google Cloud पर बिडिंग और नीलामी को डिप्लॉय करने के लिए, यह तरीका अपनाएं.

वर्शन इतिहास

जनवरी 2024

PAS के एमवीपी रिलीज़ के साथ काम करने वाली डेवलपर गाइड की पहली रिलीज़

मार्च 2024

Android API के 05-05-2024 रिलीज़ और सर्वर साइड कॉम्पोनेंट के अप्रैल 2024 रिलीज़ के साथ काम करने के लिए, एपीआई में बदलाव. सबसे अहम बदलाव:

• डिवाइस पर मौजूद एपीआई के लिए ज़रूरी अनुमतियों के बारे में जानकारी जोड़ी गई
• डिवाइस पर सिग्नल के कोटे को मैनेज करने के बारे में जानकारी जोड़ी गई
• generateBid हस्ताक्षर को अपडेट किया गया है. इसमें, कॉन्टेक्स्ट के हिसाब से विज्ञापन दिखाने और डेटा भेजने से जुड़े बदलाव किए गए हैं
• reportWin का अपडेट किया गया दस्तावेज़, जिसमें एक्सग्रेस के लिए सहायता शामिल है
• विज्ञापन वापस पाने के एपीआई के दस्तावेज़ को अपडेट करना. इसमें, BYOS विज्ञापन वापस पाने की सुविधा को हटाना और विज्ञापन वापस पाने के यूडीफ़ को दस्तावेज़ में शामिल करना

एपीआई के बारे में खास जानकारी

Protected Signals API के प्लैटफ़ॉर्म पर, अलग-अलग सिस्टम पर एपीआई के अलग-अलग सबसेट शामिल होते हैं:

• Android API:
  • सिग्नल क्यूरेशन एपीआई, जिसमें ये शामिल हैं:
  • Update Signals API
  • Signals Encoding API
  • Protected Auction Support API: इसका इस्तेमाल, SDK टूल के ज़रिए बिडिंग और नीलामी (बी&ए) सर्वर पर, सुरक्षित ऐप्लिकेशन सिग्नल का इस्तेमाल करके सुरक्षित नीलामी चलाने के लिए किया जाता है.
• सर्वर-साइड एपीआई:
  • Protected Auction API: बिडिंग और बिडिंग सर्वर में चलने वाली JS स्क्रिप्ट की सीरीज़. इस एपीआई की मदद से, सेलर और खरीदार, सुरक्षित नीलामी को लागू करने के लिए लॉजिक लिख सकते हैं.
  • विज्ञापन वापस पाने वाला एपीआई: यह विज्ञापनों की सूची उपलब्ध कराता है. यह सूची, खरीदार के बिडिंग सर्वर को उपलब्ध कराई गई कॉन्टेक्स्ट और उपयोगकर्ता की जानकारी के आधार पर बनाई जाती है.

Android क्लाइंट

क्लाइंट साइड पर, Protected App Signals के प्लैटफ़ॉर्म में तीन अलग-अलग एपीआई होते हैं:

• अपडेट सिग्नल: यह Android सिस्टम एपीआई है, जिससे डिवाइस पर सिग्नल को क्यूरेट करने की सुविधा चालू की जा सकती है.
• सिग्नल को कोड में बदलना: यह एक JavaScript API है, जो नीलामी के दौरान, सर्वर को भेजे जाने वाले सिग्नल तैयार करता है.
• सुरक्षित नीलामी की सहायता: बिडिंग और नीलामी सर्वर पर, सुरक्षित नीलामी को लागू करने में मदद करने वाला एपीआई. यह एपीआई, सिर्फ़ Protected App Signals के लिए नहीं है. इसका इस्तेमाल, Protected Audience API के लिए नीलामियों में भी किया जाता है.

ध्यान दें: हमारा सुझाव है कि डेवलपर प्रीव्यू में, सुरक्षित ऐप्लिकेशन सिग्नल की जांच करते समय, किसी एमुलेटर का इस्तेमाल करें. ऐसा इसलिए, क्योंकि कई मामलों में सेटअप से जुड़ी समस्या को हल करने का सबसे अच्छा तरीका, डिवाइस को मिटाना होता है.

Update Signals API

Update Signals API, विज्ञापन टेक्नोलॉजी को खरीदार की ओर से उपयोगकर्ता और ऐप्लिकेशन से जुड़े सिग्नल रजिस्टर करने की सुविधा देता है. यह एपीआई, डेटा का ऐक्सेस देने वाले मॉडल पर काम करता है. कॉलर एक यूआरआई उपलब्ध कराता है. इससे फ़्रेमवर्क, उनसे जुड़े सिग्नल और लॉजिक फ़ेच करता है, ताकि नीलामी में इस्तेमाल किए जाने वाले सिग्नल को एन्कोड किया जा सके.

एपीआई को android.permission.ACCESS_ADSERVICES_PROTECTED_SIGNALS की अनुमति चाहिए.

updateSignals() API, यूआरआई से एक JSON ऑब्जेक्ट प्राप्त करेगा. इसमें यह जानकारी होती है कि कौनसे सिग्नल जोड़ने या हटाने हैं और नीलामी के लिए उन सिग्नल को कैसे तैयार करना है.

Executor executor = Executors.newCachedThreadPool();
ProtectedSignalsManager protectedSignalsManager
     =  ProtectedSignalsManager.get(context);

// Initialize a UpdateSignalsRequest
UpdateSignalsRequest updateSignalsRequest = new
  UpdateSignalsRequest.Builder(Uri.parse("https://example-adtech1.com/signals"))
      .build();

OutcomeReceiver<Object, Exception> outcomeReceiver = new OutcomeReceiver<Object, Exception>() {
  @Override
  public void onResult(Object o) {
    //Post-success actions
  }

  @Override
  public void onError(Exception error) {
    //Post-failure actions
  };

// Call updateSignals
protectedSignalsManager.updateSignals(updateSignalsRequest,
    executor,
    outcomeReceiver);

सिग्नल के अपडेट पाने के लिए, प्लैटफ़ॉर्म अनुरोध में दिए गए यूआरआई पर https अनुरोध करता है. सिग्नल के अपडेट के साथ-साथ, रिस्पॉन्स में एक एंडपॉइंट शामिल हो सकता है. यह एंडपॉइंट, रॉ सिग्नल को एन्क्रिप्ट किए गए पेलोड में बदलने के लिए, एन्क्रिप्शन लॉजिक को होस्ट करता है. सिग्नल अपडेट, JSON फ़ॉर्मैट में होने चाहिए. साथ ही, इनमें ये कुंजियां हो सकती हैं:

JSON ऑब्जेक्ट के टॉप लेवल की कुंजियां, इन पांच में से किसी एक निर्देश से मेल खानी चाहिए:

key	जानकारी
put	एक ही कुंजी वाले किसी भी मौजूदा सिग्नल को ओवरराइट करके, नया सिग्नल जोड़ता है. वैल्यू for एक JSON ऑब्जेक्ट है, जिसमें की, डाली जाने वाली की से जुड़ी बेस 64 स्ट्रिंग होती हैं और वैल्यू, डाली जाने वाली वैल्यू से जुड़ी बेस 64 स्ट्रिंग होती हैं.
append	सिग्नल की टाइम सीरीज़ में नया सिग्नल/सिग्नल जोड़ता है और सबसे पुराने सिग्नल को हटा देता है सिग्नल भेजता है, ताकि नई सीरीज़ के लिए जगह बनाई जा सके. इसकी वैल्यू एक JSON ऑब्जेक्ट है, जिसमें की, जोड़ने के लिए की से जुड़ी बेस 64 स्ट्रिंग होती हैं. साथ ही, वैल्यू दो फ़ील्ड वाले ऑब्जेक्ट होती हैं: "values" और "maxSignals". "values": टाइम सीरीज़ में जोड़ने के लिए, सिग्नल वैल्यू से जुड़ी Base64 स्ट्रिंग की सूची. "maxSignals": इस टाइम सीरीज़ में ज़्यादा से ज़्यादा कितनी वैल्यू हो सकती हैं. अगर अगर पासकोड से जुड़े सिग्नल की मौजूदा संख्या, ज़्यादा से ज़्यादा सिग्नल की संख्या से ज़्यादा हो जाती है, तो सबसे पुराने सिग्नल हटा दिए जाएंगे. ध्यान दें कि put फ़ंक्शन से जोड़ी गई किसी कुंजी में, वैल्यू जोड़ी जा सकती है. ध्यान दें कि तय सीमा से ज़्यादा वैल्यू जोड़ने पर, अपेंडिशन पूरा नहीं होगा.
put_if_not_present	नया सिग्नल सिर्फ़ तब जोड़ा जाता है, जब उसी कुंजी वाले कोई मौजूदा सिग्नल न हो. इसकी वैल्यू, एक JSON ऑब्जेक्ट होती है. इसमें की, डाली जाने वाली की से जुड़ी बेस 64 स्ट्रिंग होती हैं और वैल्यू, डाली जाने वाली वैल्यू से जुड़ी बेस 64 स्ट्रिंग होती हैं.
remove	किसी बटन के लिए सिग्नल हटाता है. इसकी वैल्यू, सिग्नल की उन कुंजियों से जुड़ी base64 स्ट्रिंग की सूची होती है जिन्हें मिटाना है.
update_encoder	एंडपॉइंट को अपडेट करने के लिए कार्रवाई और इस्तेमाल किया जा सकने वाला यूआरएल उपलब्ध कराता है कोड को एन्कोड करने का लॉजिक वापस पाने के लिए. अपडेट करने की कार्रवाई देने के लिए सब-की "action" है और फ़िलहाल, इस एट्रिब्यूट की वैल्यू के तौर पर सिर्फ़ "REGISTER" का इस्तेमाल किया जा सकता है. पहली बार वैल्यू सबमिट करने पर, एन्कोडर एंडपॉइंट रजिस्टर हो जाएगा. इसके अलावा, अगर पहले से कोई एंडपॉइंट मौजूद है, तो उसे नए एंडपॉइंट से बदल दिया जाएगा. "REGISTER" कार्रवाई के लिए, एंडपॉइंट देना ज़रूरी है.एन्कोडर एंडपॉइंट देने के लिए सब-की "एंडपॉइंट" है और वैल्यू यूआरआई है एंडपॉइंट के लिए स्ट्रिंग.

JSON अनुरोध का सैंपल इस तरह दिखेगा:

{
    "put": {
        "AAAAAQ==": "AAAAZQ==",
        "AAAAAg==": "AAAAZg=="
    },
    "append": {
        "AAAAAw==": {
            "values": [
                "AAAAZw=="
            ],
            "max_signals": 3
        }
    },
    "put_if_not_present": {
        "AAAABA==": "AAAAaQ==",
        "AAAABQ==": "AAAAag=="
    },
    "update_encoder": {
        "action": "REGISTER",
        "endpoint": "https://adtech1.com/Protected App Signals_encode_script.js"
    }
}

डिवाइस पर सिग्नल का कोटा 10 से 15 केबी होगा. कोटा से ज़्यादा सिग्नल होने पर, PPAPI, फ़र्स्ट इन फ़र्स्ट आउट (एफ़आईएफ़ओ) रणनीति का इस्तेमाल करके सिग्नल हटा देगा. खाते से उपयोगकर्ताओं को हटाने की प्रोसेस के दौरान, तय किए गए कोटे से थोड़ा ज़्यादा उपयोगकर्ताओं को हटाया जा सकता है. इससे, खाते से उपयोगकर्ताओं को हटाने की फ़्रीक्वेंसी कम हो जाएगी.

Signals Encoding API

खरीदारों को एक Java Script फ़ंक्शन देना होगा. इसका इस्तेमाल, डिवाइस पर सेव किए गए सिग्नल को एन्क्रिप्ट (सुरक्षित) करने के लिए किया जाएगा, ताकि सुरक्षित नीलामी के दौरान उन्हें सर्वर पर भेजा जा सके. खरीदार, इस स्क्रिप्ट को वह यूआरएल जोड़कर उपलब्ध करा सकते हैं जहां इसे फ़ेच किया जा सकता है. इसके लिए, UpdateSignal API के अनुरोध के किसी भी जवाब में "update_encoder" कुंजी का इस्तेमाल करें. स्क्रिप्ट में यह हस्ताक्षर होगा:

function encodeSignals(signals, maxSize) {
  let result = new Uint8Array(maxSize);
  // first entry will contain the total size
  let size = 1;
  let keys = 0;
  
  for (const [key, values] of signals.entries()) {
    keys++;
    // In this encoding we only care about the first byte
    console.log("key " + keys + " is " + key)
    result[size++] = key[0];
    result[size++] = values.length;
    for(const value of values) {
      result[size++] = value.signal_value[0];
    }
  }
  result[0] = keys;
  
  return { 'status': 0, 'results': result.subarray(0, size)};
}

signals पैरामीटर, Protected App Signals ऑब्जेक्ट की सूचियों से, चार साइज़ के UInt8Arrays के तौर पर मौजूद कुंजियों का मैप होता है. Protected App Signals के हर ऑब्जेक्ट में तीन फ़ील्ड होते हैं:

• signal_value: सिग्नल की वैल्यू दिखाने वाला UInt8Array.
• creation_time: यह एक संख्या है, जो सिग्नल बनाने का समय, युग के हिसाब से सेकंड में दिखाती है.
• package_name: सिग्नल बनाने वाले पैकेज का नाम दिखाने वाली स्ट्रिंग.

maxSize पैरामीटर एक संख्या है, जो आउटपुट के लिए, अरे के सबसे बड़े साइज़ के बारे में बताती है.

फ़ंक्शन को दो फ़ील्ड वाला ऑब्जेक्ट दिखाना चाहिए:

• status: अगर स्क्रिप्ट सही से चली है, तो यह वैल्यू 0 होनी चाहिए.
• results: यह UInt8Array होना चाहिए, जिसकी लंबाई, ज़्यादा से ज़्यादा साइज़ से कम या उसके बराबर होनी चाहिए. यह कलेक्शन, नीलामियों के दौरान सर्वर पर भेजा जाएगा. इसे prepareDataForAdRetrieval स्क्रिप्ट से तैयार किया जाता है.

एन्कोडिंग की मदद से, विज्ञापन टेक्नोलॉजी को फ़ीचर इंजीनियरिंग के शुरुआती चरण का ऐक्सेस मिलता है. यहां वे अपने कस्टम लॉजिक के आधार पर, रॉ सिग्नल को एक साथ जोड़े गए वर्शन में कंप्रेस करने जैसे बदलाव कर सकते हैं. ध्यान दें कि ट्रस्टेड एक्ज़ीक्यूशन एनवायरमेंट (टीईई) में चल रही सुरक्षित नीलामी के दौरान, विज्ञापन टेक्नोलॉजी के कस्टम लॉजिक के पास, एन्क्रिप्शन से जनरेट किए गए सिग्नल पेलोड को पढ़ने का ऐक्सेस होगा. खरीदार के B&A टीईई में चल रहे कस्टम लॉजिक को उपयोगकर्ता के हिसाब से तय किया गया फ़ंक्शन (यूडीएफ़) कहा जाता है. इसमें, विज्ञापन चुनने (विज्ञापन वापस पाने और बिडिंग) के लिए, पब्लिशर ऐप्लिकेशन से मिले कोड में बदले गए सिग्नल और कॉन्टेक्स्ट के हिसाब से मिले अन्य सिग्नल का रीड ऐक्सेस होगा.

सिग्नल को कोड में बदलना

हर घंटे, जिन खरीदारों ने अपने रजिस्टर किए गए सिग्नल के साथ कोड में बदलने का लॉजिक दिया है उनके सिग्नल को नीलामी के पेलोड में कोड में बदल दिया जाएगा. नीलामी के पेलोड के लिए बाइट कलेक्शन, डिवाइस पर सेव रहता है. साथ ही, इसे एन्क्रिप्ट (सुरक्षित) किया जाता है. इसे सेलर, विज्ञापन चुनने के डेटा के तौर पर इकट्ठा करेंगे, ताकि इसे सुरक्षित नीलामी के हिस्से के तौर पर शामिल किया जा सके. जांच करने के लिए, इस कोड को हर घंटे होने वाली प्रोसेस के अलावा किसी भी समय ट्रिगर किया जा सकता है. इसके लिए, यह कमांड चलाएं:

adb shell cmd jobscheduler run -f com.google.android.adservices.api 29

एन्कोडर लॉजिक का वर्शन

जब विज्ञापन टेक्नोलॉजी के कस्टम एन्कोडर लॉजिक को डाउनलोड करने का अनुरोध किया जाता है, तो विज्ञापन टेक्नोलॉजी एंडपॉइंट, रिस्पॉन्स हेडर में वर्शन नंबर के साथ जवाब दे सकता है. यह वर्शन, डिवाइस पर एन्कोडर लॉजिक के साथ सेव रहता है. जब रॉ सिग्नल कोड में बदले जाते हैं, तो कोड में बदले गए पेलोड को कोड में बदलने के लिए इस्तेमाल किए गए वर्शन के साथ सेव किया जाता है. यह वर्शन, सुरक्षित नीलामी के दौरान B&A सर्वर पर भी भेजा जाता है, ताकि विज्ञापन टेक्नोलॉजी विशेषज्ञ, वर्शन के आधार पर अपनी बिडिंग और कोडिंग लॉजिक को अलाइन कर सकें.

Response header for providing encoder version : X_ENCODER_VERSION

Protected Auction Support API

डिवाइस के हिसाब से, सुरक्षित ऐप्लिकेशन सिग्नल के लिए नीलामी करना, सुरक्षित ऑडियंस के लिए नीलामी करने जैसा ही है.

Bidding and Auction Services

सर्वर साइड एपीआई में ये शामिल हैं:

• Protected Auction API: यह JS फ़ंक्शन या यूडीफ़ की एक सीरीज़ है. बिडिंग और नीलामी के लॉजिक का पता लगाने के लिए, खरीदार और सेलर अपने मालिकाना हक वाले बीए कॉम्पोनेंट पर इसे डिप्लॉय कर सकते हैं.
• विज्ञापन वापस पाने वाला एपीआई: खरीदार, इस एपीआई को लागू करने के लिए, एक REST एंडपॉइंट लागू कर सकते हैं. यह एंडपॉइंट, सुरक्षित ऐप्लिकेशन सिग्नल की नीलामी के लिए, संभावित विज्ञापनों का एक सेट उपलब्ध कराएगा.

Protected Auction API

Protected Auction API में JS API या UDF शामिल होते हैं. इनका इस्तेमाल करके, खरीदार और सेलर अपनी नीलामी और बिडिंग लॉजिक को लागू कर सकते हैं.

विज्ञापन टेक्नोलॉजी के लिए खरीदार के यूडीफ़

prepareDataForAdRetrieval यूडीएफ़

टीईई की विज्ञापन वापस पाने की सेवा से विज्ञापन फ़ेच करने के लिए, सुरक्षित ऐप्लिकेशन सिग्नल का इस्तेमाल करने से पहले, खरीदारों को सुरक्षित ऐप्लिकेशन सिग्नल और सेलर से मिले अन्य डेटा को डिकोड करना होगा. खरीदारों के prepareDataForAdRetrieval यूडीएफ़ आउटपुट को विज्ञापनों को वापस पाने की सेवा को भेजा जाता है, ताकि बिडिंग के लिए सबसे ज़्यादा संभावित विज्ञापनों को वापस पाया जा सके.

// Inputs
// ------
// encodedOnDeviceSignals: A Uint8Array of bytes from the device.
// encodedOnDeviceSignalsVersion: An integer representing the encoded
//   version of the signals.
// sellerAuctionSignals: Information about auction (ad format, size) derived
//                       contextually.
// contextualSignals: Additional contextual signals that could help in
//                    generating bids.
//
// Outputs
// -------
// Returns a JSON structure to be used for retrieval.
// The structure of this object is left to the adtech.
function prepareDataForAdRetrieval(encodedOnDeviceSignals,encodedOnDeviceSignalsVersion,sellerAuctionSignals,contextualSignals) {
   return {};
}

generateBid यूडीएफ़

सबसे अच्छा परफ़ॉर्म करने वाले k विज्ञापनों के नतीजे मिलने के बाद, उन विज्ञापनों को खरीदार के कस्टम बिडिंग लॉजिक, generateBid UDF में भेज दिया जाता है:

// Inputs
// ------
// ads: Data string returned by the ads retrieval service. This can include Protected App Signals
//   ads and related ads metadata.
// sellerAuctionSignals: Information about the auction (ad format, size),
//                       derived contextually
// buyerSignals: Any additional contextual information provided by the buyer
// preprocessedDataForRetrieval: This is the output of this UDF.
function generateBid(ads, sellerAuctionSignals, buyerSignals,
                    preprocessedDataForRetrieval,
                    rawSignals, rawSignalsVersion) {
    return { "ad": <ad Value Object>,
             "bid": <float>,
             "render": <render URL string>,
             'adCost': <optional float ad cost>,
             "egressPayload": <limitedEgressPayload>,
             "temporaryUnlimitedEgressPayload": <temporaryUnlimitedEgressPayload>
    };
}

इस फ़ंक्शन का आउटपुट, विज्ञापन के लिए एक बिड होती है. इसे ProtectedAppSignalsAdWithBidMetadata के बराबर JSON के तौर पर दिखाया जाता है. यह फ़ंक्शन दो ऐरे भी दिखा सकता है. इसके बाद, मॉडल ट्रेनिंग चालू करने के लिए, उन्हें reportWin पर पास किया जाएगा. एग्रीगेट डेटा भेजने और मॉडल ट्रेनिंग के बारे में ज़्यादा जानकारी के लिए, PAS के बारे में जानकारी देने वाले पेज पर मौजूद रिपोर्टिंग सेक्शन देखें

reportWin यूडीएफ़

नीलामी खत्म होने पर, नीलामी सेवा खरीदारों के लिए रिपोर्टिंग यूआरएल जनरेट करेगी और reportWin यूडीएफ़ (यह वही reportWin फ़ंक्शन है जिसका इस्तेमाल सुरक्षित ऑडियंस के लिए किया जाता है) का इस्तेमाल करके बीकन रजिस्टर करेगी. क्लाइंट से विज्ञापन रेंडर होने के बाद, डिवाइस इसे पिंग करेगा. इस तरीके का हस्ताक्षर, सुरक्षित ऑडियंस के वर्शन से काफ़ी हद तक मिलता-जुलता है. हालांकि, इसमें दो अतिरिक्त पैरामीटर egressPayload और temporaryUnlimitedEgressPayload शामिल हैं. इनका इस्तेमाल मॉडल की ट्रेनिंग चालू करने के लिए किया जाता है. साथ ही, इनमें generateBid के नतीजे अपने-आप भर जाते हैं.

// Inputs / Outputs
// ----------------
// See detailed documentation here.
function reportWin(auctionSignals, perBuyerSignals, signalsForWinner,
                   buyerReportingSignals,
                   egressPayload, temporaryUnlimitedEgressPayload) {
  // ...
}

सेलर के AdTech यूडीफ़

scoreAd यूडीएफ़

इस यूडीफ़ का इस्तेमाल, सेलर यह चुनने के लिए करते हैं कि खरीदारों से मिले कौनसे विज्ञापन नीलामी में जीतेंगे.

function scoreAd(adMetadata, bid, auctionConfig,
                 trustedScoringSignals, bid_metadata) {
  // ...
  return {desirability: desirabilityScoreForThisAd,
              allowComponentAuction: true_or_false};
}

reportResult यूडीएफ़

इस यूडीफ़ की मदद से, सेलर को इवेंट-लेवल पर रिपोर्टिंग करने की सुविधा मिलती है. इसमें, विज्ञापन के नतीजों की जानकारी शामिल होती है.

function reportResult(auctionConfig, reporting_metadata) {
  // ...
  registerAdBeacon({"click", clickUrl,"view", viewUrl});
  sendReportTo(reportResultUrl);
  return signalsForWinner;
}

Ad Retrieval API

एमवीपी रिलीज़ में, विज्ञापन वापस पाने की सेवा, खरीदार के मैनेज और होस्ट की जाने वाली सेवा होगी. साथ ही, बिडिंग सेवा इस सेवा से विज्ञापन के संभावित उम्मीदवारों को वापस लाती है. अप्रैल 2024 से, विज्ञापन वापस पाने वाला सर्वर, ट्रस्टेड एक्सीक्यूशन एनवायरमेंट (टीईई) में चलना चाहिए. साथ ही, यह GRPC/proto इंटरफ़ेस दिखाएगा. विज्ञापन टेक्नोलॉजी कंपनियों को यह सर्वर सेट अप करना होगा और B&A स्टैक डिप्लॉयमेंट के हिस्से के तौर पर इसका यूआरएल देना होगा. TEE में चल रही इस सेवा को लागू करने का तरीका, Privacy Sandbox GitHub में उपलब्ध है. बाकी दस्तावेज़ों में, हम यह मान रहे हैं कि डिप्लॉयमेंट में इस्तेमाल किया गया कोड यही है.

अप्रैल 2024 से, B&A वर्शन, कॉन्टेक्स्ट के हिसाब से विज्ञापन दिखाने की सुविधा के साथ काम करेंगे. इस मामले में, बिडिंग सर्वर को नीलामी के कॉन्टेक्स्टल हिस्से के दौरान, RTB सर्वर से भेजे गए विज्ञापन आइडेंटिफ़ायर की सूची मिलेगी. आइडेंटिफ़ायर को टीईई केवी सर्वर पर भेजा जाएगा, ताकि बिडिंग के दौरान इस्तेमाल की जाने वाली विज्ञापन से जुड़ी सभी जानकारी फ़ेच की जा सके. उदाहरण के लिए, टॉप-क्यू चुनने के लिए इस्तेमाल किए जाने वाले विज्ञापन-रेंडर-यूआरएल, मेटाडेटा, और विज्ञापन एम्बेड. इस दूसरे पाथ को डिप्लॉय करने के लिए, किसी खास लॉजिक की ज़रूरत नहीं होती. इसलिए, हम यहां सिर्फ़ टीईई पर आधारित विज्ञापन वापस पाने के इस्तेमाल के उदाहरण को कॉन्फ़िगर करने का तरीका बताएंगे.

getCandidateAds यूडीएफ़

function getCandidateAds(requestMetadata, preparedDataForAdRetrieval,
                      deviceMetadata, contextualSignals, contextualAdIds,) {
    return adsMetadataString;
}

कहां:

• requestMetadata: JSON. यूडीएफ़ के लिए, हर अनुरोध के हिसाब से सर्वर का मेटाडेटा. फ़िलहाल खाली है.
• preparedDataForAdRetrieval: इस फ़ील्ड का कॉन्टेंट, विज्ञापन वापस पाने की रणनीति पर निर्भर करता है. संदर्भ के हिसाब से विज्ञापन दिखाने की सुविधा के मामले में , इस पैरामीटर में डिवाइस से आने वाले रॉ सिग्नल शामिल होंगे. साथ ही, ये सिग्नल बिडिंग सेवा से पास किए जाएंगे. विज्ञापन वापस पाने वाले सर्वर का इस्तेमाल करके, टीईई विज्ञापन वापस पाने के मामले में, इस पैरामीटर में prepareDataForAdRetrieval यूडीएफ़ का नतीजा शामिल होगा. ध्यान दें: इस चरण में, सुरक्षित ऐप्लिकेशन के सिग्नल को डिकोड और अनक्रिप्ट किया जाएगा.
• deviceMetadata: JSON ऑब्जेक्ट, जिसमें सेलर की विज्ञापन सेवा से भेजा गया डिवाइस मेटाडेटा शामिल होता है. ज़्यादा जानकारी के लिए, बीएंडए दस्तावेज़ देखें.
  • X-Accept-Language: डिवाइस पर इस्तेमाल की जाने वाली भाषा.
  • X-User-Agent: डिवाइस पर इस्तेमाल किया जाने वाला यूज़र एजेंट.
  • X-BnA-Client-IP: डिवाइस का आईपी पता.
• contextualSignals: एक ही डीएसए (डाइनैमिक सर्च विज्ञापन) के ऑपरेट किए गए कॉन्टेक्स्ट बिडिंग सर्वर से जनरेट हुई मनमानी स्ट्रिंग. उम्मीद है कि यूडीएफ, स्ट्रिंग को डिकोड कर पाएगा और उसका इस्तेमाल कर पाएगा. कॉन्टेक्स्ट के हिसाब से मिलने वाले सिग्नल में कोई भी जानकारी हो सकती है. जैसे, सुरक्षित ऐप्लिकेशन के सिग्नल का इस्तेमाल करके, सुरक्षित एम्बेडिंग के लिए एमएल मॉडल के वर्शन की जानकारी.
• contextualAdIds: विज्ञापन आईडी की वैकल्पिक सूची वाला JSON ऑब्जेक्ट.

यूडीएफ़, काम पूरा होने पर कोई स्ट्रिंग दिखाना चाहिए. स्ट्रिंग को बिडिंग सर्वर पर भेजा जाता है, जो इसे generateBid यूडीएफ़ को भेजता है. हालांकि, स्ट्रिंग सिर्फ़ एक सामान्य स्ट्रिंग हो सकती है, लेकिन ज़्यादातर मामलों में स्ट्रिंग, सीरियलाइज़ किया गया ऑब्जेक्ट होना चाहिए. हर विज्ञापन टेक्नोलॉजी कंपनी, अपने हिसाब से स्ट्रिंग का स्कीमा तय करती है. जब तक विज्ञापन टेक्नोलॉजी का generateBid लॉजिक, स्ट्रिंग को पहचान और इस्तेमाल कर सकता है, तब तक स्कीमा पर कोई पाबंदी नहीं है.

डेवलपमेंट के लिए अपना सिस्टम सेट अप करना

Android

Android डेवलपमेंट एनवायरमेंट सेट अप करने के लिए, आपको ये काम करने होंगे:

1. ऐसा एमुलेटर (प्राथमिकता दी जाती है) या फ़िज़िकल डिवाइस बनाएं जिस पर Developer Preview 10 इमेज चल रही हो
2. ये कमांड चलाएं:

adb shell am start -n com.google.android.adservices.api/com.android.adservices.ui.settings.activities.AdServicesSettingsMainActivity

इसके बाद, ऐप्लिकेशन से सुझाए गए विज्ञापनों के लिए सहमति देने के लिए, दिखाया गया विकल्प चुनें.

1. काम के एपीआई चालू करने के लिए, यह कमांड चलाएं. आपको कभी-कभी इसे फिर से चलाना पड़ सकता है, क्योंकि बंद किए गए डिफ़ॉल्ट कॉन्फ़िगरेशन को समय-समय पर सिंक किया जाएगा.

adb shell device_config put adservices fledge_custom_audience_service_kill_switch false;  adb shell device_config put adservices fledge_select_ads_kill_switch false; adb shell device_config put adservices fledge_on_device_auction_kill_switch false; adb shell device_config put adservices fledge_auction_server_kill_switch false; adb shell "device_config put adservices disable_fledge_enrollment_check true";  adb shell device_config put adservices ppapi_app_allow_list '\*'; adb shell device_config put adservices fledge_auction_server_overall_timeout_ms 60000;

1. डिवाइस को रीस्टार्ट करें.
2. अपने ऑक्शन पासकोड सर्वर पर ले जाने के लिए, डिवाइस की ऑक्शन पासकोड बदलें. नीलामी चलाने से पहले, यह चरण पूरा करना ज़रूरी है, ताकि गलत कुंजियों को कैश मेमोरी में सेव होने से रोका जा सके.

बिडिंग और नीलामी से जुड़ी सेवाएं

B&A सर्वर सेट अप करने के लिए, खुद से सेटअप करने के दस्तावेज़ देखें.

इस दस्तावेज़ में, खरीदार के हिसाब से सर्वर कॉन्फ़िगर करने का तरीका बताया गया है. ऐसा इसलिए, क्योंकि सेलर को कोई बदलाव करने की ज़रूरत नहीं है.

ज़रूरी शर्तें

B&A सेवा स्टैक को डिप्लॉय करने से पहले, खरीदार की विज्ञापन टेक्नोलॉजी को:

• पक्का करें कि उन्होंने अपनी TEE विज्ञापन वापस पाने की सेवा को डिप्लॉय किया हो (काम का सेक्शन देखें).
• पक्का करें कि विज्ञापन टेक्नोलॉजी में सभी ज़रूरी यूडीफ़ (prepareDataForAdRetrieval, generateBid, reportWin, getCandidateAds) तय और होस्ट किए गए हों.

Protected Audience API की मदद से की जाने वाली नीलामी, बिडिंग और ऑप्टिमाइज़ेशन (B&A) के साथ कैसे काम करती है, यह समझना भी मददगार होगा. हालांकि, ऐसा करना ज़रूरी नहीं है.

Terraform कॉन्फ़िगरेशन

सुरक्षित ऐप्लिकेशन सिग्नल का इस्तेमाल करने के लिए, विज्ञापन टेक्नोलॉजी को ये काम करने होंगे:

• B&A में, सुरक्षित ऐप्लिकेशन सिग्नल की सहायता चालू करें.
• ऐसे यूआरएल एंडपॉइंट दें जिनसे prepareDataForAdRetrieval, generateBid और reportWin के लिए नए यूडीएफ़ फ़ेच किए जा सकें.

इसके अलावा, इस गाइड में यह माना गया है कि रीमार्केटिंग के लिए बिडिंग और ऑप्टिमाइज़ेशन (बीए) का इस्तेमाल करने वाले विज्ञापन टेक्नोलॉजी विशेषज्ञ, रीमार्केटिंग नीलामी के लिए सभी मौजूदा कॉन्फ़िगरेशन फ़्लैग को पहले की तरह सेट करते रहेंगे.

खरीदार का विज्ञापन टेक्नोलॉजी कॉन्फ़िगरेशन

इस डेमो फ़ाइल को उदाहरण के तौर पर इस्तेमाल करके, खरीदारों को ये फ़्लैग सेट करने होंगे:

• सुरक्षित ऐप्लिकेशन सिग्नल चालू करें: इससे सुरक्षित ऐप्लिकेशन सिग्नल का डेटा इकट्ठा किया जा सकता है.
• Protected App Signals के यूआरएल: Protected App Signals के सर्वर के यूआरएल पर सेट करें.

विज्ञापन टेक्नोलॉजी को इन फ़ील्ड के प्लेसहोल्डर में सही यूआरएल डालने होंगे:

module "buyer" {
  # ... More config here.

  runtime_flags = {
    # ... More config here.

    ENABLE_PROTECTED_APP_SIGNALS                  = "true"
    PROTECTED_APP_SIGNALS_GENERATE_BID_TIMEOUT_MS = "60000"
    TEE_AD_RETRIEVAL_KV_SERVER_ADDR               = "<service mesh address of the instance>"
    AD_RETRIEVAL_TIMEOUT_MS                       = "60000"
    BUYER_CODE_FETCH_CONFIG                       = <<EOF
    {
        "protectedAppSignalsBiddingJsUrl": "<URL to Protected App Signals generateBid UDF>",
        "urlFetchTimeoutMs": 60001, # This has to be > 1 minute.
        "urlFetchPeriodMs": 13000000,
        "prepareDataForAdsRetrievalJsUrl": "<URL to the UDF>"
    }
    EOF

  }  # runtime_flags

}  # Module "buyer"

सेलर का विज्ञापन टेक्नोलॉजी कॉन्फ़िगरेशन

उदाहरण के तौर पर, इस डेमो फ़ाइल का इस्तेमाल करके, सेलर को ये फ़्लैग सेट करने होंगे. (ध्यान दें: यहां सिर्फ़ सुरक्षित ऐप्लिकेशन सिग्नल से जुड़े कॉन्फ़िगरेशन को हाइलाइट किया गया है). विज्ञापन टेक्नोलॉजी की टीम को यह पक्का करना होगा कि वे प्लेसहोल्डर में सही यूआरएल डालें:

module "seller" {
  # ... More config here.

  runtime_flags = {
    # ... More config here.

    ENABLE_PROTECTED_APP_SIGNALS                  = "true"

    SELLER_CODE_FETCH_CONFIG                           = <<EOF
  {
    "urlFetchTimeoutMs": 60001, # This has to be > 1 minute.
    "urlFetchPeriodMs": 13000000,
    "protectedAppSignalsBuyerReportWinJsUrls": {"<Buyer Domain>": "URL to reportWin UDF"}
  }
  EOF

  }  # runtime_flags

}  # Module "seller"

KV और विज्ञापन वापस पाने की सेवाएं

विज्ञापन वापस पाने के लिए चुनी गई रणनीतियों के आधार पर, सिस्टम को KV सेवा के एक या दो इंस्टेंस डिप्लॉय करने होंगे. हम TEE पर आधारित विज्ञापन को फिर से पाने के लिए इस्तेमाल किए गए KV इंस्टेंस को Ad Retrieval Server के तौर पर और कॉन्टेक्स्ट के हिसाब से पाथ पर आधारित विज्ञापन को फिर से पाने के लिए इस्तेमाल किए गए इंस्टेंस को KV Lookup Server के तौर पर रेफ़र करेंगे.

दोनों मामलों में, सर्वर को डिप्लॉय करने के लिए, KV सर्वर GitHub में उपलब्ध दस्तावेज़ों का पालन किया जाता है. दोनों मामलों में अंतर यह है कि लुकअप केस, बिना किसी अतिरिक्त कॉन्फ़िगरेशन के काम करता है, जबकि डेटा वापस पाने के लिए, डेटा वापस पाने के लॉजिक को लागू करने के लिए getCandidateAds यूडीएफ़ को डिप्लॉय करना ज़रूरी है. ज़्यादा जानकारी के लिए, KV सर्वर को शामिल करने की गाइड देखें. ध्यान दें कि B&A को उम्मीद है कि दोनों सेवाओं को बिडिंग सेवा के तौर पर एक ही सेवा मेश में डिप्लॉय किया जाएगा.

सेटअप का उदाहरण

इस स्थिति पर विचार करें: Protected App Signals API का इस्तेमाल करके, विज्ञापन टेक्नोलॉजी, उपयोगकर्ता के ऐप्लिकेशन के इस्तेमाल के आधार पर काम के सिग्नल सेव करती है. हमारे उदाहरण में, ऐसे सिग्नल सेव किए गए हैं जो कई ऐप्लिकेशन से की गई इन-ऐप्लिकेशन खरीदारी के बारे में बताते हैं. नीलामी के दौरान, एन्क्रिप्ट किए गए सिग्नल इकट्ठा किए जाते हैं और B&A में चल रही सुरक्षित नीलामी में भेजे जाते हैं. बिडिंग और ऑप्टिमाइज़ेशन में चल रहे खरीदार के यूडीएफ़, विज्ञापन के संभावित नतीजे फ़ेच करने और बिड का हिसाब लगाने के लिए सिग्नल का इस्तेमाल करते हैं.

[Buyer] सिग्नल के उदाहरण

0 की की और 1 की वैल्यू वाला सिग्नल जोड़ता है.

{
  "put": {
    "AA==": "AQ=="
  },
  "update_encoder": {
    "action": "REGISTER",
    "endpoint": "https://example.com/example_script"
  }
}

यह फ़ंक्शन, 1 की-वैल्यू और 2 वैल्यू वाला सिग्नल जोड़ता है.

{
  "put": {
    "AQ==": "Ag=="
  },
  "update_encoder": {
    "action": "REGISTER",
    "endpoint": "https://example.com/example_script"
  }
}

[Buyer] encodeSignals का उदाहरण

हर सिग्नल को दो बाइट में एन्कोड करता है. पहला बाइट, सिग्नल कुंजी का पहला बाइट होता है और दूसरा बाइट, सिग्नल वैल्यू का पहला बाइट होता है.

function encodeSignals(signals, maxSize) {
  // if there are no signals don't write a payload
  if (signals.size === 0) {
      return {};
  }

  let result = new Uint8Array(signals.size * 2);
  let index = 0;
  
  for (const [key, values] of signals.entries()) {
    result[index++] = key[0];
    result[index++] = values[0].signal_value[0];
  }
  
  return { 'status': 0, 'results': result};
}

[Buyer] prepareDataForAdRetrieval का उदाहरण

/**
 * `encodedOnDeviceSignals` is a Uint8Array and would contain
 * the app signals emanating from device. For purpose of the
 * demo, in our sample example, we assume that device is sending
 * the signals with pair of bytes formatted as following:
 * "<id><In app spending>". Where id corresponds to an ad category
 * that user uses on device, and the in app spending is a measure
 * of how much money the user has spent in this app category
 * previously. In our example, id of 0 will correspond to a
 * fitness ad category and a non-zero id will correspond to
 * food app category -- though this info will be useful
 * later in the B&A pipeline.
 *
 * Returns a JSON object indicating what type of ad(s) may be
 * most relevant to the user. In a real setup ad techs might
 * want to decode the signals as part of this script.
 *
 * Note: This example script makes use of only encoded device signals
 * but adtech can take other signals into account as well to prepare
 * the data that will be useful down stream for ad retrieval and
 * bid generation. The max length of the app signals used in this
 * sample example is arbitrarily limited to 4 bytes.
 */
function prepareDataForAdRetrieval(encodedOnDeviceSignals,
                                   encodedOnDeviceSignalsVersion,
                                   sellerAuctionSignals,
                                   contextualSignals) {
  if (encodedOnDeviceSignals.length === 0 || encodedOnDeviceSignals.length > 4 ||
      encodedOnDeviceSignals.length % 2 !== 0) {
     throw "Expected encoded signals length to be an even number in (0, 4]";
  }

  var preparedDataForAdRetrieval = {};
  for (var i = 0; i < encodedOnDeviceSignals.length; i += 2) {
    preparedDataForAdRetrieval[encodedOnDeviceSignals[i]] = encodedOnDeviceSignals[i + 1];
  }
  return preparedDataForAdRetrieval;
}

[खरीदार] विज्ञापन वापस पाने के लिए सैंपल यूडीएफ़

हमारे उदाहरण में, विज्ञापन वापस पाने वाला सर्वर, सबसे ज़्यादा k विज्ञापनों के लिए मेटाडेटा भेजता है. जैसे, इस उदाहरण में हर विज्ञापन के लिए आईडी, लेकिन इसमें हर विज्ञापन के लिए ऐसा अन्य डेटा भी शामिल हो सकता है जो बाद में बिड जनरेट करने में मददगार हो सकता है.

function getCandidateAds(requestMetadata, protectedSignals, deviceMetadata,
                      contextualSignals,   contextualAdIds,) {
 return "[{\"adId\":\"0\"},{\"adId\":\"1\"}]"

[खरीदार] generateBid का उदाहरण

/**
 * This script receives the data returned by the ad retrieval service
 * in the `ads` argument. This argument is supposed to contain all
 * the Protected App Signals related ads and the metadata obtained from the retrieval
 * service.
 *
 * `preparedDataForAdRetrieval` argument contains the data returned
 * from the `prepareDataForAdRetrieval` UDF.
 *
 * This script is responsible for generating bids for the ads
 * collected from the retrieval service and ad techs can decide to
 * run a small inference model as part of this script in order to
 * decide the best bid given all the signals available to them.
 *
 * For the purpose of the demo, this sample script assumes
 * that ad retrieval service has sent us most relevant ads for the
 * user and this scripts decides on the ad render URL as well as
 * what value to bid for each ad based on the previously decoded
 * device signals. For simplicity sake, this script only considers
 * 2 types of app categories i.e. fitness and food.
 *
 * Note: Only one bid is returned among all the
 * input ad candidates.
 */
function generateBid(ads, sellerAuctionSignals, buyerSignals, preparedDataForAdRetrieval) {
  if (ads === null) {
    console.log("No ads obtained from the ad retrieval service")
    return {};
  }     
        
  const kFitnessAd = "0";
  const kFoodAd = "1";
  const kBuyerDomain = "https://buyer-domain.com";
        
  let resultingBid = 0;
  let resultingRender = kBuyerDomain + "/no-ad";
  for (let i = 0 ; i < ads.length; ++i) {
    let render = "";
    let bid = 0;
    switch (ads[i].adId) {
      case kFitnessAd:
        render = kBuyerDomain + "/get-fitness-app";
        bid = preparedDataForAdRetrieval[kFitnessAd];
        break;
      case kFoodAd:
        render = kBuyerDomain + "/get-fastfood-app";
        bid = preparedDataForAdRetrieval[kFoodAd];
        break;
      default:
        console.log("Unknown ad category");
        render = kBuyerDomain + "/no-ad";
        break;
    }
    console.log("Existing bid: " + resultingBid + ", incoming candidate bid: " + bid);
    if (bid > resultingBid) {
      resultingBid = bid;
      resultingRender = render;
    }
  }
  return {"render": resultingRender, "bid": resultingBid};
}

[Buyers] reportWin का उदाहरण

reportWin यूडीएफ़, खरीदार को बताता है कि उसने नीलामी जीत ली है.

function reportWin(auctionSignals, perBuyerSignals, signalsForWinner,
                                       buyerReportingSignals, directFromSellerSignals,
                                       egressPayload,
                                       temporaryUnlimitedEgressPayload) {
  sendReportTo("https://buyer-controlled-domain.com/");
  registerAdBeacon({"clickEvent":"https://buyer-controlled-domain.com/clickEvent"});
  return;
}

[सेलर] केवी सर्वर सेटअप करना

सेलर को स्कोरिंग सिग्नल के लिए केवी सर्वर सेट अप करना होगा, ताकि विज्ञापन रेंडर यूआरएल से मिलते-जुलते स्कोरिंग सिग्नल के लिए मैपिंग उपलब्ध हो. उदाहरण के लिए: अगर खरीदार ने https:/buyer-domain.com/get-fitness-app और https:/buyer-domain.com/get-fastfood-app को दिखाया है, तो https://key-value-server-endpoint.com?client_type=1&renderUrls=<render-url-returned-by-the-buyer> पर GET का इस्तेमाल करके एसएफ़ई से क्वेरी करने पर, सेलर के पास स्कोरिंग सिग्नल का यह जवाब हो सकता है:

{
   "renderUrls" : {
      "https:/buyer-domain.com/get-fitness-app" : [
         "1",
         "2"
      ],
      "https:/buyer-domain.com/get-fastfood-app" : [
         "3",
         "4"
      ]
   }
}

[सेलर] scoreAd का उदाहरण

/**
 * This module generates a random desirability score for the Protected App
 * Signals ad in this example. In a production deployment,
 * however, the sellers would want to use all the available signals to generate
 * a score for the ad.
 */
function getRandomInt(max) {
  return Math.floor(Math.random() * max);
}

function scoreAd(adMetadata, bid, auctionConfig,
                                   trustedScoringSignals, deviceSignals,
                                   directFromSellerSignals) {
  return {
    "desirability": getRandomInt(10000),
    "allowComponentAuction": false
  };
}

[सेलर] reportResult का उदाहरण

function reportResult(auctionConfig, sellerReportingSignals, directFromSellerSignals){
  let signalsForWinner = {};
    sendReportTo("https://seller-controlled-domain.com");
    registerAdBeacon({"clickEvent":
                    "https://seller-controlled-domain.com/clickEvent"});
    return signalsForWinner;
}

सैंपल ऐप्लिकेशन

ऊपर बताए गए आसान फ़्लो का इस्तेमाल करके, ऐप्लिकेशन बनाने के लिए एपीआई का इस्तेमाल कैसे किया जा सकता है, इसका उदाहरण देने के लिए हमने Protected App Signals का सैंपल ऐप्लिकेशन बनाया है. इसे इस सैंपल रिपॉज़िटरी में देखा जा सकता है.