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

Add THEOads iOS docs #213

Merged
merged 10 commits into from
Feb 18, 2025
Merged

Add THEOads iOS docs #213

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6bd4076
Add getting started guide for THEOads on iOS
Feb 12, 2025
6baf1c3
Add link to THEOads API reference
Feb 13, 2025
75e180d
Revert "Add link to THEOads API reference"
Feb 14, 2025
f5f3e65
Remove API reference for now until it becomes available in 8.12.0
Feb 14, 2025
b858650
Update THEOads api
tjtheo Feb 14, 2025
0558ea6
Update THEOads API sidebar
tjtheo Feb 14, 2025
73a8448
Make cocoapods the default
Feb 14, 2025
0b42385
Fix THEOads API sidebar
tjtheo Feb 14, 2025
2b046e2
Add override layout and ad tag parameter specific documentation for iOS
Feb 18, 2025
6c7a480
Add real override layout values
Feb 18, 2025
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
207 changes: 168 additions & 39 deletions theoads/api/ads-client.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@
"requestBodies": {},
"responses": {},
"schemas": {
"MonetizedStreamType": {
"enum": [
"LIVE",
"VOD"
],
"type": "string"
},
"MonetizedStreamLayout": {
"enum": [
"SINGLE",
Expand All @@ -26,6 +33,9 @@
"streamId": {
"type": "string"
},
"streamType": {
"$ref": "#/components/schemas/MonetizedStreamType"
},
"origin": {
"type": "string"
},
Expand Down Expand Up @@ -100,6 +110,9 @@
"version": {
"type": "string"
},
"streamType": {
"$ref": "#/components/schemas/MonetizedStreamType"
},
"origin": {
"type": "string"
},
Expand Down Expand Up @@ -152,6 +165,15 @@
},
"assetURI": {
"type": "string"
},
"asset_key": {
"type": "string"
},
"network_code": {
"type": "string"
},
"backdropURI": {
"type": "string"
}
},
"required": [
Expand Down Expand Up @@ -403,6 +425,41 @@
"type": "object",
"additionalProperties": false
},
"IOverlaysApiResponse": {
"properties": {
"id": {
"type": "string"
},
"state": {
"type": "string",
"enum": [
"created",
"deleted"
]
},
"type": {
"type": "string",
"enum": [
"overlay"
],
"nullable": false
},
"payload": {
"items": {
"$ref": "#/components/schemas/IOverlay"
},
"type": "array"
}
},
"required": [
"id",
"state",
"type",
"payload"
],
"type": "object",
"additionalProperties": false
},
"IStatus": {
"properties": {
"status": {
Expand Down Expand Up @@ -445,7 +502,7 @@
},
"info": {
"title": "THEOads Api",
"version": "24.11.6",
"version": "25.2.0",
"description": "The THEOads REST API allows you to create and manage monetized streams, which are deployments of signaling services. Each monetized stream corresponds to an origin stream that is monetized using THEOads (SGAI). For detailed information on the various parameters and their usage, please refer to the getting started guide.",
"license": {
"name": "UNLICENSED"
Expand Down Expand Up @@ -620,6 +677,59 @@
]
}
},
"/monetized-streams/{monetizedStreamId}/layout": {
"patch": {
"operationId": "UpdateMonetizedStreamLayout",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IMonetizedStreamApiResponse"
}
}
}
}
},
"description": "Updates the default layout for an existing monetized stream (signaling service).",
"tags": [
"Monetized-Stream"
],
"security": [],
"parameters": [
{
"description": "The Monetized stream identifier.",
"in": "path",
"name": "monetizedStreamId",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The layout configuration",
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"layout": {
"$ref": "#/components/schemas/MonetizedStreamLayout"
}
},
"required": [
"layout"
],
"type": "object",
"description": "The layout configuration"
}
}
}
}
}
},
"/monetized-streams/{monetizedStreamId}/break": {
"post": {
"operationId": "CreateMonetizedStreamBreak",
Expand Down Expand Up @@ -678,7 +788,7 @@
}
}
},
"description": "Retrieves all adbreaks linked to the monetized sctream",
"description": "Retrieves all adbreaks linked to the monetized stream",
"tags": [
"Monetized-Stream"
],
Expand Down Expand Up @@ -711,7 +821,7 @@
}
}
},
"description": "Deletes an adbreaks linked to the monetized sctream",
"description": "Deletes an adbreak linked to the monetized stream",
"tags": [
"Monetized-Stream"
],
Expand All @@ -737,22 +847,22 @@
]
}
},
"/monetized-streams/{monetizedStreamId}/layout": {
"patch": {
"operationId": "UpdateMonetizedStreamLayout",
"/monetized-streams/{monetizedStreamId}/overlay": {
"post": {
"operationId": "CreateMonetizedStreamOverlay",
"responses": {
"200": {
"description": "OK",
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IMonetizedStreamApiResponse"
"$ref": "#/components/schemas/IOverlayApiResponse"
}
}
}
}
},
"description": "Updates the default layout for an existing monetized stream (signaling service).",
"description": "Creates an overlay on an existing monetized stream (signaling service).",
"tags": [
"Monetized-Stream"
],
Expand All @@ -769,33 +879,56 @@
}
],
"requestBody": {
"description": "The layout configuration",
"description": "The overlay configuration",
"required": true,
"content": {
"application/json": {
"schema": {
"properties": {
"layout": {
"$ref": "#/components/schemas/MonetizedStreamLayout"
}
},
"required": [
"layout"
],
"type": "object",
"description": "The layout configuration"
"$ref": "#/components/schemas/IOverlay",
"description": "The overlay configuration"
}
}
}
}
},
"get": {
"operationId": "GetMonetizedStreamOverlays",
"responses": {
"200": {
"description": "A monetized stream",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IOverlaysApiResponse"
}
}
}
}
},
"description": "Retrieves all overlays linked to the monetized stream",
"tags": [
"Monetized-Stream"
],
"security": [],
"parameters": [
{
"description": "The Monetized stream identifier.",
"in": "path",
"name": "monetizedStreamId",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/monetized-streams/{monetizedStreamId}/overlay": {
"post": {
"operationId": "CreateMonetizedStreamOverlay",
"/monetized-streams/{monetizedStreamId}/overlay/{overlayId}": {
"delete": {
"operationId": "DeleteMonetizedStreamOverlay",
"responses": {
"201": {
"description": "Created",
"200": {
"description": "A monetized stream",
"content": {
"application/json": {
"schema": {
Expand All @@ -805,7 +938,7 @@
}
}
},
"description": "Creates an overlay on an existing monetized stream (signaling service).",
"description": "Deletes an overlay linked to the monetized stream",
"tags": [
"Monetized-Stream"
],
Expand All @@ -819,20 +952,16 @@
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The overlay configuration",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IOverlay",
"description": "The overlay configuration"
}
},
{
"in": "path",
"name": "overlayId",
"required": true,
"schema": {
"type": "string"
}
}
}
]
}
},
"/status": {
Expand Down
30 changes: 27 additions & 3 deletions theoads/api/signaling/sidebar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ const sidebar: SidebarsConfig = {
label: "UpdateMonetizedStream",
className: "api-method patch",
},
{
type: "doc",
id: "api/signaling/update-monetized-stream-layout",
label: "UpdateMonetizedStreamLayout",
className: "api-method patch",
},
{
type: "doc",
id: "api/signaling/delete-monetized-stream",
Expand All @@ -46,6 +52,18 @@ const sidebar: SidebarsConfig = {
label: "CreateMonetizedStreamBreak",
className: "api-method post",
},
{
type: "doc",
id: "api/signaling/get-monetized-stream-breaks",
label: "GetMonetizedStreamBreak",
className: "api-method get",
},
{
type: "doc",
id: "api/signaling/delete-monetized-stream-breaks",
label: "DeleteMonetizedStreamBreak",
className: "api-method delete",
},
{
type: "doc",
id: "api/signaling/create-monetized-stream-overlay",
Expand All @@ -54,9 +72,15 @@ const sidebar: SidebarsConfig = {
},
{
type: "doc",
id: "api/signaling/update-monetized-stream-layout",
label: "UpdateMonetizedStreamLayout",
className: "api-method patch",
id: "api/signaling/get-monetized-stream-overlays",
label: "GetMonetizedStreamOverlay",
className: "api-method get",
},
{
type: "doc",
id: "api/signaling/delete-monetized-stream-overlay",
label: "DeleteMonetizedStreamOverlay",
className: "api-method delete",
},
],
},
Expand Down
Binary file added theoads/assets/img/theoads-ios-swiftpm-menu-google.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theoads/assets/img/theoads-ios-swiftpm-menu.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theoads/assets/img/theoads-ios-swiftpm-product-selection-google.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theoads/assets/img/theoads-ios-swiftpm-product-selection.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added theoads/assets/img/theoads-ios-xcode-file-menu.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading