Send Candidates APIガイド

候補者の応募をIndeedと同期します。

 

法的注意

このAPIとそのドキュメントを使用して連携を構築すると、APIに関する追加の利用規約およびガイドラインに同意したことになります。

APIの概要

Send Candidates APIは、初期化、添付ファイルのアップロード、送信の3ステップで候補者の応募を送信し、追跡します。

初期化では、応募バージョンをIndeedにステージングし、添付ファイルのアップロードURLを生成して、一意のapplicationVersionIdを返します。その後、添付ファイルのアップロードと送信は5分以内に行う必要があります。

applicationIdentifierオブジェクトには、応募を一意に識別するフィールドが含まれます。

応募の識別情報

フィールド	必須	説明
indeedRegistrationId	✅	Indeedの採用企業とパートナー側の採用企業を関連付ける一意のIDです。登録時に提供されます。
atsCandidateId	⬜	1件以上のATSの応募に関連付けられた候補者プロフィールのIDです。
atsApplicationId	✅	ATS内での応募の一意のIDです。
job.sourcedPostingId	✅	createSourcedJobPostingsが返す求人掲載IDです。

これらのフィールドの組み合わせが1件の応募を定義し、同じapplicationIdentifierでinitializeを呼び出すたびに、その応募の新しいバージョンが作成されます。任意のフィールドを含め、すべてのフィールドが識別に使用されます。たとえば、atsCandidateIdを指定した応募は、他のすべてのフィールドが一致していても、それを省略した応募とは別の応募として扱われます。

添付ファイルをアップロードするときは、次の点に注意してください。

• 各ファイルは6 MB（6,291,456バイト）以下、添付ファイル全体で15 MB（15,728,640バイト）以下にする必要があります。
• 各添付ファイルには有効なBase64エンコード済みのMD5チェックサムが必要で、同じハッシュを持つ添付ファイルを複数指定することはできません。
• RESUMEとCOVER_LETTERは、それぞれ最大1件まで指定できます。追加のファイルにはOTHER_RESUMEまたはOTHER_COVER_LETTERを使用します。
• Indeedはすべての添付ファイルをスキャンし、安全でないファイルを削除します。

Indeedは、人種、性別、年齢、障がいの有無など、保護対象の属性情報に関する回答を公開しません。

応募を削除すると、その応募とすべてのバージョンがIndeedから完全に削除されます。削除した応募を再度初期化することはできません。

同じ応募に対して複数のミューテーション（initialize、submit、delete）を同時に実行しないでください。短時間に連続して呼び出すと、競合状態や予期しないデータ状態が発生し、どのバージョンが公開されているか判断できなくなるおそれがあります。

---

APIの手順

Send Candidates APIと連携したら、次の手順で候補者の応募をIndeedと同期します。

必要に応じて、応募を削除すると、応募とそのすべてのバージョンを完全に削除できます。

---

1. 認証する

Indeed パートナーになると、Indeed が連携用のアプリを作成します。Partner Console （新しいウィンドウで開きます） にサインインして、アプリと OAuth 認証情報（クライアント ID、シークレット、および 3-legged OAuth の認可コード）を確認します。これらの認証情報をアクセストークンと交換し、API 呼び出しを認証します。

Candidate Sync API の各オペレーションには OAuth トークンが必要です。

Candidate Sync API オペレーションの OAuth トークンタイプ

API とオペレーション	OAuth トークンタイプ
Employer Registration API 採用企業を登録する	採用企業を表す 3-legged OAuth トークン を使用し、employer.ats_candidate.sync スコープで認証します。このトークンは採用企業の Indeed アカウントと ATS アカウントを関連付けます。Indeed の管理者またはオーナーが作成する必要があります。registerEmployer がスコープ不足のエラーを返す場合、このトークンが採用企業に関連付けられていない可能性があります。
Employer Registration API 登録情報を更新する 登録情報を一覧表示する 採用企業の登録を解除する Send Candidates API 応募を初期化し、添付ファイルをアップロードする 応募を送信する 応募ステータスを追跡する 応募を削除する Retrieve Candidates API 未確認のアセットを取得する 時間範囲でアセットを取得する テストアセットを作成する	2-legged OAuth トークン で認証します。ユーザー操作は必要ありません。

アクセストークンは ATS 内に安全に保存し、ユーザー間で共有しないでください。Indeed は、お客様のシステムが求人の信頼できる情報源であることを前提としています。あるユーザーのアクセストークンを別のユーザーが投稿した求人に使用すると、Indeed 上でそのユーザーに別のユーザーの求人へのアクセスを付与する可能性があります。

アクセストークンを取得したら、クエリまたはミューテーションにこのトークンを含めます。最新の求人ステータスを確認するたびにユーザーへサインインを求めることがないよう、Indeed ではアクセストークンの有効期限が切れる前に更新することを推奨しています。

Indeed と連携して API を呼び出す と スコープ をご覧ください。

---

2. 採用企業を登録する

Employer Registration APIを使用して、採用企業を登録できます。

リクエスト – Register employer

採用企業を登録し、登録情報を返すには、registerEmployer を呼び出します。

採用企業を表す 3-legged OAuth トークン を使用し、employer.ats_candidate.sync スコープで認証します。このトークンは採用企業の Indeed アカウントと ATS アカウントを関連付けます。Indeed の管理者またはオーナーが作成する必要があります。registerEmployer がスコープ不足のエラーを返す場合、このトークンが採用企業に関連付けられていない可能性があります。

RegisterEmployerInput では、次の入力フィールドを指定します。

registerEmployer の入力フィールド

フィールド	必須	説明
partnerEmployerId 型：ID!	✅	採用企業を一意に識別するために指定する ID です。 1 つの partnerEmployerId を複数の Indeed アカウントに登録できますが、各 Indeed アカウントでは、ATS ごとに 1 つの partnerEmployerId のみを使用できます。同じ Indeed アカウントで別の partnerEmployerId を使用すると、Indeed は登録を新しい atsName と partnerEmployerId に更新します。
atsName 型：String!	✅	採用企業に対して指定する名称です。Indeed 上では、この名称が採用企業に表示されます。

レスポンス – Register employer

API は EmployerRegistration を返します。後続の Candidate Sync API 呼び出しで使用するために id を保存するか、partnerEmployerId を指定して findRegisteredEmployers でもう一度取得します。

---

3. 登録情報を更新する

機能を有効にするには、登録情報を更新します。

---

4. 応募を初期化して添付ファイルをアップロードする

応募バージョンをIndeedにステージングし、添付ファイルのアップロードURLを生成して、そのURLにファイルをアップロードします。

リクエスト — 応募を初期化する

応募を初期化するには、initializeを呼び出します。

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

Indeed上の採用企業を識別するには、indeedRegistrationIdに、registerEmployerが返すidを設定します。

その採用企業では、sendApplications機能が有効になっている必要があります。

これらのIDの管理については、Employer Registration APIをご覧ください。

次の入力フィールドを指定します。

initializeミューテーションのフィールド

フィールド	必須	説明
applicationIdentifier 型: AtsSyncCandidateSyncApplicationIdentifierInput!	✅	Indeed上での応募の一意のIDです。
applicant 型: AtsSyncCandidateSyncApplicantDetailsInput!	✅	応募者の詳細情報一式です。
questionsAndAnswers 型: [AtsSyncCandidateSyncApplicationQuestionAndAnswerInput!]!	⬜	審査用の質問と応募者の回答です。いずれもプレーンテキストの文字列で指定します。
disposition 型: AtsSyncCandidateSyncApplicationDispositionInput!	✅	応募の現在の応募者ステータスです。マッピングの例については、Indeedの標準応募者ステータスをご覧ください。
applicationLink 型: WebUrl!	✅	自社システム内の応募への直接リンクです。
candidateLink 型: WebUrl	⬜	自社システム内の候補者プロフィールへの直接リンクです。

mutation InitializeApplication($input:
  InitializeAtsSyncCandidateSyncApplicationInput!) {
  atsSyncCandidateSync {
    application {
      initialize(input: $input) {
        applicationVersionId
        attachments {
          fileType
          fileName
          contentType
          contentLength
          fileChecksum {
            checksum
          }
          url
        }
      }
    }
  }
}

レスポンス — 応募を初期化する

応募の初期化のレスポンスフィールド

フィールド	説明
applicationVersionId 型: ID!	新しい応募バージョンです。送信時に使用します。
attachments 型: [AtsSyncCandidateSyncApplicationAttachment!]!	添付された各ファイルのファイルデータをアップロードします。

initializeのレスポンスで返された各添付ファイルについて、urlにPUTリクエストを送信してファイルデータをアップロードします。その際、initializeミューテーションのapplicant.attachmentsの値と一致する次のヘッダーを指定します。

添付ファイルのアップロード

ヘッダー	値の参照元	説明
Content-Type	contentType	添付ファイルの元のメディアタイプです。
Content-Length	contentLength	バイト単位のファイルサイズです。
Content-MD5	fileChecksum.checksum	MD5ハッシュです。 checksumをBase64でエンコードし、Content-MD5ヘッダーの値として指定します。

---

5. 応募を送信する

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

応募バージョンをIndeedに送信します。バージョンは送信順に非同期で公開されます。

Indeed上の採用企業を識別するには、indeedRegistrationIdに、registerEmployerが返すidを設定します。

その採用企業では、sendApplications機能が有効になっている必要があります。

これらのIDの管理については、Employer Registration APIをご覧ください。

リクエスト — 応募を送信する

応募を送信するには、application.submitミューテーションを呼び出します。

次の入力フィールドを指定します。

submitミューテーションのフィールド

フィールド	必須	説明
indeedRegistrationId 型: ID!	✅	Indeedの採用企業アカウントに関連付けます。
applicationVersionId 型: ID!	✅	application.initializeが返すバージョンIDです。

mutation SubmitApplication($input: SubmitAtsSyncCandidateSyncApplicationInput!) {
  atsSyncCandidateSync {
    application {
      submit(input: $input) {
        applicationVersionId
      }
    }
  }
}

レスポンス — 応募を送信する

submitのレスポンスフィールド

フィールド	説明
applicationVersionId 型: ID!	入力値と同じです。必要に応じて監査用に記録してください。

初期化から5分以内に呼び出し、その前にすべての添付ファイルをアップロードしてください。添付ファイルが不足している場合や処理に失敗した場合でも送信は可能ですが、findStatusesはFILE_NOT_UPLOADEDエラーを返します。処理は非同期ですが、送信順は維持されます。

---

6. 応募のステータスを追跡する

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

送信後に応募バージョンのステータスをクエリして、処理状況を確認し、エラーを特定します。

リクエスト — 応募のステータスを取得する

ページネーションを使用して応募バージョンのステータスをクエリするには、findStatusesを呼び出します。

このクエリを使用して、公開の進捗を追跡し、バージョン履歴とあわせて複数の応募のステータスを確認します。

findStatusesのフィルター

フィールド	フィルター対象
indeedRegistrationIds 型: ID!	採用企業です。
applications 型: [AtsSyncCandidateSyncApplicationIdentifierInput!]!	応募IDです。
applicationVersionIds 型: [ID!]!	応募バージョンです。
applicationVersionStatusTypes 型: [AtsSyncCandidateSyncApplicationVersionStatusTypeInput!]!	ステータスです。

query FindApplicationStatuses($input:
  AtsSyncCandidateSyncApplicationFindStatusesInput!$first: Int $after:
  String $last: Int $before: String) {
  atsSyncCandidateSync {
    application {
      findStatuses(input: $input first: $first after: $after last:
        $last before: $before) {
        applicationVersionStatuses {
          applicationVersionId
          applicationIdentifier {
            indeedRegistrationId
            atsCandidateId
            atsApplicationId
            job {
              sourcedPostingId
            }
          }
          status
          processingStatus
          errors
        }
        pageInfo {
          hasNextPage
          hasPreviousPage
          startCursor
          endCursor
        }
      }
    }
  }
}

---

7. 応募を削除する

2-legged OAuth トークン で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

応募とそのすべてのバージョンをIndeedから完全に削除します。

リクエスト — 応募を削除する

応募を削除するには、application.deleteミューテーションを呼び出します。

この操作は取り消せません。すべての応募バージョンがIndeedから削除され、その後は新しいバージョンを作成できません。

Indeed上の採用企業を識別するには、indeedRegistrationIdに、registerEmployerが返すidを設定します。

その採用企業では、sendApplications機能が有効になっている必要があります。

これらのIDの管理については、Employer Registration APIをご覧ください。

deleteミューテーションのフィールド

フィールド	必須	説明
applicationIdentifier 型: AtsSyncCandidateSyncApplicationIdentifierInput!	✅	応募の一意のIDです。
deletedAt 型: DateTime!	✅	応募が削除された日時です。

mutation DeleteApplication($input: DeleteAtsSyncCandidateSyncApplicationInput!) {
  atsSyncCandidateSync {
    application {
      delete(input: $input) {
        applicationVersionId
      }
    }
  }
}

レスポンス — 応募を削除する

deleteのレスポンスフィールド

フィールド	説明
applicationVersionId 型: ID!	この削除操作の一意のIDです。削除された応募の最終バージョンを参照します。

---

関連項目

ガイド

• ベストプラクティス — APIを使用する際の推奨事項です。
• データ型とファイルの取り扱い — データ型、添付ファイル、アップロード要件の取り扱いについて説明します。
• GraphQL エラーをトラブルシューティングする — APIが返すGraphQLエラーを診断します。

GraphQL APIリファレンス

• registerEmployer — 採用企業を登録します。採用企業を表す3-legged OAuthトークンとemployer.ats_candidate.syncスコープで認証します。
• application.initialize — Indeedに公開する応募バージョンをステージングします。2‑legged OAuthトークンで認証します。
• application.submit — 公開のために応募バージョンをIndeedに送信します。2‑legged OAuthトークンで認証します。
• findStatuses — 各応募バージョンのステータスを返します。2‑legged OAuthトークンで認証します。
• application.delete — 応募とそのすべてのバージョンをIndeedから完全に削除します。2‑legged OAuthトークンで認証します。

 

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