Send Candidates APIガイド

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

 

法的注意

By using this API and its documentation and building an integration, you agree to the Additional API Terms and Guidelines.

Send Candidates APIワークフロー

1. 1.
   Send Candidates APIの概要: Send Candidates APIが候補者の応募をIndeedとどのように同期するかを確認します。
2. 2.
   認証。
3. 3.
   雇用主の登録: 雇用主を登録し、登録に関する情報を返します。
4. 4.
   応募の初期化と添付ファイルのアップロード: Indeedで応募バージョンをステージングし、添付ファイルのアップロードURLを生成して、そのURLにファイルをアップロードします。
5. 5.
   応募の送信: 応募バージョンをIndeedに送信します。バージョンは送信順に非同期で公開されます。
6. 6.
   応募ステータスの追跡: 応募ステータスと処理エラーを追跡します。
7. 7.
   応募の削除: 応募とそのすべてのバージョンをIndeedから完全に削除します。
8. 8.
   GraphQL エラーのトラブルシューティング: GraphQLエラーを解決します。

Send Candidates APIリファレンス

• registerEmployer: 雇用主を登録し、登録に関する情報を返します。
• application.initialize: Indeedで応募バージョンをステージングし、添付ファイルをアップロードするURLを生成します。
• application.submit: 応募を送信します。
• findStatuses: 応募ステータスと処理エラーを追跡します。
• application.delete: 応募を削除します。

Send Candidates APIの概要

Send Candidates APIは、候補者の応募を送信して追跡するための完全なワークフローを提供します。応募の送信には、初期化、添付ファイルのアップロード、送信という 3 つの手順が必要です。

初期化では、Indeedで応募バージョンをステージングし、添付ファイルをアップロードするURLを生成します。初期化のたびに、一意の applicationVersionId を持つバージョンが作成されます。初期化後は、5 分以内に添付ファイルをアップロードして送信します。

この API は、データを階層構造で整理します。applicationIdentifier オブジェクトには、応募を一意に識別する次のフィールドが含まれます。

応募の識別情報

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

この組み合わせは、1 件の論理的な応募を定義します。同じ applicationIdentifier で initialize を呼び出すたびに、その応募の新しいバージョンが作成されます。

任意のフィールドを含め、すべてのフィールドが一意性に影響します。たとえば、atsCandidateId を含む応募は、ほかのすべてのフィールドが同じでも、atsCandidateId を含まない応募とは別の応募です。

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

• すべての添付ファイルは、ウイルスと有害なコンテンツのスキャンを実行します。安全でないファイルは削除されます。
• すべての添付ファイルの合計サイズは15 MB（15,728,640バイト）を超えてはいけません。
• 個々のファイルサイズは6 MB（6,291,456バイト）を超えてはいけません。
• MD5ハッシュに基づき、重複した添付ファイルは許可されません。
• RESUMEとCOVER_LETTERの添付ファイルは、それぞれ最大1つまで含められます。追加のファイルにはOTHER_RESUMEまたはOTHER_COVER_LETTERを使用します。
• すべての添付ファイルには、有効なBase64エンコード済みMD5チェックサムが必要です。

人種、性別、年齢、障害の有無など、保護対象の人口統計情報に関する質問への回答はIndeedに公開されません。

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

同じ応募に対してミューテーション（initialize、submit、delete）を同時に実行しないでください。短時間に続けて実行すると、競合状態、予期しないデータ状態、どのバージョンが公開されたかについての混乱が発生する可能性があります。

認証

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.

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 トークン. で認証します。アプリケーションは、ユーザー操作なしで Indeed の認可サーバーに直接認証します。

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

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

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

雇用主の登録

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 でもう一度取得します。

応募の初期化と添付ファイルのアップロード

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

リクエスト – 応募の初期化

応募を初期化するには、initializeを呼び出します。このオペレーションは、Indeedで応募バージョンをステージングし、添付ファイルをアップロードするURLを生成します。

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

• 雇用主の登録:

  Indeed 上の雇用主を識別するには、indeedRegistrationId に、registerEmployer が EmployerRegistration で返す id を設定します。

  雇用主では、sendApplications 機能が有効になっている必要があります。

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

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

フィールド	必須	説明
applicationIdentifier 型: AtsSyncCandidateSyncApplicationIdentifierInput!	✅	Indeed上の応募の一意のIDです。
applicant 型: AtsSyncCandidateSyncApplicantDetailsInput!	✅	完全な応募者詳細です。
questionsAndAnswers 型: [AtsSyncCandidateSyncApplicationQuestionAndAnswerInput!]!	⬜	スクリーナー質問と応募者の回答です。どちらもプレーンテキスト文字列として指定します。
disposition 型: AtsSyncCandidateSyncApplicationDispositionInput!	✅	現在の応募者ステータスです。ステータスマッピングの例については、Indeed Standard Disposition Statusesをご覧ください。
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 ヘッダー値として指定します。

応募の送信

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

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

• 雇用主の登録:

  Indeed 上の雇用主を識別するには、indeedRegistrationId を指定します。雇用主では、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分以内にsubmitを呼び出します。送信前にすべての添付ファイルをアップロードします。添付ファイルが不足している応募もIndeedは処理しますが、findStatusesはFILE_NOT_UPLOADEDエラーを返します。添付ファイルの処理に失敗した場合でも、応募を送信できます。Indeedは応募を非同期で処理し、送信順を維持します。

応募ステータスの追跡

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
        }
      }
    }
  }
}

応募の削除

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

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

• 雇用主の登録:

  Indeed 上の雇用主を識別するには、indeedRegistrationId を指定します。雇用主では、sendApplications 機能が有効になっている必要があります。

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

リクエスト – 応募の削除

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

このオペレーションは永続的です。Indeedはすべての応募バージョンを削除します。削除後は、バージョンを再作成することも、新しいバージョンを作成することもできません。

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

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

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

レスポンス – 応募の削除

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

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

 

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