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 24 days ago
The Reporting API can be used to manage your campaigns and review the configuration details of your events and ad sets.
Prerequisites
You must authenticate with the API, following the steps here.- For information on retrieving reporting data through the Reporting API, see Reporting API - Advertiser.
- For information on error handling and limitations with the Reporting API, see 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 typequery { advertiser { adSets(first: 50) { edges { node { id bidding { amount } campaign { objective } } } pageInfo { endCursor hasNextPage } } } }
{ "data": { "advertiser": { "adSets": { "edges": [ { "node": { "id": "00000000-0000-0000-0000-000000000000", "bidding": { "amount": 0.02 }, "campaign": { "objective": "VIEWS" } } }, { "node": { "id": "00000000-0000-0000-0000-000000000001", "bidding": { "amount": 0.04 }, "campaign": { "objective": "VIEWS" } } } ], "pageInfo": { "endCursor": "Mg==", "hasNextPage": false } } } } }
Change the Bid of an Ad Set
Note
The bid amount returned is represented in micros (1/1,000,000th of a US dollar). For more information, see the Money scalar type documentation.
mutation { updateAdSetBidding(input: { id: "00000000-0000-0000-0000-000000000000", bidding: {amount: 1000000} }) { bidding { amount } } }
{ "data": { "bidding": { "amount": 1000000 } } }
Manage Your Multi-Reward Events
See 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.
{ adSet(id: "00000000-0000-0000-0000-000000000000") { multiRewardEngagementSettings { events { eventName eventValue amount } } } }
{ "data": { "adSet": { "multiRewardEngagementSettings": [ { "events": [ { "eventName": "level_#", "eventValue": "5", "amount": 0 }, { "eventName": "level_#", "eventValue": "10", "amount": 480000 }, } ] } ] } } }
Create and Delete Multi-Reward Events
Note
Creating and deleting MultiRewardEngagementEvents is done in a single mutation. You must provide an AdSet ID as well as a list of at least two MultiRewardEngagementEvents. To disable an event, add the disable: true attribute. eventName and eventValue are still required when disabling events to prevent accidental deletions.
mutation { updateAdSetBidding( input:{ id: "00000000-0000-0000-0000-000000000000" bidding: { multiRewardEngagementEvents: [ { eventName:"TUTORIAL_COMPLETE", eventValue: "", amount: 2200000 }, { eventName:"LEVEL_ONE", eventValue: "", amount: 12200000 }, { eventName:"LEVEL_TWO", eventValue: "", disable: true } ] } } ) { bidding { multiRewardEngagementEvents { eventName eventValue amount } } } }
{ "data": { "updateAdSetBidding": { "bidding": { "multiRewardEngagementEvents": [ { "eventName": "TUTORIAL_COMPLETE", "eventValue": "", "amount": 2200000 }, { "eventName": "LEVEL_ONE", "eventValue": "", "amount": 12200000 } ] } } } }
Manage Your App Specific Configuration
See 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
Any non-publisher-app-specific event configurations will be listed under the null app.
{ adSet(id: "00000000-0000-0000-0000-000000000000") { multiRewardEngagementSettings { app { bundleId } events { eventName eventValue amount } } } }
{ "data": { "adSet": { "multiRewardEngagementSettings": [ { "app": null, "events": [ { "eventName": "level_#", "eventValue": "5", "amount": 0 }, { "eventName": "level_#", "eventValue": "10", "amount": 480000 }, ] }, { "app": { "bundleId": "com.app.example" }, "events": [ { "eventName": "level_#", "eventValue": "10", "amount": 520000 }, { "eventName": "level_#", "eventValue": "30", "amount": 1680000 }, ] } ] } } }
Create and Delete Per-App Event Configurations
Note
Similar to MultiRewardEngagementEvents, creating and deleting AppBiddingGroups is done in a single mutation. You must provide at least one publisher AppReference ID as well as a list of at least two MultiRewardEngagementEvents. The amount for these events will be used in place of the top-level configured values when a conversion happens inside the given publisher AppReference.
mutation { updateAdSetBidding( input:{ id: "00000000-0000-0000-0000-000000000000" bidding: { perAppBidGroups: [{ pubAppId:"<example_publisher_app_id>" multiRewardEngagementEvents: [ { eventName:"TUTORIAL_COMPLETE", eventValue: "", amount: 5500000 }, { eventName:"LEVEL_ONE", eventValue: "", disable: true, } ] }, { pubAppId:"<example_publisher_app_id_2>", disable: true }], multiRewardEngagementEvents: [ { eventName:"TUTORIAL_COMPLETE", eventValue: "", amount: 2200000 }, { eventName:"LEVEL_ONE", eventValue: "", amount: 12200000 }, { eventName:"LEVEL_TWO", eventValue: "", disable: true } ] } } ) { bidding { multiRewardEngagementEvents { eventName eventValue amount } perAppBidGroups { pubApp { id name } } multiRewardEngagementEvents { eventName eventValue amount } } } }
{ "data": { "updateAdSetBidding": { "bidding": { "multiRewardEngagementEvents": [ { "eventName": "TUTORIAL_COMPLETE", "eventValue": "", "amount": 2200000 }, { "eventName":"LEVEL_ONE", "eventValue": "", "amount": 12200000 } ], "perAppBidGroups": [ { "pubApp": { "id": "example_publisher_app_id", "name": "Example Publisher App" }, "multiRewardEngagementEvents": [ { "eventName": "TUTORIAL_COMPLETE", "eventValue": "", "amount": 5500000 }, { "eventName": "LEVEL_ONE", "eventValue": "", "amount": 15500000 } ] } ] } } } }