เริ่มต้นใช้งาน

ข้อกำหนดเบื้องต้น

คุณต้องมีสิ่งต่อไปนี้เพื่อผสานรวมและทดสอบ PAL SDK สำหรับแคสต์

เนื่องจากคุณต้องอัปเดตแอปตัวรับสัญญาณเพื่อผสานรวมกับ PAL SDK เท่านั้น คุณจึงต้องดำเนินการต่อไปนี้ สามารถใช้เครื่องมือควบคุมและคำสั่งแคสต์ (CAC) เป็นผู้ส่งเว็บเพื่อทดสอบรีซีฟเวอร์ของคุณ

คุณสามารถเรียกใช้ตัวอย่างเมื่อสิ้นสุดแต่ละขั้นตอนโดยการเปิดตัวเว็บเป็นครั้งแรก แอปตัวรับสัญญาณใน CAC เครื่องมือ แล้วสร้างคำขอโหลด

สร้าง Nonce

"ผลกระทบ" เป็นสตริงที่เข้ารหัสเพียงสตริงเดียวซึ่ง PAL สร้างขึ้นผ่าน NonceManager NonceManager สร้างขึ้นโดย loadNonceManager ของ NonceLoader ตามการตั้งค่าที่ส่งมาใน NonceRequest หากต้องการดู แอปตัวอย่างที่ใช้ PAL ในการสร้าง Nonce ดาวน์โหลดตัวอย่าง Cast จาก GitHub

คำขอสตรีมใหม่แต่ละรายการต้องมีค่า Nonce ใหม่ คำขอโฆษณาหลายรายการภายใน สตรีมเดียวกันสามารถใช้ค่า Nonce เดียวกันได้ หากต้องการสร้างค่า Nonce โดยใช้ PAL SDK ก่อนอื่นให้ สร้างเว็บรีซีฟเวอร์ที่กำหนดเอง แอป และเพิ่มโค้ดต่อไปนี้

receiver.html

<!DOCTYPE html>
<html>
<head>
  <script src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/pal/sdkloader/cast_pal.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <footer>
    <script src="js/receiver.js" type="module"></script>
  </footer>
</body>
</html>

องค์ประกอบ <cast-media-player> แสดง UI โปรแกรมเล่นในตัวที่ให้บริการโดย Cast Web Receiver API โปรแกรมเล่นวิดีโอที่ใช้จริงขึ้นอยู่กับประเภทสตรีม อาจแตกต่างกันไป คุณสามารถดูเวอร์ชันที่แน่นอนของโปรแกรมเล่นเหล่านี้ได้ใน Google Cast บันทึกประจำรุ่นของ SDK

จากนั้น ให้เพิ่มโค้ดต่อไปนี้เพื่อสกัดกั้น LOAD กิจกรรม และสร้าง Nonce ทุกครั้งที่ตัวรับโหลด MediaInformation ออบเจ็กต์:

js/receiver.js

const castContext = cast.framework.CastReceiverContext.getInstance();
const playerManager = castContext.getPlayerManager();

const consentSettings = new goog.cast.pal.ConsentSettings();
// For the correct usage of the allowStorage property, See
// developers.google.com/ad-manager/pal/cast/reference/js/ConsentSettings#allowStorage.
consentSettings.allowStorage = true;

// You need a nonce loader to request your stream's nonceManager. The
// nonceManager provides your nonce. You should reuse the same nonce loader for
// the entire lifecycle of the receiver.
const nonceLoader = new goog.cast.pal.NonceLoader(consentSettings);

// You need a reference to the NonceManager to track when an ad is shown or
// clicked.
let nonceManager;

/**
 * Sends a debug message to the CAF sender.
 *
 * @param {String} message - The message to send
 */
const log = (message) => {
  // Use CastDebugLogger to log a message to the sender. See
  // https://developers.google.com/cast/docs/debugging/cast_debug_logger.
}

/**
 * Stores the nonce manager in the outer scoped variable and retrieves a nonce,
 * so it can be used to build your ad request URL
 *
 * @param {NonceManager} loadedNonceManager - The loaded nonce manager
 */
const buildAdRequest = (loadedNonceManager) => {
  nonceManager = loadedNonceManager;

  const nonce = nonceManager.getNonce();
  log('received nonce:' + nonce);

  // TODO: Set this nonce as the value for the `givn` parameter of your ad
  // request URL. For example:
  // const adRequestURL = 'https://myadserver.com/ads?givn=' + nonce;
}

/**
 * Configures a new nonce request, then requests a nonce.
 *
 * @param {LoadRequestData} loadRequestData - the load request object,
 * which contains the MediaInformation object from the sender. See
 * developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.LoadRequestData
 * @return {(Promise<LoadRequestData>)} - A Promise to build an ad request.
 */
const handleLoadRequest = (loadRequestData) => {
  // Clear any old nonceManager before loading new media.
  nonceManager = null;

  // See developers.google.com/ad-manager/pal/cast/reference/js/NonceRequest
  // for details about each property. The NonceRequest parameters set here are
  // example parameters. You should set your parameters based on your own app
  // characteristics.
  const nonceRequest = new goog.cast.pal.NonceRequest();
  nonceRequest.adWillAutoPlay = true;
  // A URL describing the video stream.
  nonceRequest.descriptionUrl = 'https://example.com';
  nonceRequest.iconsSupported = true;
  nonceRequest.ppid = 'Sample PPID';
  nonceRequest.sessionId = 'Sample SID';
  nonceRequest.url = loadRequestData.media.contentUrl;
  // The height of the player in physical pixels.
  // For a fullscreen player on a 1080p screen, the video height would be 1080.
  nonceRequest.videoHeight = window.devicePixelRatio * window.screen.height;
  // The width of the player in physical pixels.
  // For a fullscreen player on a 1080p screen, the video width would be 1920.
  nonceRequest.videoWidth = window.devicePixelRatio * window.screen.width;

  return nonceLoader.loadNonceManager(nonceRequest)
    .then(buildAdRequest)
    .catch((e) => {
      log("Error: " + e.message);
    });
};

// Set up the event handler for the LOAD event type.
playerManager.setMessageInterceptor(cast.framework.messages.MessageType.LOAD, handleLoadRequest);

castContext.start();

เมื่อเรียก VAST โดยตรง (DVC) ให้ตั้งค่า Nonce นี้เป็นค่าใน พารามิเตอร์ givn ค่าที่ได้จากการสุ่มคือ URL ที่ปลอดภัย คุณไม่จำเป็นต้องเข้ารหัส URL

ติดตามการโต้ตอบกับวิดีโอ

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

js/receiver.js

const castContext = cast.framework.CastReceiverContext.getInstance();
const playerManager = castContext.getPlayerManager();

const consentSettings = new goog.cast.pal.ConsentSettings();
// For the correct usage of the allowStorage property, See
// developers.google.com/ad-manager/pal/cast/reference/js/ConsentSettings#allowStorage.
consentSettings.allowStorage = true;

// You need a nonce loader to request your stream's nonceManager. The
// nonceManager provides your nonce. You should reuse the same nonce loader for
// the entire lifecycle of the receiver.
const nonceLoader = new goog.cast.pal.NonceLoader(consentSettings);

// You need a reference to the NonceManager for sending ad events.
let nonceManager;

// Track playback status.
let playbackDidStart = false;

...

// Register the start of playback.
playerManager.addEventListener(cast.framework.events.EventType.PLAYING, () => {
  if (playbackDidStart) return;

  playbackDidStart = true;
  if (nonceManager) {
    log('Registered playback start');
    nonceManager.sendPlaybackStart();
  } else {
    log("Error: There is no nonce manager for this media.");
  }
});

// Register any interactions with the player.
const interactionEvents = [
  cast.framework.events.EventType.REQUEST_SEEK,
  cast.framework.events.EventType.REQUEST_STOP,
  cast.framework.events.EventType.REQUEST_PAUSE,
  cast.framework.events.EventType.REQUEST_PLAY,
  cast.framework.events.EventType.REQUEST_SKIP_AD,
  cast.framework.events.EventType.REQUEST_PLAY_AGAIN,
  cast.framework.events.EventType.REQUEST_PLAYBACK_RATE_CHANGE,
  cast.framework.events.EventType.REQUEST_VOLUME_CHANGE,
  cast.framework.events.EventType.REQUEST_USER_ACTION,
  cast.framework.events.EventType.REQUEST_FOCUS_STATE,
];
playerManager.addEventListener(interactionEvents, (interactionEvent) => {
  if (nonceManager) {
    log('Registered interaction: ' + interactionEvent);
    nonceManager.sendAdTouch(interactionEvent);
  } else {
    log("Error: There is no nonce manager for this media.");
  }
});

// Register the end of playback.
playerManager.addEventListener(cast.framework.events.EventType.MEDIA_FINISHED, () => {
  playbackDidStart = false;
  if (nonceManager) {
    log('Registered playback end');
    nonceManager.sendPlaybackEnd();
  } else {
    log("Error: There is no nonce manager for this media.");
  }
});

castContext.start();

(ไม่บังคับ) ส่งสัญญาณ Google Ad Manager ผ่านเซิร์ฟเวอร์โฆษณาบุคคลที่สาม

กำหนดค่าคำขอของเซิร์ฟเวอร์โฆษณาบุคคลที่สามสำหรับ Ad Manager หลังจากที่คุณ โปรดทำตามขั้นตอนต่อไปนี้ พารามิเตอร์ Nonce จะเผยแพร่จาก PAL SDK ผ่านเซิร์ฟเวอร์ตัวกลาง จากนั้นไปยัง Google Ad Manager วิธีนี้ช่วยให้ การสร้างรายได้ผ่าน Google Ad Manager ได้ดีขึ้น

กำหนดค่าเซิร์ฟเวอร์โฆษณาบุคคลที่สามให้รวมค่า Nonce ไว้ใน ไปยัง Ad Manager ต่อไปนี้เป็นตัวอย่างแท็กโฆษณาที่กำหนดค่าภายในแท็ก เซิร์ฟเวอร์โฆษณาบุคคลที่สาม:

'https://pubads.serverside.net/gampad/ads?givn=%%custom_key_for_google_nonce%%&...'

โปรดดูรายละเอียดเพิ่มเติมที่การใช้งานฝั่งเซิร์ฟเวอร์ของ Google Ad Manager

Ad Manager จะมองหา givn= เพื่อระบุค่า Nonce โฆษณาของบุคคลที่สาม เซิร์ฟเวอร์ต้องรองรับมาโครของตนเอง เช่น %%custom_key_for_google_nonce%% และแทนที่ด้วยพารามิเตอร์การค้นหา Nonce ที่คุณให้ไว้ในขั้นตอนก่อนหน้า ข้อมูลเพิ่มเติมเกี่ยวกับวิธีดำเนินการนี้ มีอยู่ในเอกสารประกอบของเซิร์ฟเวอร์โฆษณาบุคคลที่สาม