Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: Added scope parameter for advertisingId #188

Merged
merged 2 commits into from
Oct 10, 2023
Merged

feature: Added scope parameter for advertisingId #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7378936
feature: Added scope.type and scope.id option parameters for advertis…
kevinshahfws Oct 4, 2023
ee06d13
Addressed review comments
kevinshahfws Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

84 changes: 83 additions & 1 deletion src/openrpc/advertising.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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"
}
}
}
]
},
Expand Down Expand Up @@ -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"
}
}
}
}
}
}
}
Expand Down