Employer Data API

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

 

概要

Employer Data API を使用すると、ATS パートナーは Indeed および Indeed PLUS プラットフォーム上で採用企業レコードを作成および更新できます。

Indeed における採用企業は、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 はグローバルデフォルトを返します。

採用企業を作成する

採用企業を作成するには、patchEmployer GraphQL ミューテーションを使用します。採用企業に関連付けられた求人を作成する前に、採用企業データを送信する必要があります。

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

リクエスト

採用企業データを送信するには、PatchEmployerInput オブジェクトを渡して patchEmployer を呼び出します。

• id: グローバルに一意の採用企業識別子です。このオブジェクトには次のフィールドが含まれます。
  • type: Indeed システム内でお使いの ATS を識別します。Indeed がセットアップ時にこの値を作成して提供します。patchEmployer のすべての呼び出しで同じ値を使用してください。
  • id: お使いの ATS 内で採用企業を識別します。これはお客様の採用企業識別子です。暗号化またはハッシュ化するパートナーもいます。採用企業を更新するすべての呼び出しで同じ値を使用してください。別の採用企業を更新する場合は、その採用企業の識別子を使用します。
• employerName: スキーマでは任意フィールドですが、採用企業を作成するときは指定が必要です。Indeed は、リクエストで グローバル の localizedName を直接設定しない限り、employerName の値を グローバル の 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 を呼び出します。PatchEmployerInput には次のフィールドが含まれます。

• id: グローバルに一意の採用企業識別子です。このオブジェクトには次のフィールドが含まれます。
  • type: Indeed システム内でお使いの ATS を識別します。Indeed がセットアップ時にこの値を作成して提供します。patchEmployer のすべての呼び出しで同じ値を使用してください。
  • id: お使いの ATS 内で採用企業を識別します。これはお客様の採用企業識別子です。暗号化またはハッシュ化するパートナーもいます。その採用企業を更新するすべての呼び出しで同じ値を使用してください。別の採用企業を更新する場合は、その採用企業の識別子を使用します。
• 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エラー

 

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