Infomaniak Streaming Video icon

Infomaniak Streaming Video

Interact with Infomaniak Streaming Video API

Actions92

Players > Ads → Return An Ads

AI-generated

Summary

Return ads for a specified channel, player, and ads resource.

Inputs

  • authentication — Authentication method: OAuth2 or API Key.
  • path_channel (required) — Unique identifier (ID) of the channel to request.
  • path_player (required) — Unique identifier (ID) of the player to request.
  • path_ads (required) — Unique identifier (ID) of the ads to request.
  • queryParameters — Additional query parameters; optional 'query_with' to load related resources.
  • returnFullResponse — If true, the full API response is returned; otherwise only ads data.

Output shape

a list of ad items

Response contains the requested ad data; when returnFullResponse is true the entire API response is returned, which may include pagination or metadata.

Examples

Example 1: Fetch ads for channel 5, player 12, ads 3 using OAuth2 authentication.

authentication: OAuth2; path_channel: 5; path_player: 12; path_ads: 3; returnFullResponse: false

Example 2: Retrieve full response for channel 1, player 2, ads 7 using API Key.

authentication: API Key; path_channel: 1; path_player: 2; path_ads: 7; returnFullResponse: true

Example 3: Request additional related data via query_with parameter.

authentication: OAuth2; path_channel: 4; path_player: 9; path_ads: 2; query_with: "related_resource"; returnFullResponse: false

Links

Discussion