คู่มือนักพัฒนาซอฟต์แวร์สำหรับสัญญาณแอปที่มีการป้องกัน

เอกสารนี้อธิบาย API ทั้งหมดภายในแพลตฟอร์ม API, รายละเอียดวิธีสร้างสภาพแวดล้อมการทดสอบ และแสดงตัวอย่างการกําหนดค่าและสคริปต์ เพื่อช่วยนักพัฒนาแอปเริ่มทดลองใช้ Protected App Signals API

หมายเหตุ: Protected App Signals ต้องใช้เซิร์ฟเวอร์การเสนอราคาและการประมูลที่ใช้งานได้จึงจะทํางานได้ โปรดทําตามขั้นตอนเพื่อติดตั้งใช้งานการเสนอราคาและการประมูลใน AWS หรือ Google Cloud

ประวัติเวอร์ชัน

Jan 2024

คู่มือนักพัฒนาซอฟต์แวร์รุ่นแรกที่รองรับรุ่น MVP ของ PAS

มีนาคม 2024

การเปลี่ยนแปลงใน API เพื่อรองรับ Android API เวอร์ชัน M-2024-05 และคอมโพเนนต์ฝั่งเซิร์ฟเวอร์เวอร์ชันเดือนเมษายน 2024 การเปลี่ยนแปลงที่เห็นได้ชัดที่สุดมีดังนี้

• เพิ่มรายละเอียดเกี่ยวกับสิทธิ์ที่จําเป็นสําหรับ API ในอุปกรณ์
• เพิ่มรายละเอียดเกี่ยวกับการจัดการโควต้าสัญญาณในอุปกรณ์
• อัปเดตลายเซ็น generateBid ด้วยการเปลี่ยนแปลงที่เกี่ยวข้องกับการดึงข้อมูลโฆษณาตามบริบทและการสนับสนุนการส่งออก
• อัปเดตเอกสารประกอบ reportWin รวมถึงการรองรับการส่งออก
• อัปเดตเอกสารประกอบของ Ad Retrieval API โดยนําการรองรับการดึงข้อมูลโฆษณา BYOS ออก และบันทึก UDF ของการดึงข้อมูลโฆษณา

ภาพรวมของ API

แพลตฟอร์ม Protected Signals API มีชุดย่อยของ API ที่แตกต่างกันในระบบต่างๆ ดังนี้

• API ของ Android
  • Signal Curation API ซึ่งประกอบด้วย
  • Update Signals API
  • Signals Encoding API
  • Protected Auction Support API: สำหรับให้ SDK ใช้เรียกใช้การประมูลที่ได้รับการปกป้องบนเซิร์ฟเวอร์การเสนอราคาและการประมูล (B&A) โดยใช้สัญญาณแอปที่ได้รับการปกป้อง
• API ฝั่งเซิร์ฟเวอร์
  • Protected Auction API: ชุดสคริปต์ JS ที่ทำงานในเซิร์ฟเวอร์การเสนอราคาและการประมูล API นี้ช่วยให้ผู้ขายและผู้ซื้อเขียนตรรกะเพื่อใช้การประมูลที่มีการป้องกันได้
  • Ad Retrieval API: มีหน้าที่ระบุรายการโฆษณาที่เป็นไปได้โดยพิจารณาจากบริบทและข้อมูลผู้ใช้ที่พร้อมให้บริการแก่เซิร์ฟเวอร์การเสนอราคาของผู้ซื้อ

ไคลเอ็นต์ Android

ฝั่งไคลเอ็นต์ แพลตฟอร์ม Protected App Signals ประกอบด้วย API 3 รายการที่แตกต่างกัน ดังนี้

• อัปเดตสัญญาณ: Android System API เพื่อเปิดใช้การดูแลจัดการสัญญาณในอุปกรณ์
• การเข้ารหัสสัญญาณ: JavaScript API เพื่อเตรียมสัญญาณที่จะส่งไปยังเซิร์ฟเวอร์ระหว่างการประมูล
• การรองรับการประมูลที่มีการป้องกัน: API เพื่อรองรับการดำเนินการของการประมูลที่มีการป้องกันบนเซิร์ฟเวอร์การเสนอราคาและการประมูล API นี้ไม่ได้ใช้เฉพาะกับ Protected App Signals เท่านั้น แต่ยังใช้เพื่อรองรับการประมูลสําหรับ Protected Audience API ด้วย

หมายเหตุ: ขณะทดสอบด้วยสัญญาณแอปที่ได้รับการปกป้องในรุ่นตัวอย่างสำหรับนักพัฒนาแอป เราขอแนะนำให้ใช้โปรแกรมจำลอง เนื่องจากมีหลายกรณีที่วิธีที่ดีที่สุดในการแก้ปัญหาในการตั้งค่าคือการล้างข้อมูลในอุปกรณ์

Update Signals API

Update Signals API ช่วยให้เทคโนโลยีโฆษณาสามารถลงทะเบียนสัญญาณที่เกี่ยวข้องกับผู้ใช้และแอปในนามของผู้ซื้อได้ API ทํางานในรูปแบบการมอบสิทธิ์ ผู้เรียกใช้ระบุ URI ที่เฟรมเวิร์กจะดึงข้อมูลสัญญาณที่เกี่ยวข้องและตรรกะในการเข้ารหัสสัญญาณเหล่านั้นเพื่อใช้ในขั้นตอนการประมูล

API ต้องใช้สิทธิ์ android.permission.ACCESS_ADSERVICES_PROTECTED_SIGNALS

updateSignals() API จะดึงข้อมูลออบเจ็กต์ JSON จาก URI ที่อธิบายสัญญาณที่จะเพิ่มหรือนําออก และวิธีเตรียมสัญญาณเหล่านั้นสําหรับการประมูล

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 ไปยัง URI ที่ระบุในคําขอเพื่อดึงข้อมูลอัปเดตสัญญาณ นอกเหนือจากการอัปเดตสัญญาณแล้ว การตอบกลับอาจรวมถึงปลายทางที่โฮสต์ตรรกะการเข้ารหัสเพื่อแปลงสัญญาณดิบเป็นเพย์โหลดที่เข้ารหัส การอัปเดตสัญญาณควรอยู่ในรูปแบบ JSON และอาจมีคีย์ต่อไปนี้

คีย์ระดับบนสุดสำหรับออบเจ็กต์ JSON ต้องสอดคล้องกับคําสั่งอย่างใดอย่างหนึ่งต่อไปนี้

key	คำอธิบาย
put	เพิ่มสัญญาณใหม่ โดยเขียนทับสัญญาณที่มีอยู่ด้วยคีย์เดียวกัน ค่า for นี้เป็นออบเจ็กต์ JSON ที่คีย์คือสตริง Base64 ที่สอดคล้องกับคีย์ที่จะใส่ และค่าคือสตริง Base64 ที่สอดคล้องกับค่าที่จะใส่
append	ต่อท้ายสัญญาณใหม่/สัญญาณลงในอนุกรมเวลาของสัญญาณ โดยนําสัญญาณที่เก่าที่สุดออก สัญญาณเพื่อให้มีพื้นที่ว่างสำหรับรายการใหม่หากขนาดของชุดข้อมูลเกินค่าสูงสุดที่กำหนด ค่าสำหรับนี้คือออบเจ็กต์ JSON ที่คีย์คือสตริง Base64 ที่สอดคล้องกับคีย์ที่จะเพิ่มต่อท้าย และค่าคือออบเจ็กต์ที่มี 2 ช่อง ได้แก่ "values" และ "maxSignals" "values": รายการสตริงฐาน 64 ที่สอดคล้องกับค่าสัญญาณที่จะเพิ่มต่อท้ายอนุกรมเวลา "maxSignals": จํานวนค่าสูงสุดที่อนุญาตในอนุกรมเวลานี้ ตามเงื่อนไข หากจํานวนสัญญาณปัจจุบันที่เชื่อมโยงกับคีย์เกิน maxSignals ระบบจะนำสัญญาณที่เก่าที่สุดออก โปรดทราบว่าคุณสามารถเพิ่มต่อท้ายคีย์ที่เพิ่มโดย put ได้ โปรดทราบว่าการเพิ่มค่าเกินจำนวนสูงสุดจะทำให้การดำเนินการไม่สำเร็จ
put_if_not_present	เพิ่มสัญญาณใหม่เฉพาะในกรณีที่ไม่มีสัญญาณที่มีคีย์เดียวกันอยู่แล้ว ค่าสำหรับนี้คือออบเจ็กต์ JSON ที่คีย์คือสตริง Base64 ที่สอดคล้องกับคีย์ที่จะใส่ และค่าคือสตริง Base64 ที่สอดคล้องกับค่าที่จะใส่
remove	นำสัญญาณของกุญแจออก ค่าของนี้คือรายการสตริง Base64 ที่สอดคล้องกับคีย์ของสัญญาณที่ควรลบ
update_encoder	ระบุการดำเนินการเพื่ออัปเดตปลายทางและ URI ที่ใช้งานได้ เพื่อเรียกใช้ตรรกะการเข้ารหัส คีย์ย่อยสำหรับการระบุการดำเนินการอัปเดตคือ "action" และ ค่าที่รองรับในปัจจุบันมีเพียง "REGISTER" เท่านั้น ซึ่งจะลงทะเบียนปลายทางของโปรแกรมเปลี่ยนไฟล์หากระบุเป็นครั้งแรก หรือเขียนทับปลายทางที่มีอยู่ด้วยปลายทางที่ระบุใหม่ ต้องระบุปลายทางสําหรับการดําเนินการ "REGISTER" คีย์ย่อยสําหรับระบุปลายทางของโปรแกรมเปลี่ยนไฟล์เป็นรูปแบบต่างๆ คือ "endpoint" และค่าคือ URI สตริงสําหรับปลายทาง

ตัวอย่างคําขอ 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 KB เมื่อใช้โควต้าเกินแล้ว PPAPI จะลบสัญญาณออกโดยใช้กลยุทธ์ FIFO กระบวนการย้ายออกจะอนุญาตให้ใช้โควต้าเกินได้เล็กน้อยเป็นระยะเวลาสั้นๆ เพื่อลดความถี่ในการย้ายออก

Signals Encoding API

ผู้ซื้อต้องระบุฟังก์ชัน Java Script เพื่อใช้เข้ารหัสสัญญาณที่เก็บไว้ในอุปกรณ์เพื่อส่งไปยังเซิร์ฟเวอร์ในระหว่างการประมูลที่ได้รับการคุ้มครอง ผู้ซื้อสามารถระบุสคริปต์นี้ได้โดยเพิ่ม URL ที่ดึงข้อมูลได้โดยใช้คีย์ "update_encoder" ในการตอบกลับคําขอ UpdateSignal API สคริปต์จะมีลายเซ็นดังต่อไปนี้

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 ขนาด 4 ไปเป็นรายการออบเจ็กต์ Protected App Signals ออบเจ็กต์ Protected App Signals แต่ละรายการมี 3 ช่อง ได้แก่

• signal_value: UInt8Array ที่แสดงค่าของสัญญาณ
• creation_time: จํานวนที่ใช้แสดงเวลาสร้างสัญญาณเป็นวินาทีตามยุค
• package_name: สตริงที่แสดงชื่อของแพ็กเกจที่สร้างสัญญาณ

พารามิเตอร์ maxSize คือตัวเลขที่อธิบายขนาดอาร์เรย์ที่ใหญ่ที่สุดที่อนุญาตสําหรับเอาต์พุต

ฟังก์ชันควรแสดงผลออบเจ็กต์ที่มี 2 ฟิลด์ ดังนี้

• status: ควรเป็น 0 หากสคริปต์ทำงานสำเร็จ
• results: ควรเป็น UInt8Array ที่มีความยาวน้อยกว่าหรือเท่ากับ maxSize ระบบจะส่งอาร์เรย์นี้ไปยังเซิร์ฟเวอร์ระหว่างการประมูล และเตรียมโดยสคริปต์ prepareDataForAdRetrieval

การเข้ารหัสช่วยให้นักเทคโนโลยีโฆษณามีขั้นตอนเริ่มต้นของการสร้างฟีเจอร์ ซึ่งสามารถเปลี่ยนรูปแบบได้ เช่น การบีบอัดสัญญาณดิบเป็นเวอร์ชันที่ต่อเชื่อมกันตามตรรกะที่กำหนดเอง โปรดทราบว่าระหว่างการประมูลที่ได้รับการปกป้องซึ่งทํางานในสภาพแวดล้อมการดําเนินการที่เชื่อถือได้ (TEE) ตรรกะที่กำหนดเองของเทคโนโลยีโฆษณาจะมีสิทธิ์อ่านเพย์โหลดสัญญาณที่เกิดจากการเข้ารหัส ตรรกะที่กำหนดเองหรือที่เรียกว่าฟังก์ชันที่ผู้ใช้กำหนด (UDF) ซึ่งทำงานใน TEE ของ 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

ในส่วนของอุปกรณ์ การประมูลสัญญาณแอปที่ได้รับการปกป้องจะเหมือนกับการประมูลสําหรับกลุ่มเป้าหมายที่ได้รับการปกป้อง

บริการเสนอราคาและประมูล

API ฝั่งเซิร์ฟเวอร์ ได้แก่

• Protected Auction API: ชุดฟังก์ชัน JS หรือ UDF ที่ผู้ซื้อและผู้ขายสามารถติดตั้งใช้งานในคอมโพเนนต์ B&A ของตนเองเพื่อกำหนดการเสนอราคาและตรรกะการประมูล
• Ad Retrieval API: ผู้ซื้อสามารถใช้ API นี้ได้โดยการใช้ REST Endpoint ที่จะรับผิดชอบในการแสดงชุดโฆษณาที่เป็นผู้สมัครสำหรับการประมูลสัญญาณแอปที่ได้รับการคุ้มครอง

Protected Auction API

Protected Auction API ประกอบด้วย JS API หรือ UDF ที่ผู้ซื้อและผู้ขายสามารถใช้เพื่อใช้ตรรกะการประมูลและการเสนอราคา

UDF เทคโนโลยีโฆษณาของผู้ซื้อ

UDF prepareDataForAdRetrieval

ผู้ซื้อต้องถอดรหัสและเตรียมสัญญาณแอปที่ได้รับการคุ้มครองและข้อมูลอื่นๆ ที่ผู้ขายระบุก่อนจึงจะใช้สัญญาณแอปที่ได้รับการคุ้มครองเพื่อดึงข้อมูลโฆษณาที่ตรงกับเกณฑ์จากบริการการดึงข้อมูลโฆษณา 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 adtech.
function prepareDataForAdRetrieval(encodedOnDeviceSignals,encodedOnDeviceSignalsVersion,sellerAuctionSignals,contextualSignals) {
   return {};
}

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

เอาต์พุตของฟังก์ชันนี้คือราคาเสนอเดียวสําหรับโฆษณาที่มีโอกาสแสดง ซึ่งแสดงเป็น JSON ที่เทียบเท่ากับ ProtectedAppSignalsAdWithBidMetadata ฟังก์ชันนี้ยังแสดงผลอาร์เรย์ 2 รายการที่จะส่งไปยัง reportWin เพื่อเปิดใช้การฝึกโมเดลได้ด้วย (ดูรายละเอียดเพิ่มเติมเกี่ยวกับการส่งออกและการฝึกโมเดลได้ที่ส่วนการรายงานในคำอธิบาย PAS)

UDF reportWin

เมื่อการประมูลสิ้นสุดลง บริการประมูลจะสร้าง URL การรายงานสำหรับผู้ซื้อและลงทะเบียนบีคอนโดยใช้ reportWin UDF (นี่คือฟังก์ชัน reportWin เดียวกับที่ใช้สำหรับ Protected Audience) อุปกรณ์จะส่งคําสั่ง ping เมื่อไคลเอ็นต์แสดงโฆษณา ลายเซ็นของเมธอดนี้เกือบเหมือนกับเวอร์ชันกลุ่มเป้าหมายที่ได้รับการปกป้อง ยกเว้นพารามิเตอร์เพิ่มเติม 2 รายการ ได้แก่ egressPayload และ temporaryUnlimitedEgressPayload ซึ่งใช้เพื่อเปิดใช้การฝึกโมเดลและป้อนข้อมูลผลลัพธ์จาก generateBid

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

UDF เทคโนโลยีโฆษณาของผู้ขาย

UDF ของ scoreAd

ผู้ขายใช้ UDF นี้เพื่อเลือกโฆษณาที่ได้รับจากผู้ซื้อซึ่งจะชนะการประมูล

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

UDF reportResult

UDF นี้ช่วยให้ผู้ขายรายงานระดับเหตุการณ์ได้ (ในที่สุด) พร้อมข้อมูลเกี่ยวกับโฆษณาที่ชนะ

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

Ad Retrieval API

ในรุ่น MVP บริการดึงข้อมูลโฆษณาจะเป็นบริการที่จัดการและโฮสต์โดยผู้ซื้อ และบริการเสนอราคาจะดึงข้อมูลผู้สมัครโฆษณาจากบริการนี้ ตั้งแต่เดือนเมษายน 2024 เป็นต้นไป เซิร์ฟเวอร์การเรียกข้อมูลโฆษณาต้องทำงานในสภาพแวดล้อมการทํางานที่เชื่อถือได้ (TEE) และจะแสดงอินเทอร์เฟซ GRPC/proto บริษัทเทคโนโลยีโฆษณาต้องตั้งค่าเซิร์ฟเวอร์นี้และระบุ URL ของเซิร์ฟเวอร์ดังกล่าวเป็นส่วนหนึ่งของการติดตั้งใช้งานแพลตฟอร์ม B&A การใช้งานบริการนี้ที่ทำงานใน TEE มีอยู่ใน GitHub ของ Privacy Sandbox และเอกสารประกอบที่เหลือจะถือว่านี่คือโค้ดที่ใช้ในการติดตั้งใช้งาน

ตั้งแต่เดือนเมษายน 2024 เป็นต้นไป เวอร์ชัน B&A จะรองรับการเรียกข้อมูลเส้นทางตามบริบท ในกรณีนี้ เซิร์ฟเวอร์การเสนอราคาจะได้รับรายการตัวระบุโฆษณาที่เซิร์ฟเวอร์ RTB ส่งระหว่างการประมูลตามบริบท ระบบจะส่งตัวระบุไปยังเซิร์ฟเวอร์ TEE KV เพื่อดึงข้อมูลทั้งหมดที่เกี่ยวข้องกับโฆษณาที่จะใช้ในขั้นตอนการเสนอราคา (เช่น ad-render-url, ข้อมูลเมตา และการฝังโฆษณาที่จะใช้ในการเลือก Top-K) เส้นทางที่ 2 นี้ไม่จำเป็นต้องมีตรรกะเฉพาะใดๆ ในการใช้งาน ดังนั้นเราจะบันทึกไว้ที่นี่เฉพาะวิธีกำหนดค่า Use Case การเรียกข้อมูลโฆษณาตาม TEE

UDF getCandidateAds

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

สถานที่:

• requestMetadata: JSON ข้อมูลเมตาของเซิร์ฟเวอร์ต่อคําขอไปยัง UDF ยังไม่มีข้อมูลในขณะนี้
• preparedDataForAdRetrieval: เนื้อหาของช่องนี้ขึ้นอยู่กับกลยุทธ์การดึงข้อมูลโฆษณา ในกรณีที่มีการดึงข้อมูลโฆษณาตามบริบท พารามิเตอร์นี้จะมีสัญญาณดิบซึ่งมาจากอุปกรณ์และส่งมาจากบริการเสนอราคา ในกรณีที่มีการดึงข้อมูลโฆษณา TEE โดยใช้เซิร์ฟเวอร์การดึงข้อมูลโฆษณา พารามิเตอร์นี้จะมีผลลัพธ์ของ prepareDataForAdRetrieval UDF หมายเหตุ: ในขั้นตอนนี้ สัญญาณของแอปที่ได้รับการปกป้องจะได้รับการถอดรหัสและไม่มีการเข้ารหัส
• deviceMetadata: ออบเจ็กต์ JSON ที่มีข้อมูลเมตาของอุปกรณ์ที่ส่งต่อโดยบริการโฆษณาของผู้ขาย ดูรายละเอียดเพิ่มเติมในเอกสารประกอบของแบบสอบถาม
  • X-Accept-Language: ภาษาที่ใช้ในอุปกรณ์
  • X-User-Agent: User Agent ที่ใช้ในอุปกรณ์
  • X-BnA-Client-IP: ที่อยู่ IP ของอุปกรณ์
• contextualSignals: สตริงที่กำหนดเองซึ่งมาจากเซิร์ฟเวอร์การเสนอราคาตามบริบทที่ดำเนินการโดย DSP เดียวกัน โดยคาดว่า UDF จะถอดรหัสสตริงและใช้สตริงนั้นได้ สัญญาณตามบริบทอาจมีข้อมูล เช่น ข้อมูลเวอร์ชันโมเดล ML สําหรับการฝังที่ได้รับการปกป้องซึ่งส่งผ่านโดยใช้สัญญาณแอปที่ได้รับการปกป้อง
• contextualAdIds: ออบเจ็กต์ JSON ที่มีรายการรหัสโฆษณา (ไม่บังคับ)

UDF ควรแสดงผลสตริงเมื่อดำเนินการสำเร็จ ระบบจะส่งสตริงกลับไปยังเซิร์ฟเวอร์การเสนอราคา จากนั้นเซิร์ฟเวอร์จะส่งสตริงไปยัง generateBid UDF แม้ว่าสตริงอาจเป็นสตริงธรรมดาๆ แต่ส่วนใหญ่แล้วสตริงควรเป็นออบเจ็กต์ที่แปลงเป็นอนุกรม ซึ่งแต่ละเทคโนโลยีโฆษณาจะกำหนดสคีมาของตนเอง รูปแบบไม่มีข้อจำกัดตราบใดที่generateBid ตรรกะของเทคโนโลยีโฆษณาสามารถจดจำและใช้สตริงได้

ตั้งค่าระบบสําหรับการพัฒนา

Android

หากต้องการตั้งค่าสภาพแวดล้อมการพัฒนา Android คุณต้องทำดังนี้

1. สร้างโปรแกรมจำลอง (แนะนำ) หรืออุปกรณ์จริงที่ใช้ภาพตัวอย่างสำหรับนักพัฒนาแอป 10
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 นั้นมีประโยชน์เช่นกัน แต่ก็ไม่บังคับ

การกําหนดค่า Terraform

หากต้องการใช้สัญญาณแอปที่ได้รับการคุ้มครอง เทคโนโลยีโฆษณาต้องมีคุณสมบัติดังนี้

• เปิดใช้การรองรับ Protected App Signals ใน B&A
• ระบุ URL ปลายทางที่ดึงข้อมูล UDF ใหม่สําหรับ prepareDataForAdRetrieval, generateBid และ reportWin ได้

นอกจากนี้ คู่มือนี้ยังถือว่าเทคโนโลยีโฆษณาที่ต้องการใช้ B&A สําหรับรีมาร์เก็ตติ้งจะยังคงตั้งค่า Flag การกําหนดค่าที่มีอยู่ทั้งหมดสําหรับการประมูลรีมาร์เก็ตติ้งต่อไปตามปกติ

การกำหนดค่าเทคโนโลยีโฆษณาของผู้ซื้อ

โดยใช้ไฟล์เดโมนี้เป็นตัวอย่าง ผู้ซื้อต้องตั้งค่า Flag ต่อไปนี้

• เปิดใช้ Protected App Signals: เปิดใช้เพื่อรวบรวมข้อมูล Protected App Signals
• URL ของ Protected App Signals: ตั้งค่าเป็น URL ของเซิร์ฟเวอร์ Protected App Signals

เทคโนโลยีโฆษณาต้องแทนที่ 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"

การกำหนดค่าเทคโนโลยีโฆษณาของผู้ขาย

โดยใช้ไฟล์ demo นี้เป็นตัวอย่าง ผู้ขายต้องตั้งค่า Flag ต่อไปนี้ (หมายเหตุ: ระบบจะไฮไลต์เฉพาะการกำหนดค่าที่เกี่ยวข้องกับสัญญาณแอปที่ได้รับการคุ้มครองเท่านั้น) เทคโนโลยีโฆษณาต้องตรวจสอบว่าได้แทนที่ 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 และ Ad Retrieval

ระบบจะกำหนดให้ต้องติดตั้งใช้งานอินสแตนซ์ของบริการ KV 1 หรือ 2 รายการ ทั้งนี้ขึ้นอยู่กับกลยุทธ์ที่เลือกเพื่อรองรับการเรียกข้อมูลโฆษณา เราจะเรียกอินสแตนซ์ KV ที่ใช้ในการดึงข้อมูลโฆษณาตาม TEE ว่า Ad Retrieval Server และเรียกอินสแตนซ์ที่รองรับการดึงข้อมูลตามเส้นทางตามบริบทว่า KV Lookup Server

ในกรณีทั้ง 2 นี้ การติดตั้งใช้งานเซิร์ฟเวอร์จะเป็นไปตามเอกสารประกอบที่มีอยู่ใน GitHub ของเซิร์ฟเวอร์ KV ความแตกต่างระหว่าง 2 กรณีคือ กรณีการค้นหาจะใช้งานได้ทันทีโดยไม่ต้องมีการกำหนดค่าเพิ่มเติม ส่วนกรณีการดึงข้อมูลจะต้องติดตั้งใช้งาน getCandidateAds UDF เพื่อใช้ตรรกะการดึงข้อมูล ดูรายละเอียดเพิ่มเติมได้ที่คู่มือการเริ่มต้นใช้งานเซิร์ฟเวอร์ KV โปรดทราบว่า B&A คาดหวังว่าทั้ง 2 บริการจะติดตั้งใช้งานใน Service Mesh เดียวกันกับบริการเสนอราคา

ตัวอย่างการตั้งค่า

พิจารณาสถานการณ์ต่อไปนี้: การใช้ Protected App Signals API เทคโนโลยีโฆษณาจะจัดเก็บสัญญาณที่เกี่ยวข้องตามการใช้แอปของผู้ใช้ ในตัวอย่างนี้ ระบบจะจัดเก็บสัญญาณที่แสดงการซื้อในแอปจากหลายแอป ในระหว่างการประมูล ระบบจะรวบรวมสัญญาณที่เข้ารหัสและส่งไปยังการประมูลที่มีการป้องกันซึ่งทํางานใน B&A UDF ของผู้ซื้อที่ทํางานใน B&A จะใช้สัญญาณเพื่อดึงข้อมูลผู้สมัครโฆษณาและคํานวณราคาเสนอ

ตัวอย่างสัญญาณ [ผู้ซื้อ]

เพิ่มสัญญาณที่มีคีย์เป็น 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

เข้ารหัสสัญญาณแต่ละรายการเป็น 2 ไบต์ โดยไบต์แรกคือไบต์แรกของคีย์สัญญาณ และไบต์ที่ 2 คือไบต์แรกของค่าสัญญาณ

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

[ผู้ซื้อ] ตัวอย่าง UDF สำหรับการดึงข้อมูลโฆษณา

ในตัวอย่างนี้ เซิร์ฟเวอร์การเรียกข้อมูลโฆษณาจะส่งข้อมูลเมตา (เช่น รหัสสําหรับโฆษณาแต่ละรายการในตัวอย่างนี้ แต่อาจมีข้อมูลอื่นๆ สําหรับแต่ละรายการที่เป็นประโยชน์ในการสร้างราคาเสนอในภายหลัง) สําหรับโฆษณาที่ตรงตามเกณฑ์สูงสุด k รายการ

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

[Buyers] generateBid example

/**
 * 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 example

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

[ผู้ขาย] การตั้งค่าเซิร์ฟเวอร์ KV

ผู้ขายต้องตั้งค่าเซิร์ฟเวอร์ KV ของสัญญาณการให้คะแนนเพื่อให้มีการแมปจาก URL การแสดงผลโฆษณาไปยังสัญญาณการให้คะแนนที่เกี่ยวข้อง เช่น หากผู้ซื้อแสดงผล https:/buyer-domain.com/get-fitness-app และ https:/buyer-domain.com/get-fastfood-app ผู้ขายอาจมีการตอบกลับสัญญาณการให้คะแนนตัวอย่างต่อไปนี้เมื่อ SFE ค้นหาโดยใช้ GET ใน https://key-value-server-endpoint.com?client_type=1&renderUrls=<render-url-returned-by-the-buyer>

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

[Seller] scoreAd example

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

[Seller] ตัวอย่าง reportResult

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

แอปตัวอย่าง

เราได้สร้างแอปตัวอย่างสัญญาณแอปที่ได้รับการปกป้องไว้ในที่เก็บตัวอย่างนี้เพื่อเป็นตัวอย่างการใช้ API เพื่อสร้างแอปที่ใช้ขั้นตอนง่ายๆ ตามที่อธิบายไว้ข้างต้น