Campaign management
Manage your ad campaigns using Tapjoy's Reporting API to review and update ad set configurations, bid amounts, event settings, and app‑specific settings so you can optimize campaign performance.
Read time 3 minutesLast updated a month ago
Use the Reporting API can to manage your campaigns and review the configuration details of your events and ad sets.
Note
After you enable a campaign and ad set, you can edit only bid amounts in the ad set. For instructions, refer to CPE bid management. To make other changes to your live campaign, contact your account manager.
Prerequisites
You must authenticate with the API, following the steps here.
- For information on retrieving reporting data through the Reporting API, refer to Reporting API - Advertiser.
- For information on error handling and limitations with the Reporting API, refer to Reporting API Best Practices.
Manage your ad sets
Review the details of your ad set configuration, such as bid amounts, targeting data, and campaign status.
References: Advertiser#adSets field, AdSet type
The following query returns up to 50 ad sets with their IDs, bid amounts, and campaign objectives.
query { advertiser { adSets(first: 50) { edges { node { id bidding { amount } campaign { objective } } } pageInfo { endCursor hasNextPage } } }}
Change the bid of an ad set
Note
The bid amount returned is represented in micros (0.0001% of a US dollar). For more information, refer to the Money scalar type documentation.
References: AdSetBiddingUpdateInput type
The following mutation updates the bid amount for a specific ad set. Specify the ad set ID and the new bid amount in micros.
mutation { updateAdSetBidding(input: { id: "00000000-0000-0000-0000-000000000000", bidding: {amount: 1000000} }) { bidding { amount } }}
Manage your multi-reward events
Refer to event level information for your Multi-Reward offers, including bid amounts, event names, and event linearity.
Note
All events on an ad set will be returned, regardless of bid amount, status, or number of conversions.
References: MultiRewardEngagementEvent type
The following query returns all events configured for a specific ad set, including event names, values, and bid amounts.
{ adSet(id: "00000000-0000-0000-0000-000000000000") { multiRewardEngagementSettings { events { eventName eventValue amount } } }}
Manage your app specific configuration
Refer to event level information for Multi-Reward offers with publisher app specific bidding enabled. This will return event information such as bid amounts, event names, and event linearity, separated out by publisher app.
Note
The response lists any non-publisher-app-specific event configurations will under the null app.
References: MultiRewardEngagementEvent type, AppReference type
The following query returns multi-reward event configurations for a specific ad set, grouped by publisher app. Events not tied to a specific app are listed under a null app entry.
{ adSet(id: "00000000-0000-0000-0000-000000000000") { multiRewardEngagementSettings { app { bundleId } events { eventName eventValue amount } } }}