Class default

Typed client for platform-served game advertising.

These endpoints manage publisher inventory displayed around playable games; they are intentionally separate from APIs used to buy advertising campaigns.

Index

Constructors

Methods

adminDashboard adminProviderApps adminStoreRevenue adminUpdateSettings adminUpsertProviderApp createSession inGamePlacements replaceInGamePlacements revenueSummary settings storeEvent updateSettings

Constructors

constructor

new default(): default
Returns default

Methods

`Static` adminDashboard

adminDashboard<T>(): AxiosPromise<default<T>>
Return site-admin delivery settings, aggregate metrics, and recent revenue.
Type Parameters
- T
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:105

`Static` adminProviderApps

adminProviderApps<T>(): AxiosPromise<default<T>>
Return public provider app keys and platform mappings for site admins.
Type Parameters
- T
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:120

`Static` adminStoreRevenue

adminStoreRevenue<T>(data): AxiosPromise<default<T>>
Import or reconcile one provider revenue report row.
Type Parameters
- T
Parameters
- data: object
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:115

`Static` adminUpdateSettings

adminUpdateSettings<T>(data): AxiosPromise<default<T>>
Partially update platform-wide providers and delivery frequency.
Type Parameters
- T
Parameters
- data: object
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:110

`Static` adminUpsertProviderApp

adminUpsertProviderApp<T>(data): AxiosPromise<default<T>>
Create or update a provider app mapping without accepting report secrets.
Type Parameters
- T
Parameters
- data: GameAdProviderApp
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:125

`Static` createSession

createSession<T>(title_id, data): AxiosPromise<default<T>>
Resolve ad eligibility and create an expiring provider manifest/session.
Type Parameters
- T
Parameters
- title_id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:80

`Static` inGamePlacements

inGamePlacements<T>(title_id): AxiosPromise<default<T>>
Return every intrinsic-ad surface configured for a title.
Type Parameters
- T
Parameters
- title_id: string
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:95

`Static` replaceInGamePlacements

replaceInGamePlacements<T>(title_id, placements): AxiosPromise<default<T>>
Atomically replace a title's provider-neutral intrinsic-ad surfaces.
Type Parameters
- T
Parameters
- title_id: string
- placements: GameInGameAdPlacement[]
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:100

`Static` revenueSummary

revenueSummary<T>(title_id, params?): AxiosPromise<default<T>>
Return developer-visible estimated/finalized earnings and delivery totals.
Type Parameters
- T
Parameters
- title_id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:90

`Static` settings

settings<T>(title_id): AxiosPromise<default<T>>
Return developer-visible ad-earnings settings for a title.
Type Parameters
- T
Parameters
- title_id: string
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:70

`Static` storeEvent

storeEvent<T>(title_id, session_id, data): AxiosPromise<default<T>>
Store one normalized, idempotent event for an advertising session.
Type Parameters
- T
Parameters
- title_id: string
- session_id: string
- data: GameAdEventPayload
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:85

`Static` updateSettings

updateSettings<T>(title_id, data): AxiosPromise<default<T>>
Update developer ad-earnings activation and optional title provider ID.
Type Parameters
- T
Parameters
- title_id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in src/api/GameAdvertising.ts:75

Generated using TypeDoc