IntimateMerger Analytics Adapter : initial release

[eknis]

Type of change

• Bugfix

• Feature

• New bidder adapter

• Updated bidder adapter

• Code style update (formatting, local variables)

• Refactoring (no functional changes, no api changes)

• Build related changes

• CI related changes

• Does this change affect user-facing APIs or examples documented on http://prebid.org?

• Other

Description of change

Other information

[github-actions]

Tread carefully! This PR adds 1 linter error (possibly disabled through directives):

• modules/imAnalyticsAdapter.js (+1 error)

[github-actions]

Tread carefully! This PR adds 1 linter error (possibly disabled through directives):

• modules/imAnalyticsAdapter.js (+1 error)

[github-actions]

Tread carefully! This PR adds 1 linter error (possibly disabled through directives):

• modules/imAnalyticsAdapter.js (+1 error)

[fecker]

ちともろもろ確認したいのと、意識合わせしたいです。

各社のAnalytics Adaptor は、bid の分析をもろもろしているのですが、
IMでは不要なので、そのあたりは調整が必要かなと。

今の実装ならキャッシュは不要な気がしつつ、バッファリング送信機能をつけるなら必要になるかなと思っています。

• AUCTION_INIT
  • cache の初期化（auctionId の管理用）
  • Consent データの初期化 （auctionId に紐づけて管理）
  • pvデータのみを送信（ちょっと悩み中。データとして使わないなら、ぶっちゃけまとめて送ってもいいかも？ 調整中）
• AUCTION_END
  • setTimeout で遅延実行（800 ms くらい？）
    • cache[auctionId] に入ってるものを送る
    • cache[auctionId] で、データ送信フラグ を管理
  • setTimeout で遅延実行（3分後くらい？）
    • cache[auctionId] を削除する
      − SPA でたまらないようにする
• BID_WON
  • cache[auctionId] に 情報を蓄積する
  • データ送信済だったら（フラグがたってたら）全データを再送する

実装イメージ

case EVENTS.AUCTION_END:
  setTimeout(() => {
    analyticsAdapter.sendEvents(args.auctionId);
  }, BID_WON_WAIT); // 800ms ?
  break;

こんなことを書いてる Adaptor がいるので、バッファリングいけるんじゃないかと思ってます。

case EVENTS.BID_WON:
  const auction = cache.auctions[args.auctionId];
  if (!auction) return;

  // transactionId 単位で、cache するか
  // 配列に push した方が楽かもしれない

  // 再送を考えて、Timestamp も入れてもいいかも

  if (auction.sendStatus & REQUEST_SENT) { // すでに送信済だったら
     analyticsAdapter.sendEvents(args.auctionId); // 再送する
  }

みたいな感じでいけたりしないかなぁと思ってきました。

許諾のデータは、
libraries/intentIqUtils/getCmpData.js を参考にして
gdpr と usp (ccpa) だけとっておくと幸せになれるかなとおもってきました。

import { allConsent } from '../../src/consentHandler.js';

/**
 * Retrieves consent data from the Consent Management Platform (CMP).
 * @return {Object} An object containing the following fields:
 * - `gdprString` (string): GDPR consent string if available.
 * - `uspString` (string): USP consent string if available.
 * - `gppString` (string): GPP consent string if available.
 */
export function getCmpData() {
  const consentData = allConsent.getConsentData();

  return {
    gdprApplies: consentData?.gdpr?.gdprApplies || false,
    gdprString: typeof consentData?.gdpr?.consentString === 'string' ? consentData.gdpr.consentString : null,
    uspString: typeof consentData?.usp === 'string' ? consentData.usp : null,
    gppString: typeof consentData?.gpp?.gppString === 'string' ? consentData.gpp.gppString : null,
  };
}

[eknis]

時刻 0ms:   AUCTION_INIT
            ↓ sendStatus = 0
時刻 100ms: BID_WON #1
            ↓ sendStatus & WON_SENT = 0 → キャッシュに追加
時刻 200ms: BID_WON #2
            ↓ sendStatus & WON_SENT = 0 → キャッシュに追加
時刻 300ms: AUCTION_END
            ↓ 800msタイマー開始
時刻 1100ms: sendWonBidsData() 実行
             ↓ BID_WON #1, #2 をまとめて送信
             ↓ sendStatus |= WON_SENT → sendStatus = 1
時刻 1500ms: BID_WON #3（遅延）
             ↓ sendStatus & WON_SENT = 1 → 即座に個別送信
時刻 2000ms: BID_WON #4（遅延）
             ↓ sendStatus & WON_SENT = 1 → 即座に個別送信

[github-actions]

Tread carefully! This PR adds 2 linter errors (possibly disabled through directives):

• modules/imAnalyticsAdapter.js (+2 errors)

[github-actions]

Tread carefully! This PR adds 2 linter errors (possibly disabled through directives):

• modules/imAnalyticsAdapter.js (+2 errors)

[github-actions]

Tread carefully! This PR adds 2 linter errors (possibly disabled through directives):

• modules/imAnalyticsAdapter.js (+2 errors)