feature: Added scope parameter for advertisingId (#188)

* feature: Added scope.type and scope.id option parameters for advertisingId api * Addressed review comments
rdkcentral · Oct 10, 2023 · c1a6b84 · c1a6b84
1 parent 4dbbab3
commit c1a6b84
Showing 1 changed file with 83 additions and 1 deletion.
diff --git a/src/openrpc/advertising.json b/src/openrpc/advertising.json
@@ -158,7 +158,16 @@
         }
       ],
       "summary": "Get the advertising ID",
-      "params": [],
+      "params": [
+        {
+          "name": "options",
+          "summary": "AdvertisingId options",
+          "required": false,
+          "schema": {
+            "$ref": "#/components/schemas/AdvertisingIdOptions"
+          }
+        }
+      ],
       "result": {
         "name": "advertisingId",
         "summary": "the advertising ID",
@@ -192,6 +201,50 @@
               "lmt": "0"
             }
           }
+        },
+        {
+          "name": "Getting the advertising ID with scope browse",
+          "params": [
+            {
+              "name": "options",
+              "value": {
+                "scope": {
+                  "type": "browse",
+                  "id": "paidPlacement"
+                }
+              }
+            }
+          ],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
+              "ifa_type": "idfa",
+              "lmt": "0"
+            }
+          }
+        },
+        {
+          "name": "Getting the advertising ID with scope content",
+          "params": [
+            {
+              "name": "options",
+              "value": {
+                "scope": {
+                  "type": "content",
+                  "id": "metadata:linear:station:123"
+                }
+              }
+            }
+          ],
+          "result": {
+            "name": "Default Result",
+            "value": {
+              "ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
+              "ifa_type": "idfa",
+              "lmt": "0"
+            }
+          }
         }
       ]
     },
@@ -322,6 +375,35 @@
             "description": "The authentication provider, when it is separate entity than the app provider, e.g. an MVPD."
           }
         }
+      },
+      "AdvertisingIdOptions": {
+        "title": "AdvertisingIdOptions",
+        "type": "object",
+        "properties": {
+          "scope": {
+            "type": "object",
+            "description": "Provides the options to send scope type and id to select desired advertising id",
+            "required": [
+              "type",
+              "id"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "browse",
+                  "content"
+                ],
+                "default": "browse",
+                "description": "The scope type, which will determine where to show advertisement"
+              },
+              "id": {
+                "type": "string",
+                "description": "A value that identifies a specific scope within the scope type"
+              }
+            }
+          }
+        }
       }
     }
   }