Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Ad → List Advertisements.

AI-generated

Summary

Retrieve a list of advertisements associated with a specified Player from the Infomaniak VOD API, with options to paginate, limit results, or return only the total count.

Inputs

  • Authentication (required) — Select authentication method to use, either OAuth2 or API Key.
  • Player (required) — The unique identifier of the Player whose advertisements to list.
  • Additional Query Parameters — Optional pagination and filtering parameters: 'Return' to specify if only total count should be returned; 'Page' to select the page number; 'Per Page' to define number of items per page.
  • Return All — Boolean option to determine whether to return all advertisements across all pages or limit the number of items retrieved.
  • Limit — Maximum number of advertisements to return if 'Return All' is false; valid range is 1 to 500.
  • Return Full Response — Boolean option to return the entire API response rather than just the data items.

Output shape

a list of advertisement records or a numeric total count, optionally limited by pagination parameters; or the full API response object if selected

Setting 'Return' parameter to 'total' returns only the number of advertisements instead of the items. Pagination parameters ('Page' and 'Per Page') control the slice of data returned when not returning all items. Use 'Return Full Response' to get the entire response for advanced use cases.

Examples

Example 1: Fetch all advertisements for a player with OAuth2 authentication

Set Authentication to OAuth2, enter Player ID, set Return All to true.

Example 2: Retrieve only the first 50 advertisements on page 2 via API Key

Set Authentication to API Key, enter Player ID, disable Return All, set Limit to 50, set Additional Query Parameters 'Page' to 2.

Example 3: Get only the total count of advertisements for a player

Enter Player ID, under Additional Query Parameters set 'Return' to 'total'.

Links

Discussion