AdService
Ad breaks for guests: the host app asks whether to fill a break point the game declared.
On this page
Ad breaks for guests: games declare natural breaks (between rounds, on respawn, back in the lobby, between places), and the host app asks the platform whether to fill one. The platform decides: only guests see ad breaks (signed-in players never do), only house ads (contextual, no tracking: guests are treated as the youngest age band), at most one per 10 minutes of play (counted here, per guest and per device, never on the client's word), and only while the guest is in the session the break is for. Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.
Summary#
| Method | Auth | Description |
|---|---|---|
| RequestAdBreak | Account or guest | |
| FinishAdBreak | Account or guest | The ad finished (the viewer continued, or it was closed): recorded for the counts. |
Methods#
RequestAdBreak#
POST /neo.platform.v1.AdService/RequestAdBreak
Content-Type: application/jsonAuth: A signed-in account or a guest.
Request: RequestAdBreakRequest. Response: RequestAdBreakResponse.
FinishAdBreak#
The ad finished (the viewer continued, or it was closed): recorded for the counts.
POST /neo.platform.v1.AdService/FinishAdBreak
Content-Type: application/jsonAuth: A signed-in account or a guest.
Request: FinishAdBreakRequest. Response: FinishAdBreakResponse.
Types#
FinishAdBreakRequest#
| Field | Type | Description |
|---|---|---|
breakId | string |
FinishAdBreakResponse#
No fields: send {}.
RequestAdBreakRequest#
| Field | Type | Description |
|---|---|---|
sessionId | string | the session the caller is playing in (SessionService.Join) |
kind | string | "break": a break point the game declared; "preroll": while the game loads |
breakPoint | string | what the game called the moment: round_end, respawn, lobby, teleport,... ([a-z0-9_], up to 40 characters; contextual information only) |
RequestAdBreakResponse#
| Field | Type | Description |
|---|---|---|
show | boolean | show an ad now |
breakId | string | when shown: this break's id (FinishAdBreak) |
reason | string | when not shown, why: signed_in (accounts see no ad breaks), capped (an ad in the last 10 minutes of play), not_in_session |
nextAllowedAt | string | the earliest time another break may be shown (RFC 3339); empty when signed in |
seconds | number | how long the ad runs, in seconds (house ads: 5) |