সুরক্ষিত অ্যাপ সিগন্যাল বিকাশকারীর নির্দেশিকা

ডেভেলপারদের সুরক্ষিত অ্যাপ সিগন্যাল API নিয়ে পরীক্ষা-নিরীক্ষা শুরু করতে সাহায্য করার জন্য, এই ডকুমেন্টটি API পৃষ্ঠের মধ্যে থাকা সমস্ত API বর্ণনা করে, একটি পরীক্ষামূলক পরিবেশ কীভাবে সেট আপ করতে হয় তার বিশদ বিবরণ দেয় এবং কনফিগারেশন এবং স্ক্রিপ্টগুলির উদাহরণ প্রদান করে।

সংস্করণ ইতিহাস

জানুয়ারী ২০২৪

PAS MVP রিলিজ সমর্থনকারী ডেভেলপারের গাইডের প্রথম রিলিজ

মার্চ ২০২৪

অ্যান্ড্রয়েড API-এর M-2024-05 রিলিজ এবং সার্ভার সাইড উপাদানগুলির এপ্রিল 2024 রিলিজ সমর্থন করার জন্য API-তে পরিবর্তন। সবচেয়ে উল্লেখযোগ্য পরিবর্তনগুলি:

• অন-ডিভাইস API-এর জন্য প্রয়োজনীয় অনুমতি সম্পর্কে বিশদ যোগ করা হয়েছে।
• ডিভাইসে সিগন্যাল কোটা ব্যবস্থাপনা সম্পর্কে বিশদ যোগ করা হয়েছে।
• প্রাসঙ্গিক বিজ্ঞাপন পুনরুদ্ধার এবং বহির্গমন সহায়তার সাথে সম্পর্কিত পরিবর্তন সহ generateBid স্বাক্ষর আপডেট করা হয়েছে।
• আপডেট করা reportWin ডকুমেন্টেশন, যার মধ্যে রয়েছে বহির্গমন সহায়তা।
• বিজ্ঞাপন পুনরুদ্ধার API ডকুমেন্টেশন আপডেট করুন BYOS বিজ্ঞাপন পুনরুদ্ধারের জন্য সমর্থন অপসারণ করুন এবং বিজ্ঞাপন পুনরুদ্ধার UDF ডকুমেন্ট করুন।

API ওভারভিউ

সুরক্ষিত সিগন্যালস API পৃষ্ঠে বিভিন্ন সিস্টেমে API এর বিভিন্ন উপসেট অন্তর্ভুক্ত থাকে:

• অ্যান্ড্রয়েড এপিআই:
  • সিগন্যাল কিউরেশন API, যা তৈরি:
  • সিগন্যাল API আপডেট করুন
  • সিগন্যাল এনকোডিং API
  • সুরক্ষিত নিলাম সহায়তা API: সুরক্ষিত অ্যাপ সিগন্যাল ব্যবহার করে বিডিং এবং নিলাম (B&A) সার্ভারে সুরক্ষিত নিলাম চালানোর জন্য SDK গুলি ব্যবহার করবে।
• সার্ভার-সাইড API গুলি:
  • সুরক্ষিত নিলাম API: বিডিং এবং নিলাম সার্ভারে চলমান JS স্ক্রিপ্টগুলির একটি সিরিজ। এই API বিক্রেতা এবং ক্রেতাদের সুরক্ষিত নিলাম বাস্তবায়নের জন্য যুক্তি লিখতে সক্ষম করে।
  • বিজ্ঞাপন পুনরুদ্ধার API: ক্রেতার বিডিং সার্ভারে উপলব্ধ প্রাসঙ্গিক এবং ব্যবহারকারীর তথ্যের ভিত্তিতে প্রার্থীর বিজ্ঞাপনের একটি তালিকা প্রদানের জন্য দায়ী।

অ্যান্ড্রয়েড ক্লায়েন্ট

ক্লায়েন্ট সাইডে, সুরক্ষিত অ্যাপ সিগন্যাল সারফেসটিতে তিনটি ভিন্ন API থাকে:

• আপডেট সিগন্যাল: ডিভাইসে সিগন্যালের কিউরেশন সক্ষম করার জন্য একটি অ্যান্ড্রয়েড সিস্টেম এপিআই।
• সিগন্যাল এনকোডিং: নিলামের সময় সার্ভারে পাঠানোর জন্য সিগন্যাল প্রস্তুত করার জন্য একটি জাভাস্ক্রিপ্ট এপিআই।
• সুরক্ষিত নিলাম সহায়তা: বিডিং এবং নিলাম সার্ভারগুলিতে সুরক্ষিত নিলাম কার্যকর করার জন্য একটি API। এই API সুরক্ষিত অ্যাপ সিগন্যালের জন্য নির্দিষ্ট নয় এবং সুরক্ষিত দর্শক API-এর জন্য নিলাম সমর্থন করার জন্যও ব্যবহৃত হয়।

সিগন্যাল API আপডেট করুন

আপডেট সিগন্যালস এপিআই বিজ্ঞাপন প্রযুক্তিবিদদের ক্রেতার পক্ষে ব্যবহারকারী এবং অ্যাপ সম্পর্কিত সিগন্যাল নিবন্ধন করার ক্ষমতা প্রদান করে। এপিআই একটি ডেলিগেশন মডেলে কাজ করে। কলার একটি ইউআরআই প্রদান করে যা থেকে ফ্রেমওয়ার্ক সংশ্লিষ্ট সিগন্যালগুলি এবং নিলামে ব্যবহারের জন্য সেই সিগন্যালগুলিকে এনকোড করার যুক্তি সংগ্রহ করে।

API-এর জন্য android.permission.ACCESS_ADSERVICES_PROTECTED_SIGNALS অনুমতি প্রয়োজন।

updateSignals() API URI থেকে একটি 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);

সিগন্যাল আপডেটগুলি আনার জন্য প্ল্যাটফর্মটি অনুরোধে প্রদত্ত URI-তে একটি https অনুরোধ করে। সিগন্যাল আপডেটের সাথে, প্রতিক্রিয়াতে একটি এন্ডপয়েন্ট অন্তর্ভুক্ত থাকতে পারে যা কাঁচা সিগন্যালগুলিকে এনকোডেড পেলোডে রূপান্তর করার জন্য এনকোডিং লজিক হোস্ট করে। সিগন্যাল আপডেটগুলি JSON আকারে হবে বলে আশা করা হচ্ছে এবং এতে নিম্নলিখিত কীগুলি থাকতে পারে:

JSON অবজেক্টের জন্য শীর্ষ স্তরের কীগুলি অবশ্যই পাঁচটি কমান্ডের একটির সাথে সঙ্গতিপূর্ণ হতে হবে:

একটি নমুনা 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"
    }
}

সিগন্যালগুলিতে ডিভাইসে ১০-১৫Kb কোটা থাকবে। কোটা অতিক্রম করলে PPAPI একটি FIFO কৌশল ব্যবহার করে সিগন্যাল উচ্ছেদ করবে। উচ্ছেদের প্রক্রিয়াটি উচ্ছেদের ফ্রিকোয়েন্সি কমাতে অল্প সময়ের জন্য কোটা সামান্য অতিক্রম করার অনুমতি দেবে।

সিগন্যাল এনকোডিং API

সুরক্ষিত নিলামের সময় সার্ভারে পাঠানোর জন্য ডিভাইসে সংরক্ষিত সিগন্যালগুলিকে এনকোড করার জন্য ক্রেতাদের একটি জাভা স্ক্রিপ্ট ফাংশন সরবরাহ করতে হবে। ক্রেতারা UpdateSignal API অনুরোধের যেকোনো প্রতিক্রিয়ায় "update_encoder" কী ব্যবহার করে যে URL থেকে এটি আনা যেতে পারে তা যোগ করে এই স্ক্রিপ্টটি সরবরাহ করতে পারেন। স্ক্রিপ্টটিতে নিম্নলিখিত স্বাক্ষর থাকবে:

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 প্যারামিটার হল UInt8Arrays আকারের কী থেকে শুরু করে ৪ নম্বর সাইজের সুরক্ষিত অ্যাপ সিগন্যাল অবজেক্টের তালিকা পর্যন্ত একটি মানচিত্র। প্রতিটি সুরক্ষিত অ্যাপ সিগন্যাল অবজেক্টের তিনটি ক্ষেত্র থাকে:

• signal_value : একটি UInt8Array যা সিগন্যালের মান উপস্থাপন করে।
• creation_time : একটি সংখ্যা যা যুগ-সেকেন্ডে সংকেত তৈরির সময়কে প্রতিনিধিত্ব করে।
• package_name : সিগন্যাল তৈরি করা প্যাকেজের নাম প্রতিনিধিত্বকারী একটি স্ট্রিং।

maxSize প্যারামিটার হল এমন একটি সংখ্যা যা আউটপুটের জন্য সর্বাধিক অনুমোদিত অ্যারের আকার বর্ণনা করে।

ফাংশনটি দুটি ক্ষেত্র সহ একটি বস্তু আউটপুট করবে:

• status : স্ক্রিপ্টটি সফলভাবে চালানো হলে 0 হওয়া উচিত।
• results : maxSize এর চেয়ে কম বা সমান দৈর্ঘ্যের একটি UInt8Array হওয়া উচিত। এই অ্যারেটি নিলামের সময় সার্ভারে পাঠানো হবে এবং prepareDataForAdRetrieval স্ক্রিপ্ট দ্বারা প্রস্তুত করা হবে।

এই এনকোডিং বিজ্ঞাপন প্রযুক্তিবিদদের ফিচার ইঞ্জিনিয়ারিংয়ের প্রাথমিক পর্যায়ের সুবিধা প্রদান করে, যেখানে তারা তাদের নিজস্ব কাস্টম লজিকের উপর ভিত্তি করে কাঁচা সংকেতগুলিকে সংকুচিত সংস্করণে সংকুচিত করার মতো রূপান্তর সম্পাদন করতে পারে। মনে রাখবেন যে ট্রাস্টেড এক্সিকিউশন এনভায়রনমেন্টস (TEE) তে চলমান একটি সুরক্ষিত নিলামের সময়, বিজ্ঞাপন প্রযুক্তি কাস্টম লজিকের এনকোডিং দ্বারা উৎপন্ন সিগন্যাল পেলোডগুলিতে পড়ার অ্যাক্সেস থাকবে। ক্রেতার B&A TEE তে চলমান কাস্টম লজিক, যা ব্যবহারকারী সংজ্ঞায়িত ফাংশন (UDF) নামে পরিচিত, বিজ্ঞাপন নির্বাচন (বিজ্ঞাপন পুনরুদ্ধার এবং বিডিং) সম্পাদন করার জন্য প্রকাশক অ্যাপ দ্বারা প্রদত্ত এনকোডেড সংকেত এবং অন্যান্য প্রাসঙ্গিক সংকেতগুলিতে পড়ার অ্যাক্সেস থাকবে।

সিগন্যাল এনকোডিং

প্রতি ঘন্টায়, যেসব ক্রেতা তাদের নিবন্ধিত সিগন্যালের সাথে এনকোডিং লজিক প্রদান করেছেন তাদের সিগন্যালগুলি একটি নিলাম পেলোডে এনকোড করা হবে। নিলাম পেলোডের বাইট অ্যারে ডিভাইসে স্থায়ী থাকে এবং এনক্রিপ্ট করা থাকে এবং বিক্রেতারা বিজ্ঞাপন নির্বাচন ডেটার অংশ হিসাবে এটি সংগ্রহ করবে যা একটি সুরক্ষিত নিলামের অংশ হিসাবে অন্তর্ভুক্ত করা হবে। পরীক্ষার জন্য, আপনি নিম্নলিখিত কমান্ডটি চালিয়ে ঘন্টার ক্যাডেন্সের বাইরে এই এনকোডিংটি ট্রিগার করতে পারেন:

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

এনকোডার লজিক ভার্সনিং

যখন বিজ্ঞাপন প্রযুক্তির কাস্টম এনকোডার লজিক ডাউনলোড করার জন্য অনুরোধ করা হয়, তখন বিজ্ঞাপন প্রযুক্তির শেষ বিন্দু প্রতিক্রিয়া শিরোনামে একটি সংস্করণ নম্বর দিয়ে প্রতিক্রিয়া জানাতে পারে। এই সংস্করণটি ডিভাইসে এনকোডার লজিকের সাথে স্থায়ী হয়। যখন কাঁচা সংকেতগুলি এনকোড করা হয়, তখন এনকোড করা পেলোডটি এনকোডিংয়ের জন্য ব্যবহৃত সংস্করণের সাথে স্থায়ী হয়। এই সংস্করণটি একটি সুরক্ষিত নিলামের সময় B&A সার্ভারেও পাঠানো হয়, যাতে বিজ্ঞাপন প্রযুক্তিবিদরা সংস্করণের উপর ভিত্তি করে তাদের বিডিং এবং এনকোডিং লজিক সারিবদ্ধ করতে পারেন।

Response header for providing encoder version : X_ENCODER_VERSION

সুরক্ষিত নিলাম সহায়তা API

ডিভাইসের দিক থেকে, সুরক্ষিত অ্যাপ সিগন্যালের জন্য নিলাম পরিচালনা করা সুরক্ষিত দর্শকদের জন্য নিলাম পরিচালনা করার মতোই ।

বিডিং এবং নিলাম পরিষেবা

সার্ভার সাইড এপিআইগুলির মধ্যে রয়েছে:

• সুরক্ষিত নিলাম API: JS ফাংশন বা UDF-এর একটি সিরিজ যা ক্রেতা এবং বিক্রেতারা তাদের মালিকানাধীন B&A উপাদানগুলিতে স্থাপন করতে পারেন, যাতে বিডিং এবং নিলামের যুক্তি নির্ধারণ করা যায়।
• বিজ্ঞাপন পুনরুদ্ধার API: ক্রেতারা একটি REST এন্ডপয়েন্ট বাস্তবায়নের মাধ্যমে এই API বাস্তবায়ন করতে পারেন যা সুরক্ষিত অ্যাপ সিগন্যাল নিলামের জন্য প্রার্থী বিজ্ঞাপনের একটি সেট সরবরাহের জন্য দায়ী থাকবে।

সুরক্ষিত নিলাম API

সুরক্ষিত নিলাম API-তে JS API বা UDF থাকে যা ক্রেতা এবং বিক্রেতারা তাদের নিলাম এবং বিডিং যুক্তি বাস্তবায়নের জন্য ব্যবহার করতে পারেন।

ক্রেতা বিজ্ঞাপন প্রযুক্তি UDF

PrepareDataForAdRetrieval UDF

TEE বিজ্ঞাপন পুনরুদ্ধার পরিষেবা থেকে বিজ্ঞাপন প্রার্থীদের আনার জন্য সুরক্ষিত অ্যাপ সিগন্যাল ব্যবহার করার আগে, ক্রেতাদের অবশ্যই সুরক্ষিত অ্যাপ সিগন্যাল এবং অন্যান্য বিক্রেতা-প্রদত্ত ডেটা ডিকোড এবং প্রস্তুত করতে হবে। ক্রেতারা prepareDataForAdRetrieval UDF আউটপুট বিজ্ঞাপন পুনরুদ্ধার পরিষেবাতে প্রেরণ করা হয় যাতে বিডিংয়ের জন্য শীর্ষ k প্রার্থী বিজ্ঞাপনগুলি পুনরুদ্ধার করা যায় ।

// 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 ad tech.
function prepareDataForAdRetrieval(encodedOnDeviceSignals,encodedOnDeviceSignalsVersion,sellerAuctionSignals,contextualSignals) {
   return {};
}

জেনারেটবিড ইউডিএফ

শীর্ষ 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 এ পাস করা হবে (egress এবং মডেল প্রশিক্ষণ সম্পর্কে আরও তথ্যের জন্য PAS explainer এর রিপোর্টিং বিভাগটি দেখুন)।

রিপোর্টউইন ইউডিএফ

যখন একটি নিলাম শেষ হবে, তখন নিলাম পরিষেবা ক্রেতাদের জন্য রিপোর্টিং URL তৈরি করবে এবং reportWin UDF ব্যবহার করে বীকন নিবন্ধন করবে (এটি একই reportWin ফাংশন যা Protected Audiences-এর জন্য ব্যবহৃত হয়) । ক্লায়েন্ট দ্বারা বিজ্ঞাপনটি রেন্ডার করার পরে এটি ডিভাইস দ্বারা পিং করা হবে। এই পদ্ধতির স্বাক্ষর Protected Audience সংস্করণের মতো প্রায় একই, দুটি অতিরিক্ত প্যারামিটার egressPayload এবং temporaryUnlimitedEgressPayload ছাড়া যা মডেল প্রশিক্ষণ সক্ষম করতে ব্যবহৃত হয় এবং generateBid থেকে ফলাফল দিয়ে পূর্ণ হয়।

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

বিক্রেতা বিজ্ঞাপন প্রযুক্তি UDF

স্কোরএড ইউডিএফ

ক্রেতাদের কাছ থেকে প্রাপ্ত বিজ্ঞাপনগুলির মধ্যে কোনটি নিলামে জিতবে তা নির্বাচন করতে বিক্রেতারা এই UDF ব্যবহার করেন।

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

রিপোর্ট রেজাল্ট ইউডিএফ

এই UDF বিক্রেতাকে (অবশেষে) বিজয়ী বিজ্ঞাপন সম্পর্কিত তথ্য সহ ইভেন্ট স্তরের প্রতিবেদন করার অনুমতি দেয়।

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

বিজ্ঞাপন পুনরুদ্ধার API

MVP রিলিজে, বিজ্ঞাপন পুনরুদ্ধার পরিষেবাটি একটি ক্রেতা-পরিচালিত এবং হোস্ট করা পরিষেবা হবে এবং বিডিং পরিষেবা এই পরিষেবা থেকে বিজ্ঞাপন প্রার্থীদের পুনরুদ্ধার করবে। ২০২৪ সালের এপ্রিল থেকে, বিজ্ঞাপন পুনরুদ্ধার সার্ভারটি একটি বিশ্বস্ত এক্সিকিউশন এনভায়রনমেন্ট (TEE) তে চলতে হবে এবং একটি GRPC/প্রোটো ইন্টারফেস প্রকাশ করবে। বিজ্ঞাপন প্রযুক্তি সংস্থাগুলিকে এই সার্ভারটি সেট আপ করতে হবে এবং B&A স্ট্যাক স্থাপনের অংশ হিসাবে এর URL প্রদান করতে হবে। TEE তে চলমান এই পরিষেবার একটি বাস্তবায়ন প্রাইভেসি স্যান্ডবক্স GitHub- এ উপলব্ধ এবং বাকি ডকুমেন্টেশনে আমরা ধরে নিচ্ছি যে এটি স্থাপনে ব্যবহৃত কোড।

২০২৪ সালের এপ্রিল থেকে, B&A সংস্করণগুলি প্রাসঙ্গিক পথ বিজ্ঞাপন পুনরুদ্ধার সমর্থন করে। এই ক্ষেত্রে, নিলামের প্রাসঙ্গিক অংশের সময় RTB সার্ভার দ্বারা প্রেরিত বিজ্ঞাপন-শনাক্তকারীর একটি তালিকা বিডিং সার্ভারে পাবে। বিডিং পর্বের সময় ব্যবহৃত সমস্ত বিজ্ঞাপন সম্পর্কিত তথ্য (উদাহরণস্বরূপ, বিজ্ঞাপন-রেন্ডার-url, মেটাডেটা এবং টপ-কে নির্বাচনে ব্যবহৃত বিজ্ঞাপন এম্বেডিং) সংগ্রহ করার জন্য শনাক্তকারীগুলিকে একটি TEE KV সার্ভারে পাঠানো হবে। এই দ্বিতীয় পথটি স্থাপনের জন্য কোনও নির্দিষ্ট যুক্তির প্রয়োজন নেই তাই আমরা এখানে কেবল TEE ভিত্তিক বিজ্ঞাপন পুনরুদ্ধার ব্যবহারের ক্ষেত্রে কীভাবে কনফিগার করতে হয় তা নথিভুক্ত করব।

getCandidateAds UDF সম্পর্কে

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

কোথায়:

• requestMetadata : JSON। UDF-তে প্রতি-অনুরোধ সার্ভার মেটাডেটা। আপাতত খালি।
• preparedDataForAdRetrieval : এই ক্ষেত্রের বিষয়বস্তু বিজ্ঞাপন পুনরুদ্ধার কৌশলের উপর নির্ভর করে। প্রাসঙ্গিক বিজ্ঞাপন পুনরুদ্ধারের ক্ষেত্রে, এই প্যারামিটারে ডিভাইস থেকে উদ্ভূত এবং বিডিং পরিষেবা থেকে পাস করা কাঁচা সংকেত থাকবে। বিজ্ঞাপন পুনরুদ্ধার সার্ভার ব্যবহার করে TEE বিজ্ঞাপন পুনরুদ্ধারের ক্ষেত্রে, এই প্যারামিটারে prepareDataForAdRetrieval UDF এর ফলাফল থাকবে। দ্রষ্টব্য: এই পর্যায়ে সুরক্ষিত অ্যাপ সংকেতগুলি ডিকোড এবং এনক্রিপ্ট করা হবে না।
• deviceMetadata : বিক্রেতার বিজ্ঞাপন পরিষেবা দ্বারা ফরোয়ার্ড করা ডিভাইস মেটাডেটা সম্বলিত JSON অবজেক্ট। আরও বিস্তারিত জানার জন্য B&A ডকুমেন্টেশন দেখুন।
  • X-Accept-Language : ডিভাইসে ব্যবহৃত ভাষা।
  • X-User-Agent : ডিভাইসে ব্যবহৃত ইউজার এজেন্ট।
  • X-BnA-Client-IP : ডিভাইসের IP ঠিকানা।
• contextualSignals : একই DSP দ্বারা পরিচালিত contextual bidding সার্ভার থেকে arbitrary string উৎপন্ন হয়েছে। UDF স্ট্রিংটি ডিকোড করতে এবং এটি ব্যবহার করতে সক্ষম হবে বলে আশা করা হচ্ছে। Contextual Signals-এ Protected App Signals ব্যবহার করে পাস করা সুরক্ষিত এমবেডিংয়ের জন্য ML মডেল সংস্করণের তথ্যের মতো যেকোনো তথ্য থাকতে পারে।
• contextualAdIds : JSON অবজেক্টে বিজ্ঞাপন আইডির একটি ঐচ্ছিক তালিকা থাকে।

সফল হলে UDF-এর একটি স্ট্রিং ফেরত দেওয়া উচিত। স্ট্রিংটি বিডিং সার্ভারে ফেরত দেওয়া হবে যা তারপর এটি generateBid UDF-এ পাঠাবে। যদিও স্ট্রিংটি কেবল একটি মৌলিক স্ট্রিং হতে পারে, সম্ভবত এটি একটি সিরিয়ালাইজড অবজেক্ট হওয়া উচিত যার স্কিমা প্রতিটি বিজ্ঞাপন প্রযুক্তিবিদ তাদের নিজস্বভাবে সংজ্ঞায়িত করে। যতক্ষণ না বিজ্ঞাপন প্রযুক্তিবিদদের generateBid লজিক স্ট্রিংটি চিনতে এবং ব্যবহার করতে পারে ততক্ষণ স্কিমার উপর কোনও সীমাবদ্ধতা নেই।

আপনার সিস্টেম ডেভেলপমেন্টের জন্য সেট আপ করুন

অ্যান্ড্রয়েড

আপনার অ্যান্ড্রয়েড ডেভেলপমেন্ট পরিবেশ সেটআপ করতে আপনাকে নিম্নলিখিতগুলি করতে হবে:

1. একটি এমুলেটর (পছন্দের) অথবা ফিজিক্যাল ডিভাইস তৈরি করুন যা ডেভেলপার প্রিভিউ ১০ ইমেজ চালাচ্ছে।
2. নিম্নলিখিতটি চালান:

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

তারপর অ্যাপ-প্রস্তাবিত বিজ্ঞাপনগুলিতে সম্মতি দেওয়ার জন্য দেখানো বিকল্পটি নির্বাচন করুন।

1. প্রাসঙ্গিক API গুলি সক্রিয় করতে নিম্নলিখিত কমান্ডটি চালান। আপনাকে মাঝে মাঝে এটি পুনরায় চালাতে হতে পারে কারণ ডিসঅ্যাবলের ডিফল্ট কনফিগারেশন পর্যায়ক্রমে সিঙ্ক হবে।

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 বিজ্ঞাপন পুনরুদ্ধার পরিষেবা স্থাপন করেছে ( প্রাসঙ্গিক বিভাগটি দেখুন)।
• যাচাই করুন যে বিজ্ঞাপন প্রযুক্তিবিদদের কাছে সমস্ত প্রয়োজনীয় UDF ( prepareDataForAdRetrieval , generateBid , reportWin , getCandidateAds ) সংজ্ঞায়িত এবং হোস্ট করা আছে।

B&A-এর সাথে Protected Auction with Protected Audience কীভাবে কাজ করে তা বোঝাও সহায়ক হবে তবে এটি বাধ্যতামূলক নয়।

টেরাফর্ম কনফিগারেশন

সুরক্ষিত অ্যাপ সিগন্যাল ব্যবহার করার জন্য, বিজ্ঞাপন প্রযুক্তিবিদদের অবশ্যই:

• B&A-তে সুরক্ষিত অ্যাপ সিগন্যাল সমর্থন সক্ষম করুন।
• এমন URL এন্ডপয়েন্ট প্রদান করুন যেখান থেকে prepareDataForAdRetrieval, generateBid এবং reportWin এর জন্য নতুন UDF গুলি আনা যাবে।

উপরন্তু, এই নির্দেশিকাটি ধরে নিয়েছে যে পুনঃবিপণনের জন্য B&A ব্যবহার করতে ইচ্ছুক বিজ্ঞাপন প্রযুক্তিবিদরা যথারীতি পুনঃবিপণন নিলামের জন্য বিদ্যমান সমস্ত কনফিগারেশন ফ্ল্যাগ সেট করতে থাকবেন।

ক্রেতার বিজ্ঞাপন প্রযুক্তি কনফিগারেশন

এই ডেমো ফাইলটি উদাহরণ হিসেবে ব্যবহার করে, ক্রেতাদের নিম্নলিখিত পতাকাগুলি সেট করতে হবে:

• সুরক্ষিত অ্যাপ সিগন্যাল সক্ষম করুন : সুরক্ষিত অ্যাপ সিগন্যাল ডেটা সংগ্রহ করতে সক্ষম।
• সুরক্ষিত অ্যাপ সিগন্যাল URL গুলি : সুরক্ষিত অ্যাপ সিগন্যাল সার্ভারের URL গুলিতে সেট করুন।

বিজ্ঞাপন প্রযুক্তিবিদদের নিম্নলিখিত ক্ষেত্রগুলির জন্য স্থানধারকগুলিতে সঠিক URL গুলি প্রতিস্থাপন করতে হবে:

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"

বিক্রেতার বিজ্ঞাপন প্রযুক্তি কনফিগারেশন

এই ডেমো ফাইলটিকে উদাহরণ হিসেবে ব্যবহার করে, বিক্রেতাদের নিম্নলিখিত ফ্ল্যাগগুলি সেট করতে হবে। (দ্রষ্টব্য: এখানে শুধুমাত্র সুরক্ষিত অ্যাপ সিগন্যাল সম্পর্কিত কনফিগারেশন হাইলাইট করা হয়েছে)। বিজ্ঞাপন প্রযুক্তিবিদদের যাচাই করতে হবে যে তারা প্লেসহোল্ডারগুলিতে সঠিক URL গুলি প্রতিস্থাপন করেছেন:

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 পরিষেবার এক বা দুটি উদাহরণ স্থাপন করতে হবে। আমরা TEE ভিত্তিক বিজ্ঞাপন পুনরুদ্ধারের জন্য ব্যবহৃত KV ইনস্ট্যান্স ইনস্ট্যান্সকে Ad Retrieval Server হিসাবে এবং প্রাসঙ্গিক পথ ভিত্তিক পুনরুদ্ধার সমর্থন করার জন্য ইনস্ট্যান্সকে KV Lookup Server হিসাবে উল্লেখ করব।

উভয় ক্ষেত্রেই সার্ভার স্থাপনা KV সার্ভার GitHub- এ উপলব্ধ ডকুমেন্টেশন অনুসরণ করে। দুটি ক্ষেত্রের মধ্যে পার্থক্য হল যে লুকআপ কেসটি কোনও অতিরিক্ত কনফিগারেশন ছাড়াই বাক্সের বাইরে কাজ করে, যেখানে পুনরুদ্ধারের ক্ষেত্রে পুনরুদ্ধার যুক্তি বাস্তবায়নের জন্য getCandidateAds UDF স্থাপনের প্রয়োজন হয়। আরও বিস্তারিত জানার জন্য KV সার্ভার অনবোর্ডিং গাইডটি দেখুন। মনে রাখবেন যে B&A আশা করে যে উভয় পরিষেবাই বিডিং পরিষেবার মতো একই পরিষেবা মেশে স্থাপন করা হবে।

উদাহরণ সেটআপ

নিম্নলিখিত পরিস্থিতি বিবেচনা করুন: Protected App Signals API ব্যবহার করে, একটি বিজ্ঞাপন প্রযুক্তিবিদ ব্যবহারকারীর অ্যাপ ব্যবহারের উপর ভিত্তি করে প্রাসঙ্গিক সংকেত সংরক্ষণ করে। আমাদের উদাহরণে, সংকেতগুলি সংরক্ষণ করা হয় যা বেশ কয়েকটি অ্যাপ থেকে অ্যাপ-মধ্যস্থ কেনাকাটার প্রতিনিধিত্ব করে। একটি নিলামের সময়, এনক্রিপ্ট করা সংকেতগুলি সংগ্রহ করা হয় এবং B&A-তে চলমান একটি Protected Auction-এ প্রেরণ করা হয়। B&A-তে চলমান ক্রেতার UDF বিজ্ঞাপন প্রার্থীদের আনতে এবং একটি বিড গণনা করতে সংকেতগুলি ব্যবহার করে।

[ক্রেতা] সংকেতের উদাহরণ

০ এর কী এবং ১ এর মান সহ একটি সিগন্যাল যোগ করে।

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

১ এর কী এবং ২ এর মান সহ একটি সিগন্যাল যোগ করে।

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

[ক্রেতা] এনকোডসিগন্যালের উদাহরণ

প্রতিটি সিগন্যালকে দুটি বাইটে এনকোড করে, প্রথম বাইটটি সিগন্যাল কী-এর প্রথম বাইট এবং দ্বিতীয় বাইটটি সিগন্যাল মানের প্রথম বাইট।

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};
}

[ক্রেতা] 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, an 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 ad tech 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;
}

[ক্রেতা] নমুনা বিজ্ঞাপন পুনরুদ্ধার UDF

আমাদের উদাহরণে, বিজ্ঞাপন পুনরুদ্ধার সার্ভার প্রতিটি শীর্ষ কে বিজ্ঞাপন প্রার্থীর জন্য মেটাডেটা (অর্থাৎ এই উদাহরণে প্রতিটি বিজ্ঞাপনের জন্য আইডি কিন্তু প্রতিটির জন্য অন্যান্য ডেটা থাকতে পারে যা পরবর্তীতে বিড তৈরিতে সহায়ক হতে পারে) পাঠায়।

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

[ক্রেতারা] জেনারেটবিড উদাহরণ

/**
 * 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};
}

[ক্রেতা] রিপোর্টউইন উদাহরণ

reportWin UDF রিপোর্টটি ক্রেতাকে জানায় যে তারা নিলাম জিতেছে।

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

[বিক্রেতা] কেভি সার্ভার সেটআপ

বিক্রেতাদের অবশ্যই একটি স্কোরিং সিগন্যাল KV সার্ভার সেট আপ করতে হবে যাতে বিজ্ঞাপন রেন্ডার URL থেকে সংশ্লিষ্ট স্কোরিং সিগন্যালের সাথে একটি ম্যাপিং পাওয়া যায়, উদাহরণস্বরূপ: যদি https:/buyer-domain.com/get-fitness-app এবং https:/buyer-domain.com/get-fastfood-app ক্রেতা ফেরত পাঠায়, তাহলে SFE দ্বারা 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"
      ]
   }
}

[বিক্রেতা] স্কোরবিজ্ঞাপনের উদাহরণ

/**
 * 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
  };
}

[বিক্রেতা] রিপোর্ট ফলাফলের উদাহরণ

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

নমুনা অ্যাপ

এই প্রবাহ ব্যবহার করে এমন একটি অ্যাপ তৈরি করতে API কীভাবে ব্যবহার করা যেতে পারে তার উদাহরণ হিসেবে, আমরা একটি সুরক্ষিত অ্যাপ সিগন্যাল নমুনা অ্যাপ তৈরি করেছি যা এই নমুনা সংগ্রহস্থলে পাওয়া যাবে।