- Overview
- Key terms
- Integrations requirements checklist
- Authentication
- Set up a campaign
- Select jobs
- Make campaign predictions
- Add campaign details
- Review the campaign
- Manage campaigns
- Campaign performance reporting
- Brand and logo guidelines
- Logo (clear background)
- Logo (white background)
- Logo colors
- Sizing
- Space and dimensions
- Don’t
- Indeed description
- Support
- Other resources
Sponsored Jobs API integration guide for UI elements
UI elements for your Sponsored Jobs integration.
Unless you have a written agreement with Indeed regarding your use of Indeed's APIs, by using this API or its documentation, you agree to apply the Indeed API Terms and the Additional API Terms and Guidelines to your use of Indeed's APIs.
Overview
This guide shows ATS partners the UI patterns used to build an Indeed Sponsored Jobs integration. Ads launched through this integration appear on both Indeed and Glassdoor.
Key terms
- applies
Noun. Applications submitted by a job seeker.
- applicant tracking system (ATS)
- Human resources software that stores and manages job applicant data.
- budget
- The amount of money an Indeed customer spends to advertise jobs, usually each month.
- campaign
- Synonym: Sponsorship
- A job post or group of job posts that an Indeed client pays to sponsor. A multijob campaign contains more than one job post, but most enterprise campaigns today are single-job campaigns with one job post.
- click
Noun. An event in which a job seeker selects a job post.
- objective
- An outcome that an employer selects when setting up a campaign. For more information, see What is an Objective-based Campaign?
- organic
- Synonym: Free
- The opposite of sponsored. For example, a free job post can be called an organic job. Outcomes from a free post can be called organic clicks or organic applies.
- partner
- A person or group that implements a Sponsored Jobs integration. This documentation is written for that audience.
- prediction
- Synonyms: Expected outcome, performance estimate
- Expected performance. Indeed predicts performance for jobs and campaigns based on the budget.
- report
- Performance data for one or more campaigns tied to a client's job, campaign, or group of campaigns. Reports include metrics such as impressions and clicks.
- schedule
- Synonyms: Date range, duration
- The time period when a campaign runs.
- sponsored
- Synonyms: Paid, ads
- An Indeed product, service, or outcome that a user pays for. For example:
Sponsored jobs are paid job advertisements. Outcomes from sponsored jobs include sponsored clicks and sponsored applies.
- user
- A person who uses the Sponsored Jobs integration.
Integrations requirements checklist
As you build your integration, review these requirements:
| Requirement | |
|---|---|
☐ | Do you provide a flow to create an employer account? |
☐ | Do you prompt users to complete account setup on Indeed? For example: Your sponsored campaign is not active until you set up billing with Indeed. Sign in at https://billing.indeed.com with your Indeed account to enter your billing information. |
☐ | Do you include a link to Account settings on Indeed? |
☐ | Do you tell clients that they can view analytics for organic jobs by setting up an Indeed account? |
☐ | Do you follow all Indeed brand and logo guidelines? |
☐ | Do you include a link to Indeed Analytics reports? |
☐ | Do you show campaign predictions when a user enters a campaign budget? (US only) |
☐ | Do you tell clients that campaign predictions are estimates based on past performance and do not guarantee future performance? (US only) |
☐ | Do you provide a one-click option to select the budget recommended by the campaign predictions tool? (US only) |
☐ | Do you provide a logical flow for clients to create, edit, and review campaign reports? |
☐ | Do you tell clients to contact Indeed through this form if they need support? |
☐ | Is the Sponsored Jobs integration prominently featured in your UI and marketplace with Indeed branding and logos and its own landing page? |
☐ | Does the Indeed-branded sponsorship button appear in a logical place in the client workflow? |
Authentication
The Sponsored Jobs API uses OAuth to determine which accounts, permissions, and monthly budget a recruiter has on Indeed. To use the API, the user must have an Indeed account.
This authentication flow verifies that the account is ready to spend before the user can spend money on sponsored jobs.
To set up OAuth, see Authorization code grant type (3-legged OAuth).
- If the user does not have an account, create the account inside the ATS.
- Tell users that a sponsored campaign does not become active until they set up billing with Indeed. To do that, they sign in at https://billing.indeed.com with their Indeed account and enter billing information.
- Include a link to Indeed Account settings for later updates.
- Tell clients that setting up an Indeed account lets them view analytics for organic jobs.
- Both parent and child accounts can sign in through the ATS.
- Users must manage individual user permissions on Indeed, not in the ATS.
When a user authenticates with OAuth, the flow looks like this:
Set up a campaign
After the user has an Indeed account, the user creates a campaign:
| 1. | |
| 2. | |
| 3. | |
| 4. |
Select jobs
-
Select the jobs to include in a campaign. The API supports both single-job and multijob campaigns.
This example shows how an ATS lets the user select and sponsor one job at a time:
ATS enables the user to select and sponsor one job at a time This example shows how multijob selection appears on Indeed:
Multijob selection on Indeed -
Select a button to continue.
Make campaign predictions
Campaign prediction requirements apply only in the US.
Based on the selected jobs, Indeed recommends a budget and predicts how many applicants the user can expect during a specific time period.
Show these predictions while the user sets the budget. This example shows predictions and recommendations on Indeed before the budget is set:
This example shows the prediction feature after the user sets a budget:
Always show a warning that these numbers are estimates based on past performance and do not guarantee future performance.
Add campaign details
After the user selects jobs, the user must enter a few details to create a campaign.
The details screen appears on Indeed:
To create a campaign, the user sets the start date, end date, and budget.
A one-click option lets the user select the budget suggested by the prediction tool. You can also let the user enter a custom budget.
By default, Indeed creates a one-time campaign. The user can also create a recurring campaign that renews automatically each month. For a recurring campaign, the user can also prorate the first month's spend.
Review the campaign
After the user selects jobs and enters campaign details, provide a summary screen so the user can review and edit the choices.
This example shows the campaign review screen on Indeed:
Manage campaigns
Users must be able to edit these campaign details:
- Campaign start and end dates for single-job and multijob campaigns
- Budget amounts for single-job and multijob campaigns
- Job selection for multijob campaigns only
If the user edits the campaign on Indeed, the ATS automatically reflects the changes.
Campaign performance reporting
Reporting views on Indeed show how the user's budget is spent over time and how many applicants are delivered.
If your integration supports only single-job campaigns, provide campaign-level reporting. If your integration supports multijob campaigns, provide both campaign-level and job-level reporting.
The campaign reports API provides:
- Campaign name and ID
- Organic metrics
- Apply starts
- Clicks
- Impressions
- Conversions, when Indeed Apply is integrated
- Cost, which is the amount of budget already spent
The job reports API provides:
- Campaign ID
- Job title and reference number
- Organic metrics
- Apply starts
- Clicks
- Impressions
- Conversions, when Indeed Apply is integrated
- Cost, which is the amount of budget already spent
This example shows how Indeed displays reporting for multijob campaigns:
Brand and logo guidelines
Logo (clear background)
Logo (white background)
Logo colors
The Indeed logo can appear in Brand Blue, #003a9b, or white. The preferred treatments are Brand Blue on white or white on Brand Blue.
Use the version that creates the strongest visual contrast with the background and fits the overall design.
Sizing
Minimum size
14px height for digital
10pt height for print
Margin
To preserve clarity and visual integrity, the logo requires clear space.
Use the “e” in the Indeed logotype as the measurement guide for clear space around the logo so that the space stays proportional at every size.
Space and dimensions
To balance visual layouts, align the Indeed logo to the letterforms of the wordmark and ignore the arch above the lowercase i.
Apply this rule for centered and right-aligned layouts. Align the logo with major elements such as shapes, text, and buttons.
Don’t
- Alter the logo.
- Squeeze or stretch the logotype.
- Tilt or warp the logotype.
- Violate clear space rules.
- Change the alignment of lockup text.
- Place the logo over a busy image.
- Add a drop shadow to the logotype.
- Fill the logotype with imagery.
- Change the color of the logotype to any color other than the approved colors.
Indeed description
Short description
Indeed helps millions of job seekers and employers find the right fit every day.
Long description
Indeed is the world's #1 job site,1 with more than 250 million unique visitors each month2 and sites in more than 60 countries. By providing access to talent across many fields, Indeed helps employers of every size find and hire the right people.
When you integrate with Indeed, you improve the hiring process, improve the job seeker experience, and help employers hire faster. When you opt in to the Indeed integration, external jobs that you create or update in your ATS are sent directly to Indeed through an XML feed. This helps ensure that your most current job content appears in free3 search results. If you need more visibility or want to reach more quality candidates, you can pay to promote job postings on Indeed.
To learn more about how Indeed helps millions of job seekers and employers find the right fit every day, visit Hire faster.
1. Comscore, Total Visits, 2021-03 2. Google Analytics, Unique Visitors, 2020-02 3. Terms, conditions, quality standards and usage limits applySupport
Clients can get support on the Contact Indeed page.
Other resources
For a summary of the information in this topic, see Indeed Sponsored Jobs API UI Guidelines.