Skip to main content

Offer

Formatted offer retrieved from the Targeted API.

type Offer {
  id: String!
  campaign_id: Int!
  name: String!
  tracking_type: String!
  total_payout_usd: Float!
  total_amount: Float!
  start_datetime: String!
  is_multi_reward: Boolean!
  completion_difficulty: Int!
  is_featured_campaign: Boolean!
  creatives: OfferCreatives!
  goals: [OfferGoal]!
  links: OfferLinks!
  campaign_vertical: String
  store_id: String
  updated_at: String
}

Fields​

Offer.id ● String! non-null scalar​

Offer version unique identifier.

Example: "123456789012345678"

Offer.campaign_id ● Int! non-null scalar​

Unique identifier of this Offer.

Example: 123456

Offer.name ● String! non-null scalar​

Offer name.

Example: "Great App"

Offer.tracking_type ● String! non-null scalar​

Offer tracking type. You'll get one of the following values: 'CPC', 'CPA', 'CPE' or 'CPI'.

Example: "CPC"

Offer.total_payout_usd ● Float! non-null scalar​

The amount of USD earned for completing a single offer or completing all goals for multi-reward.

Example: 0.25

Offer.total_amount ● Float! non-null scalar​

The amount of virtual currency awarded to the user for fully completing an offer. This is calculated according to the campaign payout and the exchange rate set in the AdGem Publisher Dashboard for the offerwall.

Example: 25

Offer.start_datetime ● String! non-null scalar​

The datetime this offer is set to be active.

Example: "2018-05-24 16:34:45"

Offer.is_multi_reward ● Boolean! non-null scalar​

Indicates if this offer is multi-reward or single reward:

  • true: multi-reward
  • false: single reward

Example: true

Offer.completion_difficulty ● Int! non-null scalar​

The difficulty level for completing an offer.

Example: 1

Offer.is_featured_campaign ● Boolean! non-null scalar​

Indicates if an offer is featured.

Example: true

Offer.creatives ● OfferCreatives! non-null object​

Contains the offer creatives.

Offer.goals ● [OfferGoal]! non-null object​

Contains a list of offer goals.

Offer.links ● OfferLinks! non-null object​

Contains offer links.

Offer.campaign_vertical ● String scalar​

The vertical to which this offer belongs.

Example: "Games General"

Offer.store_id ● String scalar​

The Google Play or App Store unique namespace or package name.

Example: "com.example.app"

Offer.updated_at ● String scalar​

The datetime this offer was last updated.

Example: "2025-02-12T18:48:02.000000Z"

Returned By​

offers query