Advertisers: Overview

As an Advertiser, Tapjoy's GraphQL API allows you to programmatically manage your campaigns, enabling you to more effectively and efficiently reach your audience.

Data Model

As part of the GraphQL API, Tapjoy is introducing a campaign-based data model. At a high level:

  • A Campaign defines your objective (what you're trying to accomplish) and contains one or more Ad Sets

  • An Ad Set defines your audience (who you're targeting, how, when, where) and contains one or more Ads

  • An Ad defines your content (what your users will see)

For more information about how to migrate from legacy APIs and Dashboard concepts to the GraphQL API, refer to the Upgrade Guide.

Note only parts of campaign management are currently available. We will be rolling out more functionality over the coming months.

Getting Started / Quick Start

  1. Get keys: To gain access to the GraphQL API you need to request your API keys. This is explained in the requesting access section of the Getting Started page.

  2. Authentication: To authenticate you must send a POST request with a header containing your API keys. More about authentication can be found in the authentication section of the Getting Started page.

  3. Query: To make a GraphQL request use one of the examples as a reference.

All advertiser-related data can be accessed via the advertiser GraphQL query. This root-level query gives you access to list all campaigns, ad sets, etc. that are tied to your account.

Additionally, the following queries and mutations can be used for management of your campaigns:

For examples on how to use these queries / mutations, please refer to the Examples documentation.