Employer Data API

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

 

概要

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

雇用主 は、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: スキーマでは任意ですが、雇用主を作成するときは必須です。Indeed は、グローバルの localizedName を直接設定しない限り、この値をグローバルの 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 ミューテーションを使用して雇用主属性を更新します。雇用主データを更新する前に、先に雇用主を作成する必要があります。

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

リクエスト

PatchEmployerInput オブジェクトを指定して patchEmployer を呼び出します。次のフィールドがあります。

• id: 一意の雇用主識別子です。次のフィールドがあります。
  • type: Indeed でお使いの ATS を識別します。Indeed がセットアップ時にこの値を提供します。すべての patchEmployer 呼び出しで同じ値を使用します。
  • id: ATS 内で雇用主を識別します。これは雇用主 ID です。暗号化またはハッシュ化するパートナーもいます。その雇用主を更新するときは毎回同じ値を使用します。別の雇用主を更新する場合は、その雇用主の ID を使用します。
• employerName: 更新する場合にだけ指定する任意フィールドです。このフィールドを更新すると、Indeed は、グローバルの localizedName を直接設定しない限り、その値をグローバルの 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	✔ 雇用主の作成	Indeed は、リクエストでグローバルの localizedName を明示的に設定しない限り、employerName の値をグローバルの localizedName フィールドにコピーします。
countrySpecificAttributes.country	✔ 雇用主の作成と更新	このフィールドは JP に設定します。
countrySpecificAttributes.phoneNumber	✔ 雇用主の作成
countrySpecificAttributes.sectorSUIDs	✔ 雇用主の作成	企業セクター から該当する SUID 値を指定します。
employerAttributes.employerType	✔ 雇用主の作成と更新	EmployerType の正しい列挙値を使用します。 エンティティが JURIDICAL_PERSON の場合は、taxId を countrySpecificAttributes に設定します。 このフィールドは会社を識別します。
localeSpecificAttributes.country	✔ 雇用主の作成と更新	このフィールドは JP に設定します。
localeSpecificAttributes.language	✔ 雇用主の作成と更新
localeSpecificAttributes.isGlobalDefault	✔ 雇用主の作成と更新
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 エラー

 

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