Employer Data API

Indeed および Indeed PLUS プラットフォームで雇用主エンティティを作成および更新します。直接雇用主は利用できません。

 

概要

Employer Data API を使用すると、ATSパートナーは Indeed および Indeed PLUS で雇用主レコードを作成および更新できます。

employer は、Indeed に求人を掲載する企業または組織を表します。各雇用主には、一意の ID、名前、および求職者が職場について理解するのに役立つその他の属性があります。

主な概念

• 雇用主エンティティ: API を通じて作成した雇用主は、Indeed の雇用主アカウントに関連付けられません。
• 前提条件: その雇用主の求人を作成する前に、雇用主を作成してください。
• 審査: Indeed は、すべての雇用主データについて完全性と適切性を確認します。

クイックスタート

1. 1.
   認証を設定する
2. 2.
   最初の雇用主を作成する
3. 3.
   雇用主情報を更新する
4. 4.
   日本固有の要件を確認する（日本のパートナーのみ）
5. 5.
   トラブルシューティング

リファレンス情報については、対応ロケール と 企業セクター をご覧ください。

認証

すべての Employer Data API 操作には、2-legged OAuth 認証が必要です。

1. 2-legged OAuth トークンを取得します。
2. OAuth アプリに雇用主の作成権限と更新権限があることを確認します。Indeed は、Indeed パートナーになる際にこれらの権限を付与します。

詳しくは、GraphQL at Indeed をご覧ください。

雇用主データ

ATSパートナーである場合は、Indeed に送信するデータと Indeed がそのデータをどのように使用するかを、雇用主の顧客に伝えてください。

雇用主データについて、より信頼できるソースから Indeed に送信された場合、Indeed はお客様が送信したデータを上書きする場合があります。

雇用主属性のスコープ

Indeed は、国と言語によって雇用主データを異なる形で表示する場合があります。patchEmployer に渡す属性には異なるスコープがあるため、Indeed は求職者に最も関連性の高い情報を表示できます。

雇用主データには、次のスコープがあります。

1. グローバルスコープ: 雇用主が事業を行うすべての国で値が同じです。

   • グローバル属性は employerName と employerType です。

2. 国スコープ: 値は国ごとに異なる場合があります。

   • countrySpecificAttributes には、国固有のすべての属性が含まれます。
   • これらの属性を更新するには、countrySpecificAttributes の country に ISO 3166-1 の 2 文字の国コード を設定します。

3. ロケールスコープ: 値は国と言語ごとに異なる場合があります。

   • localeSpecificAttributes には、ロケール固有のすべての属性が含まれます。
   • これらの属性を更新するには、localeSpecificAttributes の country に ISO 3166-1 の 2 文字の国コードを設定し、language に ISO 639-1 の 2 文字の言語コード を設定します。有効な組み合わせについては、対応ロケール をご覧ください。
   • デフォルトでは、Indeed は更新した属性をグローバルとして扱います。localeSpecificAttributes には isGlobalDefault が含まれ、そのデフォルト値は true です。要求したロケールに翻訳がない場合、API はこの値を返します。たとえば、fr-CA をリクエストしたときに雇用主に fr-CA の翻訳がない場合、API はグローバルデフォルトを返します。

雇用主を作成する

雇用主を作成するには、GraphQL patchEmployer ミューテーションを使用します。その雇用主の求人を作成する前に、まず雇用主データを送信する必要があります。

認証要件については、認証 をご覧ください。

リクエスト

雇用主データを送信するには、PatchEmployerInput オブジェクトを指定して patchEmployer を呼び出します。

• id: 一意の雇用主識別子です。次のフィールドが含まれます。
  • type: Indeed 内でお客様の ATS を識別します。Indeed はセットアップ時にこの値を提供します。すべての patchEmployer 呼び出しで同じ値を使用してください。
  • id: お客様の ATS 内で雇用主を識別します。これが雇用主 ID です。パートナーによっては、この値を暗号化またはハッシュ化します。その雇用主を更新するたびに、常に同じ値を使用してください。別の雇用主を更新する場合は、その雇用主の ID を使用してください。
• employerName: スキーマではこのフィールドは任意ですが、雇用主を作成する場合は指定する必要があります。グローバルの localizedName を直接設定しない限り、Indeed はこの値をグローバルの localizedName フィールドにコピーします。
• employerAttributes: 任意の追加雇用主データです。属性を設定する必要がない場合は、このフィールドを省略します。雇用主の作成後に属性を更新できます。各属性のルールについては、雇用主を更新する をご覧ください。

Indeed は、国やロケールによって雇用主データを異なる形で表示する場合があります。

リクエスト例

この例では、一般的なフィールドを使用して日本の雇用主を作成します。

mutation CreateEmployerExample {
  patchEmployer(
    input: {
      id: { 
        type: "YOUR_ATS_TYPE_FROM_INDEED"  
        id: "EMPLOYER_123"                 
      }
      employerName: "Example employer"
      employerAttributes: {
        employerType: JURIDICAL_PERSON
        countrySpecificAttributes: [
          { 
            country: "JP"
            websiteUrl: "https://example.com" 
            phoneNumber: "+81123456789"
          }
        ]
        localeSpecificAttributes: [
          {
            country: "JP"
            language: "ja"
            isGlobalDefault: true
            description: "Free text to describe the employer"
            localizedName: "ローカルネーム"
            headquarterAddress: "Minato-ku, Tokyo"
            leader: { 
              name: "Leader name" 
            }
          }
        ]
      }
    }
  ) {
    responseCode
  }
}

レスポンス

patchEmployer が成功すると、API は PatchEmployerPayload オブジェクトを返します。

patchEmployer が失敗すると、API はエラーレスポンスを返します。エラーレスポンスの解釈については、GraphQL エラーをトラブルシューティングする をご覧ください。

レスポンス例

{
  "data": {
    "patchEmployer": {
      "responseCode": "OK"
    }
  }
}

雇用主を更新する

雇用主属性を更新するには、patchEmployer ミューテーションを使用します。雇用主データを更新する前に、まず雇用主を作成する必要があります。

認証要件については、認証 をご覧ください。

リクエスト

patchEmployer は PatchEmployerInput オブジェクトを受け取ります。次のフィールドが含まれます。

• id: 一意の雇用主識別子です。次のフィールドが含まれます。
  • type: Indeed 内でお客様の ATS を識別します。Indeed はセットアップ時にこの値を提供します。すべての patchEmployer 呼び出しで同じ値を使用してください。
  • id: お客様の ATS 内で雇用主を識別します。これが雇用主 ID です。パートナーによっては、この値を暗号化またはハッシュ化します。その雇用主を更新するたびに、常に同じ値を使用してください。別の雇用主を更新する場合は、その雇用主の ID を使用してください。
• employerName: 更新する場合を除き任意です。このフィールドを更新すると、グローバルの localizedName を直接設定しない限り、Indeed はその値をグローバルの localizedName フィールドにコピーします。
• employerAttributes: 任意の追加雇用主データです。

Indeed は、国やロケールによって雇用主データを異なる形で表示する場合があります。

更新の動作

各フィールドは、次の動作をサポートします。

• 無視: 値を省略すると、その属性は変更されません。
• 更新: 属性を新しい値に設定します。新しい値が保存済みの値と異なる場合、更新は成功します。
• 削除: 属性を null に設定します。employerName は削除できません。

レスポンス

更新レスポンスは、作成レスポンス と同じです。

例

これらの例は、雇用主データを更新するさまざまな方法を示しています。

説明を更新する

このコードスニペットは、ja-JP ロケールの雇用主説明を更新します。

mutation UpdateDescription {
  patchEmployer(input: {
    id: {
      type: "TYPE_FROM_INDEED"
      id: "EMPLOYER_ID_IN_ATS"
    }
    employerAttributes: {
      localeSpecificAttributes: [{
        country: "JP"
        language: "ja"
        description: "Updated employer description"
      }]
    }
  }) {
    attributeUpdated
  }
}

説明を削除する

このコードスニペットは、ja-JP ロケールの雇用主説明を null に設定して削除します。

mutation DeleteDescription {
  patchEmployer(input: {
    id: {
      type: "TYPE_FROM_INDEED"
      id: "EMPLOYER_ID_IN_ATS"
    }
    employerAttributes: {
      localeSpecificAttributes: [{
        country: "JP"
        language: "ja"
        description: null
      }]
    }
  }) {
    attributeUpdated
  }
}

複数の雇用主属性を更新する

1 回のリクエストで複数の雇用主属性を更新できますが、各リクエストは 1 つの雇用主にのみ適用されます。複数の雇用主を更新する必要がある場合は、複数のリクエストを送信してください。

1 回のリクエストで複数の国とロケールを更新しないでください。そうすると、結果が予測できなくなる場合があります。

mutation UpdateMultipleAttributes {
  patchEmployer(input: {
    id: {
      type: "TYPE_FROM_INDEED"
      id: "EMPLOYER_ID_IN_ATS"
    }
    employerName: "Example employer"
    employerAttributes: {
      employerType: JURIDICAL_PERSON
      countrySpecificAttributes: [{
        country: "JP"
        websiteUrl: "https://example.co.jp"
        phoneNumber: null
        taxId: "000000"
      }]
      localeSpecificAttributes: [{
        country: "JP"
        language: "ja"
        isGlobalDefault: true
        description: "Japanese employer description"
        localizedName: "Japanese local name"
        headquarterAddress: "Minato-ku, Tokyo"
        leader: {
          name: "Leader name"
        }
      }]
    }
  }) {
    attributeUpdated
  }
}

日本のパートナー向け要件

patchEmployer ミューテーションを使用して雇用主を作成または更新する場合は、スキーマで必須とされているすべてのフィールドを含めます。

日本のパートナーは、Indeed PLUS のポリシーおよび法的要件を満たすため、雇用主を作成する際に特定のフィールドも送信する必要があります。雇用主を更新する際は、それらの値が変わらない場合、送信する必要はありません。

雇用主の作成と更新を正常に行うには、このガイドに従ってください。

必須フィールド

この表は、雇用主を作成または更新する際の patchEmployer ミューテーションについて、PatchEmployerInput の必須フィールドを示しています。

patchEmployer の必須フィールド

属性	必須	注記
type	✔ 雇用主の作成と更新	Indeed が提供する値を使用します。
id	✔ 雇用主の作成と更新	お客様の ATS 内で雇用主を一意に識別します。
employerName	✔ 雇用主の作成	リクエストで global の localizedName を明示的に設定しない限り、Indeed は employerName の値をグローバルの localizedName フィールドにコピーします。
countrySpecificAttributes.country	✔ 雇用主の作成と更新	JP に設定します。
countrySpecificAttributes.phoneNumber	✔ 雇用主の作成
countrySpecificAttributes.sectorSUIDs	✔ 雇用主の作成	Company sector の該当する SUID 値を指定します。
employerAttributes.employerType	✔ 雇用主の作成と更新	EmployerType の適切な enum 値を使用します。 エンティティが JURIDICAL_PERSON の場合は、countrySpecificAttributes に taxId を設定します。 このフィールドは会社を識別します。
localeSpecificAttributes.country	✔ 雇用主の作成と更新	JP に設定します。
localeSpecificAttributes.language	✔ 雇用主の作成と更新
localeSpecificAttributes.isGlobalDefault	✔ Create and update employer
localeSpecificAttributes.headquarterAddress	✔ 雇用主の作成
localeSpecificAttributes.localizedName		危険 isGlobalDefault: true と localizedName: null を同時に設定すると、デフォルト名が削除されます。

雇用主送信の例

これらの例は、patchEmployer を使用して雇用主を作成する方法を示しています。

例 1: 新しい雇用主を送信する

雇用主を作成する際は、必須フィールドに加えて、持っている任意フィールドも送信できます。

mutation CreateEmployerExample {
  patchEmployer(input: {
    id: {
      type: "YOUR_ATS_TYPE_FROM_INDEED"
      id: "EMPLOYER_123"
    }
    employerName: "株式会社テストその１"
    employerAttributes: {
      countrySpecificAttributes: [{
        country: "JP"
        phoneNumber: "+810312345678"
        sectorSUIDs: ["CS9YK"]
      }]
      localeSpecificAttributes: [{
        country: "JP"
        language: "ja"
        isGlobalDefault: true
        headquarterAddress: "東京都千代田区丸の内1-9-2"
      }]
    }
  }) {
    responseCode
  }
}

例 2: 雇用主情報を追加または更新する

例 1 に示すように雇用主データを送信した後で、フィールドを追加または更新できます。更新の動作について詳しくは、更新の動作 をご覧ください。

この例では、例 1 と同じ id.type と id.id の値を使用するため、同じ雇用主を更新します。countrySpecificAttributes.phoneNumber を新しい値に更新し、localeSpecificAttributes.description を追加しています。

mutation PatchEmployerPhoneNumberAndDescription {
  patchEmployer(input: {
    id: {
      type: "YOUR_ATS_TYPE_FROM_INDEED"
      id: "EMPLOYER_123"
    }
    # Same id as in Example 1
    employerAttributes: {
      countrySpecificAttributes: [{
        country: "JP"
        #(phoneNumber) Modify an already - populated field
        phoneNumber: "+810323456789"
      }]
      localeSpecificAttributes: [{
        country: "JP"
        language: "ja"
        isGlobalDefault: true
        #(description) Add a new field
        description: "2004年に創業してから、世界中の人々の生活をサポートし続けてきました。人種・国籍問わず活躍できる職場を実現するための数々の施策に取り組んでおります。"
      }]
    }
  }) {
    attributeUpdated
    responseCode
  }
}

求職者に表示される日本向けフィールド

これらの雇用主フィールドは、日本の Indeed PLUS 求人ボードで求職者に表示される場合があります。これらのフィールドは、patchEmployer ミューテーションに渡す PatchEmployerInput の一部です。

求人ボードの UX は変更される可能性があるため、この一覧が最新でない場合があります。一部のフィールドはページに直接表示されません。ボタンの背後に表示されたり、別の形で UX に影響したりする場合があります。

対象のフィールドは次のとおりです。

• employerName
• employerAttributes
  • countrySpecificAttributes
    • websiteUrl
    • phoneNumber
    • sectorSUIDs (SUID 値のラベル)
  • localeSpecificAttributes
    • localizedName
    • phoneticName
    • description
    • headquarterAddress
  • leader
    • name

エラーをトラブルシューティングする

よくある問題

• 認証エラー: OAuth トークンと権限を確認してください。
• 検証エラー: 対象国に必要なフィールドを確認してください。
• レート制限: リクエストを再試行する際は、指数バックオフを使用してください。

詳しいトラブルシューティングについては、次をご覧ください。

• OAuth エラー
• GraphQL エラー

 

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