@glomex/integration-web-component 1.1386.1 → 1.1387.1

package/dist/index.d.ts

@@ -277,6 +277,67 @@ export declare class ExternalMediaItemElement extends HTMLElement implements Med
     get data(): MediaItem;
 }
 
+/**
+ * Additional application, device and user information that can be passed via {@link IntegrationElement#extraContext extraContext} to the integration.
+ * Intended to improve monetization.
+ */
+export declare interface ExtraContext {
+    /**
+     * The presentational context of the integration. Do not define it when it is not part of those contexts.
+     */
+    presentationalContext?: 'curated-list' | 'discovery-page';
+    /**
+     * The version of the app. When it is a website, fill in the deployed version of the website.
+     */
+    appVersion?: string;
+    userIds?: ExtraContextUserId[];
+    /**
+     * The bundle id of the app. Only required for iOS apps.
+     */
+    appBundleId?: string;
+    /**
+     * The store id of the app. Only required for apps. Depending on the app store, the id is formatted differently.
+     * {@link https://iabtechlab.com/wp-content/uploads/2020/08/IAB-Tech-Lab-OTT-store-assigned-App-Identification-Guidelines-2020.pdf IAB Tech Lab App Identification Guidelines}
+     */
+    appStoreId?: string;
+    /**
+     * The store URL of the app. Only required for apps.
+     * {@link https://iabtechlab.com/wp-content/uploads/2020/08/IAB-Tech-Lab-OTT-store-assigned-App-Identification-Guidelines-2020.pdf IAB Tech Lab App Identification Guidelines}
+     */
+    appStoreUrl?: string;
+    b2bContext?: string;
+    deviceId?: ExtraContextDeviceId;
+}
+
+/**
+ * Device id of the user. Only required for app environments. When no listed deviceId is available, you can pass a ppid {@link ExtraContextUserId}.
+ */
+export declare interface ExtraContextDeviceId {
+    id: string;
+    name: 'aaid' | 'afai' | 'asia' | 'asid' | 'tifa' | 'vaid' | 'idfa' | 'idfv' | 'lgudid' | 'msai' | 'oaid' | 'psnai' | 'rida' | 'vida' | 'waid';
+}
+
+/**
+ * User id of the user that can be passed additionally to the integration. It improves the monetization.
+ *
+ * @example When you want to forward envelopes for liveramp, you can pass them within ext
+ * ```ts
+ * const envelopes = [['envelopeId1', 'envelopeId2']];
+ * const userId = {
+ *    id: envelopes.[0]?.[1],
+ *    name: 'liverampId',
+ *    ext: {
+ *      envelopes
+ *    }
+ * }
+ * ```
+ */
+export declare interface ExtraContextUserId {
+    id: string;
+    name: 'netId' | 'sevenPassId' | 'ppid' | 'utiqId' | 'liverampId';
+    ext?: Record<string, unknown>;
+}
+
 export declare function getIntegrationCssUrl(integrationId: string): string;
 
 /**
@@ -404,6 +465,7 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      * @attribute crossorigin
      */
     crossorigin?: IntegrationProperties['crossorigin'];
+    extraContext?: ExtraContext;
     /**
      * Optional callback function invoked when the integration fails to load an advertisement.
      * The callback receives an object with a `reason` property that explains why no ad was loaded.
@@ -964,10 +1026,6 @@ export declare interface IntegrationProperties {
      * This can be a simple string or a stringified JSON object. If it is a stringified JSON object, its contents are forwarded as `placementDetail`. If the object contains a property key `name`, its value will be tracked for the placement attribute.
      */
     placement?: string;
-    /**
-     * Allows the publisher to provide an optional ppid (publisher provided user id) attribute, which supplies additional contextual information for enhanced analytics tracking.
-     */
-    ppid?: string;
     env?: 'stage' | 'local';
     variant?: string;
     /**
@@ -977,6 +1035,10 @@ export declare interface IntegrationProperties {
      * for the loaded media files, though text-tracks from foreign origins then cannot be loaded.
      */
     crossorigin?: '' | 'anonymous' | 'use-credentials' | 'none';
+    /**
+     * An optional context object that can be used to pass additional application, device and user information to the integration.
+     */
+    extraContext?: ExtraContext;
 }
 
 export declare enum KnownMarkerName {
@@ -1120,7 +1182,7 @@ export declare interface MediaItem {
      */
     hasProductPlacement?: boolean;
     /**
-     * Channel of the media item.
+     * Channel (or often referred to as brand) of the media item.
      */
     channel?: Channel;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1386.1",
+  "version": "1.1387.1",
   "description": "Web component and types to integrate the glomex player",
   "documentation": "https://docs.glomex.com",
   "homepage": "https://glomex.com",
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@glomex/integration": "^1.1386.1",
+    "@glomex/integration": "^1.1387.1",
     "@microsoft/api-extractor": "^7.52.10",
     "@rslib/core": "^0.11.2",
     "typescript": "^5.8.3"
@@ -39,5 +39,5 @@
     "access": "public"
   },
   "license": "MIT",
-  "gitHead": "f4f298554a49d5e9d8e7f9ce1a933788daa649a6"
+  "gitHead": "9877d981a54eee4542fe67c5ae70cec9ac8d64d3"
 }