Skip to main content

offers

Retrieve all targeted offers.

offers(
  player_id: String!
  filters: RetrievalFilters
  sort: String
  limit: Int
  language: String
): [Offer]

Arguments​

offers.player_id ● String! non-null scalar​

Unique identifier of the player/user in your app.

offers.filters ● RetrievalFilters input​

offers.sort ● String scalar​

Sort by a field in an ascending or descending direction. Allowed sorting options are:

  • 'epc.asc'
  • 'epc.desc'
  • 'last_activation.asc'
  • 'last_activation.desc'

offers.limit ● Int scalar​

The maximum number of offers to return. If not specified, no limit is applied.

offers.language ● String scalar​

The language to use for the offer content. Language codes use ISO format. If not specified or the language is not supported, defaults to 'en' by using a fallback logic. The fields affected by this parameter are:

  • creatives.basic_requirements.description
  • creatives.description
  • creatives.instructions
  • goals.description
  • goals.name

The available languages to localize offers are:

  • 'en' (English)
  • 'de' (German)
  • 'zh-HK' (Chinese - Hong Kong)
  • 'zh-TW' (Chinese - Taiwan)

Type​

Offer object​

Formatted offer retrieved from the Targeted API.