ATSパートナー向けSponsored Jobs API連携ガイド

キャンペーン予測やオーガニック求人のパフォーマンスと予測などのプライベートエンドポイントにアクセスします。

 

法的注意

Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。

概要

このガイドは、ATSパートナー向けSponsored Jobs APIリファレンスと併せてお読みください。このガイドは、ATSパートナーがSponsored Jobs APIに連携する際に役立ちますが、すべてのエンドポイントを説明するものではありません。

このガイドと公開APIドキュメントでは、employerとadvertiserはいずれもIndeedで求人をスポンサーするユーザーを指します。技術的な質問は、marketplacesupport@indeed.comに送信してください。

プログラムの概要

プログラム向けにATSをセットアップするをご覧ください。

プロトタイプを設計するときは、最初にユーザー体験フローを計画してください。

ユーザー体験フロー

ATSには、雇用主アカウントを作成するフローと、広告キャンペーンを作成および管理するフローの2つを構築します。

新しい雇用主アカウントのセットアップフロー

Indeedを利用する各雇用主には、Indeedアカウントが1つ必要です。また、ATSが雇用主に代わって操作できるよう認可するプライマリアカウント管理者が必要です。この手順は、雇用主ごとに1回実施します。雇用主は複数のATSユーザーを持つことができますが、スポンサーキャンペーン用のIndeedアカウントは1つだけです。雇用主は、このセットアップが完了するまでキャンペーンを作成できません。

1. 雇用主のアカウント管理者が、Indeedへのサインインに使用する企業メールアドレスを入力します。
2. ATSが、Indeedでセットアップを完了するよう促します。
3. Indeedアカウントのセットアップが完了したら、Indeed OAuthを通じてATSシステムを認可するために、アカウント管理者をリダイレクトします。
4. ATSを認可した後、ATS内のユーザーの役割に応じて、どのATSユーザーアカウントが雇用主のIndeedアカウントを使用してスポンサーキャンペーンを作成できるかを、管理者が設定できるようにします。

実装の詳細については、雇用主アカウントをセットアップするをご覧ください。

キャンペーンの作成と管理のフロー

マーケットプレイス、求人パフォーマンスレビュー、分析ページなど、プラットフォーム内で最も適した場所にIndeedの広告体験を表示します。

認可されたATSユーザーがATS内からIndeedのスポンサー求人キャンペーンを直接作成および管理できるようにするには、APIエンドポイントを使用します。

ユーザーは次の操作を実行できます。

1. 各求人キャンペーンの予算と期間を設定する。
2. 求人ごとに採用目標を設定し、Indeedから推奨を受け取る。
3. Indeedの利用規約に同意する。
4. 必要に応じてIndeedに問い合わせる。

キャンペーンを管理する

認可されたATSユーザーが次の操作を実行できるようにします。

1. ATS内で次の基本的なIndeedアナリティクスを表示する。

   • 料金、応募数、クリック数、インプレッション数
   • 詳細を確認するためのIndeedダッシュボードへのリンク

2. ATSで作成したキャンペーンを終了するか、予算を追加する。

連携の詳細については、Sponsored Jobs APIの概要をご覧ください。

プログラム向けにATSをセットアップする

ATSパートナーとしてSponsored Jobs APIの利用を開始するには、次のセットアップ手順に従ってください。構築中に質問がある場合は、marketplacesupport@indeed.comにメールを送信してください。

プログラム向けにATSをセットアップする

手順	説明
1.	IndeedとDeveloper Agreementを締結する。
2.	ATSのメールアドレスでIndeedアカウントを作成する。
3.	Indeedがユーザーを送信するATS内のリダイレクトURLを特定する。
4.	連携を開始する。
5.	Indeedにデモ動画を送信する。
6.	メッセージングについてIndeedと連携する。

IndeedとDeveloper Agreementを締結する

貴社がIndeedと、Sponsored Jobs Integration APIsおよびReferral Partnershipの条件を含むDeveloper Agreementを締結していることを確認してください。

締結していない場合は、marketplacesupport@indeed.comにメールを送信して依頼してください。

Indeedアカウントを作成して連携を登録する

ATS会社のメールアドレスを使用してIndeedアカウントを作成します。このアカウントは、OAuth認可とATS連携の登録にのみ使用してください。以降、クライアントの雇用主アカウントをIndeedで管理するには、このメールアドレスとアカウントを使用してください。

また、雇用主アカウントのセットアップに必要な一意のATS識別子を依頼するため、marketplacesupport@indeed.comにメールを送信してください。

When you become an Indeed partner, Indeed sets up an app for your integration. Sign in to Partner Console to view your app and OAuth credentials (client ID, secret, and authorization code for 3-legged OAuth). Exchange credentials for an access token to authenticate API calls.

Indeedがユーザーを送信するリダイレクトURLを特定する

ユーザーが雇用主アカウントのセットアップを完了した後に、IndeedがATSに送信するために使用するATSのリダイレクトURLを選択してください。

連携を開始する

これで連携を開始できます。API連携の概要をご覧ください。

テストするには、クライアントアカウントとして動作する別のIndeedアカウントを作成します。Indeedアカウントの作成に使用したものとは異なるメールアドレスを使用してください。

• このアカウントで$50の予算を使用し、さまざまなUX機能をテストします。
• Indeedは、連携が機能することを確認できるよう、貴社の実際の求人に対するスポンサー求人クリックを最大$200まで負担します。この返金は、この1つのアカウントに対する1回限りの提供です。
• 成功をIndeedが確認できるよう、テストに使用するメールアドレスをIndeedからのメールに返信してください。

連携を構築するときは、ブランドおよびロゴのガイドラインに従ってください。

Indeedにデモ動画をメールで送信する

連携のデモをmarketplacesupport@indeed.comにメールで送信してください。

Subject: New ATS-SJI API Approval Request

Body:

ATS Name:

Product Contact:

BD/Marketing Contact:

Redirect URL (from Step 4):

UX Video:

Indeedは48時間以内に返信し、承認または変更依頼を行います。

メッセージングについてIndeedと連携する

クライアントの利用開始を支援するメッセージングについてIndeedと連携し、新機能を案内できるようにしてください。未解決の質問がある場合は、marketplacesupport@indeed.comにメールを送信してください。

API連携の概要

雇用主向けにSponsored Jobs APIを呼び出す前に、雇用主がIndeedアカウントを持ち、APIを雇用主に代わって呼び出すためのOAuth認可をシステムに付与していることを確認してください。

これらの手順を処理するには、前提条件を完了してください。

連携の前提条件

Sponsored Jobs APIの呼び出しを開始する前に、次の手順を完了してください。

1. 雇用主アカウントをセットアップする。
2. 各雇用主からOAuth認可を取得する。

雇用主アカウントをセットアップする

各新規雇用主に対して次の手順を完了し、Indeedでスポンサーするためのアカウントがセットアップされていることを確認してください。

ステップ1

適切なアクセス権と情報を持つ管理者ユーザーに、Indeedでスポンサー設定とオンボーディングを完了するよう求めるダイアログ、または同様のUIを表示します。このダイアログでは、ユーザーに企業メールアドレスの入力を求めます。

ステップ2

ユーザーをIndeedアカウントセットアップエンドポイントに送信します。このエンドポイントは、アカウントの準備状況を確認し、必要なセットアップ手順がある場合はユーザーに案内します。

エンドポイントは次のとおりです。

https://ats-management.indeed.com/accountsetup

このエンドポイントに対して、次のパラメーターを指定したHTTP GETリクエストを送信します。

雇用主アカウントをセットアップする

フィールド	必須	説明
__email	✓	Indeedでスポンサーに使用する、URLエンコードされたメールアドレス。
ak	✓	Indeedが各ATSパートナーに割り当てる一意のID。パートナーがIndeedに紹介する雇用主アカウントを識別します。
state		ATSに変更されずに返される文字列です。リクエストを識別するキーとして使用します。1〜100文字の英数字である必要があります。
type		次のいずれかです。 login Indeedアカウントの作成後に停止し、残りのスポンサーセットアップをスキップします。オーガニック求人のパフォーマンスと予測エンドポイントの最小要件を満たすために使用します。 詳細については、スポンサーなしのセットアップをご覧ください。 パラメーターを省略する 雇用主に完全なセットアップフローを実行させます。

Indeedアカウントセットアップエンドポイントは、管理者ユーザーをリダイレクトし、雇用主がIndeedでスポンサーに対応できる状態かどうかを確認するために再利用できます。プロセスは軽量です。すべての確認に合格した場合、呼び出しはすぐに返り、追加のユーザー操作は発生しません。

このエンドポイントは、次のアカウント準備状況チェックを実行します。

• 指定された企業メールアドレスのIndeedアカウントがIndeedを利用できる状態になっていること
• ユーザーがIndeedにサインインしていること
• 雇用主アカウントがスポンサーに対応するようセットアップされていること
• 請求情報がスポンサー用に設定されていること
• ユーザーが雇用主アカウントへのフルアクセス権を持っていること

いずれかの確認に失敗した場合、Indeedはユーザーを適切なセットアップページにリダイレクトし、セットアップ完了後に再度確認を実行します。

セカンダリユーザーの場合、アクセス可能な雇用主アカウントのうち少なくとも1つが確認に合格する必要があります。

ステップ3

セットアップ手順を完了すると、Indeedは指定されたリダイレクトURLを使用してユーザーをATSにリダイレクトします。Indeedのオンボーディングプロセス完了後にIndeedがユーザーをリダイレクトするATS側のリダイレクトURLを作成する必要があります。

エンドポイントが対応する必要があるパラメーター

フィールド	説明
state	このフィールドに渡した値を、APIがそのまま返します。
result	値は次のいずれかです。 OK ユーザーがアクセスできる雇用主アカウントのうち、少なくとも1つがすべての確認に合格しました。 INVALID_EMAIL_FORMAT メールアドレスの形式が正しくありません。 INVALID_STATE_PARAMETER stateパラメーターの形式が正しくありません。 INVALID_TYPE_PARAMETER typeパラメーターの値が無効です。受け付ける値はloginのみです。 EMAIL_CHANGE_REQUESTED ユーザーが、プライマリIndeedアカウントとして別の企業メールアドレスを使用したいと考えています。 BILLING_SETUP_CANCELED ユーザーが請求設定を中止したか、またはユーザーがセカンダリユーザーで、確認に合格したアカウントが1つもありません。

ステップ4. ユーザーにOAuth認可の付与を依頼する

成功した場合は、ユーザーをOAuth認可フローに送信します。

新しい雇用主セットアップのワークフロー

このフローは、Indeedでスポンサーを開始するためのセットアップと、必要に応じた請求情報の更新の両方に使用します。

ユーザーの請求情報が有効でなくなった場合は、修正のためにアカウント管理フローに送信してください。

スポンサーなしのセットアップ

雇用主がまだIndeedアカウントをセットアップしていないものの、求人をスポンサーする前にIndeedのパフォーマンスデータを確認したい場合は、リクエストURLに任意のtype=loginパラメーターを追加します。このパラメーターは雇用主のIndeedアカウント作成を開始し、残りの確認をスキップします。

雇用主がまだどの求人もスポンサーしていない場合にオーガニック求人のパフォーマンスと予測エンドポイントにアクセスするには、type=loginを使用します。雇用主がIndeedアカウントのセットアップを完了したら、ユーザーをOAuth認可エンドポイントにリダイレクトします。

各雇用主からOAuth認可を取得する

この認可は、新しい雇用主アカウントごと、および関連するセカンダリユーザーごとに必要です。Sponsored Jobs APIは、標準のOAuth 2.0 Authorization code grantを使用します。このフローでは、エンドユーザーがIndeed上のアカウントとキャンペーンデータへのアクセスを貴社に付与します。貴社は、エンドユーザーから取得したOAuthアクセストークンを使用してAPIを呼び出します。

クライアントに代わってAPIを呼び出すためのIndeedアカウントのOAuthセットアップと認可取得には、authorization code grant type (3-legged OAuth)に従ってください。

認可コードリクエストでは、呼び出すエンドポイントに対して正しいスコープを選択してください。詳細については、OAuthスコープをご覧ください。

これらのSponsored Jobs Campaigns APIスコープに加えて、雇用主を表すアクセストークンも取得してください。雇用主を表すアクセストークンを取得するをご覧ください。

受け取るアクセス トークンとリフレッシュトークンは、Indeed上の各雇用主アカウントに固有であり、API呼び出しに必要です。安全に保管してください。これらのトークンを失った場合、クライアントは再度OAuthアクセスを付与する必要があります。

セカンダリユーザーとOAuth認可

プライマリユーザーとは、雇用主アカウントをセットアップする管理者ユーザーです。このユーザーは、Indeed上の雇用主アカウントに関連するすべてのリソースに対するフルアクセス権を持ちます。プライマリユーザーは、他のユーザーに雇用主アカウントへのアクセスを付与できます。これらの追加ユーザーをセカンダリユーザーと呼びます。プライマリユーザーは、IndeedのAccountページでセカンダリユーザーとその権限を追加および確認できます。

Indeedでは、雇用主のキャンペーンを管理する各ユーザーをセカンダリユーザーとして追加することを推奨しています。その後、各セカンダリユーザーに対してOAuth認可を取得してください。各雇用主からOAuth認可を取得するをご覧ください。

ユーザーがアクセスできる雇用主アカウントの一覧を取得するには、ユーザー情報を取得するを使用します。

セカンダリユーザーに対するIndeedアカウントセットアップエンドポイントの動作は次のとおりです。

• ユーザーが、有効な請求情報を持つ雇用主アカウントの少なくとも1つに対してフルアクセス権限を持つ場合、アカウントセットアップエンドポイントはOKの結果でATSに戻します。
• ユーザーがどの雇用主アカウントにもフルアクセス権限を持たない場合、またはそれらの雇用主のいずれも有効な請求情報を持たない場合、エンドポイントは適切な雇用主アカウントがないことを示すエラーページを表示します。そのページには、BILLING_SETUP_CANCELEDエラーでATSに戻るリンクがあります。

ユーザーがv2/api/userinfoエンドポイントから返された雇用主アカウントの1つを選択した後、アカウント管理エンドポイントを使用して、そのアカウントに有効な請求情報があることを確認してください。

Sponsored Jobs APIの概要

これらの技術仕様は、ATSパートナー向けSponsored Jobs APIリファレンスを補足するものです。連携に使用できるエンドポイントについて説明します。一部のエンドポイントはATSパートナー専用のプライベートエンドポイントで、その他は公開エンドポイントです。

ベースURL

ATSパートナーは、次のベースURLでAPIにアクセスできます。

apis.indeed.com/ads

エンドポイント

公開エンドポイント

次のエンドポイントの詳細は、ATSパートナー向けSponsored Jobs APIリファレンスに記載されています。

エンドポイントが、広告代理店として利用する方法と直接の雇用主として利用する方法の2通りを定義している場合は、直接の雇用主の方法を使用してください。

• アカウント管理
• キャンペーン管理
• レポート

プライベートエンドポイント

これらのエンドポイントは、このプログラム向けにセットアップされたATSパートナーに制限されています。

• キャンペーン予測
• オーガニック求人のパフォーマンスと予測

OAuthスコープ

OAuth認可コードリクエストでは、呼び出すAPIエンドポイントに対応するスコープを渡します。すると、エンドユーザーは、リクエストしたスコープをまったく付与しない、一部だけ付与する、またはすべて付与するかを選択します。各APIエンドポイントに対してリクエストするスコープは、次の表で確認してください。

キャンペーン予測

キャンペーン予測のスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
POST /v1/campaignpredictions	employer_access	employer_accessスコープ付き。雇用主を表すアクセストークンを取得するをご覧ください。

オーガニック求人予測

オーガニック求人予測のスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
POST /v1/organicjobpredictions	employer_access	任意

認可エラーを処理する

ユーザーがリクエストしたスコープにアクセスできない場合、またはアプリケーションを認可しない場合に発生するエラーを処理できることを確認してください。どのスコープが付与されたかを確認するには、アクセストークンレスポンス内のscopeレスポンスフィールドを確認します。

エラーコードは次のとおりです。

認可エラーコード

エラーコード	説明
403 INSUFFICIENT_SCOPE	アクセストークンは有効ですが、必要なスコープが付与されていません。
401 INVALID_TOKEN	アクセストークンがない、無効である、または期限切れです。

これらのエラーの処理方法については、推奨ベストプラクティスをご覧ください。ユーザーには、より多くのスコープでアプリを認可するために、OAuth Authorization code grantを再実行する選択肢を提供できます。ただし、一部のユーザーは権限が制限されており、リクエストしたすべてのスコープを認可できない場合があります。

アプリにリクエストしたすべてのスコープが付与されていない場合でも、制限付きの機能セットで動作できるようにしてください。

推奨ベストプラクティス

APIは結果整合性モデルに従います。つまり、POST /v1/campaignsエンドポイントでキャンペーンを作成した場合、短時間の間、GET /v1/campaigns/{campaignId}エンドポイントから新しいキャンペーンを取得できないことがあります。

作成または変更の直後にリソースを取得しようとする場合は、再試行の仕組みを用意してください。

また、API利用上の問題があるかどうかを判断するために、APIから返る4XXレベルのエラーレスポンスを継続的に監視してください。

APIからの5XXレベルのエラーレスポンスは通常、一時的な内部サービスの問題であり、少し待ってから再試行できます。問題の解決方法がわからない場合やエラーが継続する場合は、リクエストパスに/adsが付いていなかったためにSponsored Jobs APIにルーティングできなかったことを示している可能性があります。

たとえば、https://apis.indeed.com/v1/accountではなく、https://apis.indeed.com**/ads**/v1/accountを使用します。問題の診断についてサポートが必要な場合は、marketplacesupport@indeed.comにお問い合わせください。OAuthスコープを使用すると、401 INVALID_TOKENおよび403 INSUFFICIENT_SCOPEエラーが発生することがあります。

アカウント管理

GET	/v1/account	ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントを使用して、雇用主の基本情報を取得します。

次のレスポンスは、雇用主が雇用主アカウントをセットアップするを完了する必要があることを示します。

• エンドポイントが400 NOT_EMPLOYER_ACCOUNTを返す場合、ユーザーはIndeedの雇用主アカウントを持っていません。

• レスポンスにアカウントの請求ステータスを含めるには、fieldsパラメーターに次を渡します。fields=id,email,contact,company,jobSourceList,billingActive

  返されたbillingActiveフィールドの値がfalseの場合、ユーザーはスポンサーを開始するために必要なIndeedでのアカウントセットアップを完了していません。

キャンペーン管理

雇用主のキャンペーンは、雇用主がIndeed Analyticsダッシュボードで管理できる内容に対応します。Indeedのすべての求人キャンペーンには、たとえば784e4acec9x100z2のような一意のIDがあります。

次のエンドポイントを使用して、以下の操作を実行します。

• キャンペーンを作成する
• キャンペーンを更新する
• キャンペーンの予算を取得する
• キャンペーンの予算を更新する

キャンペーンを作成する

POST	/v1/campaigns	ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントを使用してキャンペーンを作成します。このエンドポイントは新しいキャンペーンのIDを返します。このキャンペーンIDを保存し、キャンペーンの変更やレポート取得に使用してください。

キャンペーンを作成するときは、雇用主が選択した予算と期間を設定します。

予算は、雇用主のデフォルト通貨と同じ通貨でなければなりません。

• 最小予算と最小期間は、それぞれ$50と7日間です。
• 各求人には、XML feedで設定した一意の参照番号を使用します。
• すべての日付はYYYY-MM-DD形式で、米国中部時間で指定します。

キャンペーンを作成するには、これらのパラメーターを設定する

フィールド	説明
jobsToInclude	常にqueryに設定します。
jobsQuery	refnum:xxxxxを使用し、xxxxxを求人に定義された一意の参照番号に置き換えます。これはXML job feedのreferencenumberノードの値と一致する必要があります。refnum:xxxxx形式で指定してください。 例: refnum:12345
jobsSourceName	この求人のソースまたは会社です。XML job feed内の求人のsourcenameノードと完全に一致する必要があります。 例: Robertson Recruiting

雇用主が月次キャンペーンを選択した場合

月次の定期キャンペーンは暦月に従います。

フィールド	説明
budgetMonthlyLimit	予算額。
budgetFirstMonthBehavior	startNowProratedAmountに設定します。

雇用主が固定期間キャンペーンを選択した場合

フィールド	説明
budgetOnetimeLimit	予算額。
startDate	キャンペーン開始日。デフォルトは当日です。YYYY-MM-DD形式で、米国中部時間で指定します。
targetEndDate or fixedEndDate	キャンペーンのtargetEndDateまたはfixedEndDateを、YYYY-MM-DD形式、米国中部時間で設定します。 targetEndDate Indeedは、この日までに予算消化を効率的に最適化します。ただし、キャンペーンに予算が残っている場合、キャンペーンはこの日を過ぎても消化を続けます。 fixedEndDate キャンペーンの厳格な終了日です。Indeedは、この日までに予算消化を効率的に最適化し、指定した日付を過ぎて消化しないことも保証します。

キャンペーンを更新する

PATCH	/v1/campaigns/{campaignId}	ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントを使用して、キャンペーンステータスを変更します。

雇用主はキャンペーンを次のいずれかのステータスに設定できます。

ステータス	説明
ACTIVE	アクティブなキャンペーンは求人のスポンサーを開始できます。
PAUSED	一時停止したキャンペーンは、雇用主が再度アクティブにするまで求人をスポンサーしません。
DELETED	これらのキャンペーンは雇用主によって削除されています。

これらのステータスはキャンペーンのみに関するものであり、雇用主の請求ステータスや残予算とは独立しています。

キャンペーンステータスはアクティブでも、請求ステータスや残予算を確認するために次のチェックが必要な場合があります。

キャンペーンステータス	追加チェック	説明
Active	アカウント管理エンドポイントを使用して請求ステータスを確認し、請求が有効であることを確認します。	請求が有効でない場合、キャンペーンは消化を開始できません。次のメッセージでユーザーに通知します。 “キャンペーンに資金を提供するには、まずIndeedアカウントに請求情報を追加する必要があります。” 次に、セットアップを完了するために、ユーザーを雇用主アカウントをセットアップするにリダイレクトします。
Active	キャンペーンの予算を取得するおよびキャンペーンパフォーマンスエンドポイントを使用して、キャンペーンの残予算を確認します。	残予算がゼロの場合、キャンペーンは求人のスポンサーを継続できません。キャンペーンの予算額を更新するかどうかをユーザーに確認します。キャンペーンの予算を更新するエンドポイントを使用して、元の金額に追加額を加えた新しい合計予算を設定します。

キャンペーンの予算を取得する

GET	/v1/campaigns/{campaignId}/budget	ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントを使用して、キャンペーンの予算を取得します。

返されるフィールドは、キャンペーンが単一のライフタイム予算を持つか、月次の定期キャンペーンかによって異なります。

月次の定期キャンペーン

これらのキャンペーンは暦月に従います。レスポンスには、月次予算額を含むbudgetMonthlyLimitフィールドが含まれます。

固定期間キャンペーン

フィールド	説明
budgetOnetimeLimit	予算額。
startDate	キャンペーン開始日。YYYY-MM-DD形式で、米国中部時間で指定します。デフォルトは当日です。
targetEndDate or fixedEndDate	キャンペーンのtargetEndDateまたはfixedEndDateを、YYYY-MM-DD形式、米国中部時間で設定します。 targetEndDate Indeedは、この日までに予算消化を効率的に最適化します。ただし、キャンペーンに予算が残っている場合、キャンペーンはこの日を過ぎても消化を続けます。 fixedEndDate キャンペーンの厳格な終了日です。Indeedは、この日までに予算消化を効率的に最適化し、指定した日付を超えて消化しないことも保証します。

キャンペーンの予算を更新する

PATCH	/v1/campaigns/{campaignId}/budget	ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントを使用して、キャンペーンの予算と期間を変更します。

レポート

レポートエンドポイントを使用して、Indeedからキャンペーンパフォーマンスレポートを取得し、雇用主が利用できるようにします。

キャンペーンパフォーマンス

GET	/v1/campaigns/{campaignId}/stats	ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントを使用して、指定した日付範囲のキャンペーンパフォーマンスレポートを取得します。

ATS Partnersは、このレポートを使用して、集計済みのClicks、Impressions、Conversions、およびCost情報を雇用主に提示できます。

日付範囲は366日を超えることはできません。

パラメーター	説明
startDate	レポート開始日。開始日を含みます。YYYY-MM-DD形式で、米国中部時間で指定します。
endDate	レポート終了日。終了日は含みません。YYYY-MM-DD形式で、米国中部時間で指定します。
merge	値は次のとおりです。 true 日付範囲のすべてのパフォーマンスデータを集計します。 false デフォルト値です。レスポンスは日付ごとにデータを分けて返します。

キャンペーンの予算を取得するを使用し、キャンペーンパフォーマンスレポートの情報と組み合わせて、求人の現在の予算と、これまでに発生したコストを表示します。

そのためには、このエンドポイントのstartDateパラメーターにキャンペーン作成日を渡します。

また、データを集計するためにmerge=trueを渡します。

これにより、キャンペーン開始日からそのキャンペーンで消化した金額を確認できます。

返されるキャンペーンパフォーマンスデータには、次の項目が含まれます。

• Impressions
• Clicks
• Conversions（Applies）
• Cost
• 通貨コード（USD、GBPなど）

ATS Campaign predictions

POST	/v1/campaignpredictions	プライベート — ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントは、次のことを行います。

• 予算に対する期待される求人パフォーマンスを、総応募数の観点から推定します。
• 希望するパフォーマンスに基づいて、求人をスポンサーするための予算を推奨します。

特定の求人とそのプロパティに対するこれらの予測は、Indeed上の類似求人の過去のパフォーマンスに基づきます。 複数の求人を含むキャンペーンのパフォーマンスも予測できます

予測は現在、米国の英語求人でのみ利用でき、1日あたりUSD $100未満の予算に対するパフォーマンスを推定します。すべての予算額は米ドル（USD）で指定します。

予測は、求人のプロパティ、およびキャンペーンの種類と期間に基づきます。

雇用主が推奨予算を承認したら、同じパラメーターでキャンペーンを作成してください。

パラメーター	説明
mode	求人モードの値です。 複数求人のキャンペーン予測にはmulti-jobを設定します。

リクエストボディ

フィールド	必須	説明	型
body	required	求人、キャンペーン、および予測の情報。	CampaignPredictions

CampaignPredictions

フィールド	必須	説明	型
jobInfo	required	求人とそのプロパティを説明します。	JobInfo
campaignInfo	required	希望するキャンペーンタイプを説明します。	CampaignInfo
predictionsInfo	required	予測に使用する希望応募数または希望予算を指定します。	PredictionsInfo

JobInfo

フィールド	必須	説明	型
jobsLocation	required	求人所在地の都市。 Example: Austin, TX	String
jobsQuery	required	refnum:xxxxxを使用し、xxxxxを求人に定義された一意の参照番号に置き換えます。これはXML job feedのreferencenumberノードの値と一致する必要があります。refnum:xxxxx形式で指定してください。 Example: refnum:12345	String
jobsSourceName	required	この求人のソースまたは会社です。XML job feed内の求人のsourcenameノードと完全に一致する必要があります。 Example: Robertson Recruiting	String
jobsTitle	required	求人タイトル。 Example: Software Engineer	String

CampaignInfo

フィールド	必須	説明	型
campaignType	required	ONETIMEまたはMONTHLYのいずれか Example: MONTHLY	String
startDate	conditional	キャンペーン開始日。YYYY-MM-DD形式で、米国中部時間で指定します。デフォルトは当日です。campaignTypeがONETIMEの場合にのみ適用されます。 Example: 2021-08-01	String
endDate	conditional	キャンペーン終了日。YYYY-MM-DD形式で、米国中部時間で指定します。campaignTypeがONETIMEの場合は必須です。 Example: 2021-08-10	String

PredictionsInfo

フィールド	必須	説明	型
predictionType	required	BUDGET_BASEDまたはAPPLY_BASEDのいずれか Example: BUDGET_BASED	String
budgets	conditional	推定パフォーマンスを取得する予算です。パフォーマンスは応募数で推定されます。配列には1つの数値のみを渡します。predictionTypeがBUDGET_BASEDの場合は必須です。 Example: [75.50]	Double array
totalApplies	conditional	推奨予算を取得したい、求人全体の希望応募総数です。これにはオーガニック応募とスポンサー応募の両方が含まれます。配列には1つの数値のみを渡します。predictionTypeがAPPLY_BASEDで、appliesPerJobが設定されていない場合は必須です。 Example: [5]	Integer array
appliesPerJob	conditional	推奨予算を取得したい、求人ごとの希望応募数です。これにはオーガニック応募とスポンサー応募の両方が含まれます。配列には1つの数値のみを渡します。predictionTypeがAPPLY_BASEDで、totalAppliesが設定されていない場合は必須です。 Example: [5]	Integer array

レスポンス

名前	説明	型
currencyCode	予算額の通貨コード。 Example: USD	String
predictions	すべての求人全体に対する推定パフォーマンスまたは推奨予算。	Prediction array
jobLevelPredictions	各求人に対する推定パフォーマンスまたは推奨予算。	JobLevelPredictions array

JobLevelPredictions

名前	説明	型
job	Job Details	Job Details
predictions	求人に対する推定パフォーマンスまたは推奨予算。	Prediction array

求人の詳細

名前	説明	型
jobKey	求人キー。	String
refNum	求人参照番号。	String
title	求人タイトル。	String
location	求人所在地。	String

Prediction

名前	説明	型
budget	BUDGET_BASEDリクエストでは、推定応募数の基準となる予算です。APPLY_BASEDリクエストでは、希望する総応募数を達成するための推奨予算です。	Double
organicApplies	BUDGET_BASEDリクエストでは、スポンサーしない場合の求人のオーガニック応募数の推定値です。スポンサーによって生じる推定応募数を計算するには、totalAppliesとorganicAppliesを使用します。	Integer
totalApplies	BUDGET_BASEDリクエストでは、予算値に対するオーガニックおよびスポンサー求人の応募総数の推定値です。 APPLY_BASEDリクエストでは、推奨予算の基準となる応募総数です。	Integer
estimatedLowerApplies	BUDGET_BASEDリクエストでは、予算値に対するオーガニックおよびスポンサー求人の応募数の推定下限値です。 APPLY_BASEDリクエストでは、レスポンスにこのフィールドは含まれません。	Integer
estimatedHigherApplies	BUDGET_BASEDリクエストでは、予算値に対するオーガニックおよびスポンサー求人の応募数の推定上限値です。 APPLY_BASEDリクエストでは、レスポンスにこのフィールドは含まれません。	Integer

予測のJSONリクエスト例

{
  "jobInfo": {
    "jobsLocation": "Austin, TX",
    "jobsQuery": "refnum:12345",
    "jobsSourceName": "Bob’s Recruiting",
    "jobsTitle": "Software Engineer"
  },
  "campaignInfo": {
    "campaignType": "ONETIME",
    "startDate": "2021-08-10",
    "endDate": "2021-08-11"
  },
  "predictionsInfo": {
    "predictionType": "BUDGET_BASED",
    "budgets": [75.50]
  }
}

予測のJSONレスポンス例

{
  "currencyCode": "USD",
  "predictions": [{
    "predictionType": "BUDGET_BASED",
    "budget": 151,
    "organicApplies": 3,
    "totalApplies": 7,
    "estimatedLowerApplies": 3,
    "estimatedHigherApplies": 10
  }],
  "jobLevelPredictions": [{
      "job": {
        "jobKey": "80fdf7e9de72243f",
        "refNum": "12800649-92-99",
        "title\"": "Firmware Engineer",
        "location": "Irvine"
      },
      "predictions": [{
        "predictionType": "BUDGET_BASED",
        "budget\"": 75.5,
        "organicApplies": 2,
        "totalApplies": 4,
        "estimatedLowerApplies": 2,
        "estimatedHigherApplies": 5
      }]
    },
    {
      "job": {
        "jobKey": "79db86f75cbbde08",
        "refNum": "12800649-93-100",
        "title\"": "Principal Software Engineer",
        "location": "Irvine"
      },
      "predictions": [{
        "predictionType": "BUDGET_BASED",
        "budget": 75.5,
        "organicApplies": 1,
        "totalApplies": 3,
        "estimatedLowerApplies": 1,
        "estimatedHigherApplies": 5
      }]
    }
  ]
}

オーガニック求人のパフォーマンスと予測

POST	/v1/organicjobpredictions	プライベート — ATSパートナー向けSponsored Jobs APIリファレンス

このエンドポイントは、次の情報を提供します。

• 単一求人の過去30日間のオーガニックトラフィック統計
• 今後30日間のオーガニックトラフィック統計の推定値
• 求人をスポンサーした場合のトラフィック改善の推定値

パフォーマンスはクリック数で表されます。

すべての予算額はUSDで指定します。

このエンドポイントを使用するには、雇用主の管理者ユーザーが雇用主アカウントをセットアップするの手順に従ってIndeedにアカウントを持っている必要があります。ただし、スポンサー用の請求情報が設定されていない場合は、URLにtype=loginパラメーターを渡してセットアップフローを簡略化できます。

オーガニック求人のパフォーマンスと予測のリクエスト

名前	必須	説明	型
body	required	求人関連情報。	OrganicJobPrediction

OrganicjobPredictionフィールド

名前	必須	説明	型
jobInfo	required	求人説明とそのプロパティ。	JobInfo

JobInfoフィールド

名前	必須	説明	型
jobsQuery	required	求人を識別する一意の参照番号です。"refnum:xxxxx”形式で指定します。XML job feedのreferencenumberノードと一致する必要があります。 Example: refnum:12345	String
jobsSourceName	required	この求人のソースまたは会社です。"refnum:xxxxx”形式で指定します。XML job feedの求人のsourcenameノードと完全に一致する必要があります。 Example: Robertson Recruiting	String

オーガニック求人のパフォーマンスと予測のレスポンス

レスポンスは、求人にトラフィックがあったかどうか、およびその求人のスポンサーが推奨されるかどうかによって異なる場合があります。

• 求人が過去30日間にトラフィックを受けていない場合、metricオブジェクト内のclicksフィールドの値は0です。
• 求人が30日間存在していない場合、トラフィック統計はその求人が存在した日数分について返されます。ただし、daysレスポンスフィールドの値は30のままです。
• 推奨が利用できない場合、recommendationフィールドは返されません。

名前	必須	説明	型
metric	required	指定した求人の過去30日間のオーガニックトラフィック統計。	OrganicMetric
prediction	required	指定した求人の今後30日間のオーガニックトラフィック統計の推定値。	OrganicPrediction
recommendation	optional	利用可能な場合、推奨予算に基づく指定求人のスポンサーパフォーマンス推定値。	SponsoredPrediction

OrganicMetricフィールド

名前	説明	型
clicks	過去n日間にその求人が獲得したクリック数。	Integer
days	日数。デフォルトは30日です。	Integer

OrganicPredictionフィールド

名前	説明	型
clicks	今後n日間における、その求人の推定クリック数。	Integer
days	日数。デフォルトは30日です。	Integer

SponsoredPredictionフィールド

名前	説明	型
clicks	今後n日間における、その求人の推定クリック数。	Integer
days	日数。デフォルトは30日です。	Integer
budget	スポンサーに推奨される予算。	Double

JSONリクエスト例

{
  "jobInfo": {
    "jobsQuery": "refnum:12345",
    "jobsSourceName": "Bob’s Recruiting"
  }
}

JSONレスポンス例

{
  "metric": {
    "clicks": 30,
    "days": 30
  },
  "prediction": {
    "clicks": 40,
    "days": 30
  },
  "recommendation": {
    "budget": 250.0,
    "clicks": 70,
    "days": 30
  }
}

 

このページは役に立ちましたか？