Greenhouse v3オブジェクト対応範囲
このガイドでは、Greenhouse v3のアクションとトリガーでサポートされるオブジェクトについて説明します。 オブジェクトの利用可否はアクションによって異なり、すべてのv1オブジェクトがv3で利用できるわけではありません。
このガイドは次の目的で使用します:
- 各アクションとトリガーでサポートされるオブジェクトの特定
- v1とv3のオブジェクト対応範囲の違いの理解
- レシピをv3に移行する際の更新の計画
アクション対応範囲
アクション別にサポートされるオブジェクトについては、次のセクションを参照してください:
オブジェクトの検索(v3)
オブジェクトの検索 (v3) アクションは、Greenhouse v3エンドポイントからレコードを検索し、一致するオブジェクトのページ分割されたリストを返します。
サポートされるオブジェクト
次のオブジェクトがサポートされています:
- 応募
- 応募ステージ
- 添付ファイル
- 候補者
- クローズ理由
- カスタムフィールド部門
- カスタムフィールドオフィス
- カスタムフィールドオプション
- カスタムフィールド
- 部門
- 面接
- ジョブ採用マネージャー
- ジョブ面接ステージ
- ジョブ所有者
- ジョブ投稿
- ジョブ
- オファー
- オフィス
- 求人枠
- 見込み候補者プール
- 紹介者
- スコアカード
- ソース
- ユーザーメール
- ユーザー
共通入力パラメーター
サポート対象オブジェクトで共通して利用できる入力フィールドは次のとおりです:
| 入力フィールド | タイプ | 説明 |
|---|---|---|
| オブジェクト | 選択リスト | 検索するオブジェクトタイプを選択します。 |
| IDs | 配列(整数) | 特定のレコードIDでフィルターします。 |
| 作成日時(開始/終了) | 日付/時刻 | 作成日の範囲でフィルターします。 |
| 更新日時(開始/終了) | 日付/時刻 | 最終更新日の範囲でフィルターします。 |
| ページあたり | 整数 | ページあたりのレコード数。 |
| カーソル | 文字列 | 次のページのページネーションカーソル。 |
追加フィールドはオブジェクトタイプによって異なります。 サポートされている場合は、次のオブジェクト別フィールドを使用します。
応募
Applicationsオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| ジョブID | 関連付けられたジョブIDでフィルターします。 |
| 候補者ID | 関連付けられた候補者IDでフィルターします。 |
| ステージID | 応募ステージIDでフィルターします。 |
| ソースID | ソースIDでフィルターします。 |
| Status | 応募ステータスでフィルターします。 |
| 見込み候補者 | 見込み候補者ステータスでフィルターします。 |
| 最終アクティビティ日時(開始/終了) | 最終アクティビティ日の範囲でフィルターします。 |
候補者
Candidatesオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| メール | 候補者のメールでフィルターします。 |
| タグ | 候補者タグでフィルターします。 |
| 非公開 | 非公開候補者ステータスでフィルターします。 |
| 最終アクティビティ日時(開始/終了) | 最終アクティビティ日の範囲でフィルターします。 |
| カスタムフィールドオプションID | カスタムフィールドオプションでフィルターします。 |
面接
Interviewsオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 応募ID | 関連付けられた応募IDでフィルターします。 |
| 候補者ID | 関連付けられた候補者IDでフィルターします。 |
| ジョブID | 関連付けられたジョブIDでフィルターします。 |
| ジョブ面接ID | ジョブ面接IDでフィルターします。 |
| 主催者ID | 主催者IDでフィルターします。 |
| 開始日時(開始/終了) | 面接開始時間の範囲でフィルターします。 |
| 終了日時(開始/終了) | 面接終了時間の範囲でフィルターします。 |
| 外部イベントID | 外部カレンダーイベントIDでフィルターします。 |
ジョブ
ジョブオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| Status | ジョブステータスでフィルターします。 |
| 部門ID | 部門IDでフィルターします。 |
| オフィスID | オフィスIDでフィルターします。 |
| 機密 | 機密ジョブでフィルターします。 |
| 求人依頼ID | 採用申請IDでフィルターします。 |
オファー
Offersオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 応募ID | 関連付けられた応募IDでフィルターします。 |
| ジョブID | 関連付けられたジョブIDでフィルターします。 |
| 候補者ID | 関連付けられた候補者IDでフィルターします。 |
| Status | オファーステータスでフィルターします。 |
| 送信日(開始/終了) | 送信日の範囲でフィルターします。 |
| 開始日(開始/終了) | 開始日の範囲でフィルターします。 |
| 解決日時(開始/終了) | 解決日の範囲でフィルターします。 |
スコアカード
Scorecardsオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 応募ID | 関連付けられた応募IDでフィルターします。 |
| 候補者ID | 関連付けられた候補者IDでフィルターします。 |
| 面接キットID | 面接キットIDでフィルターします。 |
| 提出者ID | 提出者IDでフィルターします。 |
| 面接官ID | 面接官IDでフィルターします。 |
| Status | スコアカードステータスでフィルターします。 |
| 面接日時(開始/終了) | 面接日の範囲でフィルターします。 |
| 提出日時(開始/終了) | 提出日の範囲でフィルターします。 |
オブジェクトの作成(v3)
オブジェクトの作成 (v3) アクションは、Greenhouseに新しいレコードを作成します。
サポート対象オブジェクト
次のオブジェクトがサポートされています:
- 候補者
- 候補者メモ
- 候補者の学歴
- 候補者の職歴
- 候補者の応募
- ジョブ
- ユーザー
候補者
Candidateオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 名 | 候補者の名を指定します。 |
| 姓 | 候補者の姓を指定します。 |
| 優先名 | 候補者の希望名を指定します。 |
| タイムゾーン | 候補者のタイムゾーンを指定します。 |
| 会社 | 候補者の現在の会社を指定します。 |
| タイトル | 候補者の現在の役職を指定します。 |
| メール可 | 候補者がメールを受信できるかどうかを指定します。 |
| 電話番号 | 電話番号のリストを指定します。 |
| 住所 | 住所のリストを指定します。 |
| メールアドレス | メールアドレスのリストを指定します。 |
| Webサイトアドレス | WebサイトURLのリストを指定します。 |
| ソーシャルメディアアドレス | ソーシャルメディアプロフィールのリストを指定します。 |
| タグ | 候補者に割り当てるタグのリストを指定します。 |
| リンク済みユーザーID | 候補者に関連付けるユーザーIDを指定します。 |
| カスタムフィールド | フィールドトークンをキーにしたカスタムフィールド値を指定します。 |
| アプリケーション | 関連付けられた応募を作成するための応募詳細を指定します。 |
応募(候補者内にネスト)
Applicationオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| ジョブID | 応募を作成する際にジョブIDを指定します。 |
| 見込み候補者 | 候補者が見込み候補者かどうかを指定します。 |
| 見込み候補者プールID | 見込み候補者プールIDを指定します。 |
| 見込み候補者プールステージID | 見込み候補者プールステージIDを指定します。 |
| 見込み候補者所有者ID | 見込み候補者所有者のユーザーIDを指定します。 |
| ソースID | ソースIDを指定します。 |
| 採用担当者ID | 採用担当者のユーザーIDを指定します。 |
| コーディネーターID | コーディネーターのユーザーIDを指定します。 |
| 紹介者ID | 紹介者のユーザーIDを指定します。 |
| 初期ステージID | 初期応募ステージIDを指定します。 |
候補者メモ
Candidate noteオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 候補者ID | 候補者IDを指定します。 |
| Application ID | 応募IDを指定します。 |
| 本文 | メモの内容を指定します。 |
| 件名 | メモの件名を指定します。 |
| メモタイプ | メモタイプを指定します。 |
| ユーザーID | 作成者のユーザーIDを指定します。 |
| メール送信元 | 送信者のメールアドレスを指定します。 |
| メール宛先 | 受信者のメールアドレスを指定します。 |
| メールCC | CCのメールアドレスを指定します。 |
| 表示設定 | 可視性を指定します。 |
候補者の学歴
Candidate educationオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 候補者ID | 候補者IDを指定します。 |
| 学校名 | 学校名を指定します。 |
| 学位 | 学位を指定します。 |
| 専攻分野 | 専攻分野を指定します。 |
| 開始日 | 開始日を指定します。 |
| 終了日 | 終了日を指定します。 |
候補者の職歴
Candidate employmentオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 候補者ID | 候補者IDを指定します。 |
| 会社名 | 会社名を指定します。 |
| タイトル | 役職を指定します。 |
| 開始日 | 開始日を指定します。 |
| 終了日 | 終了日を指定します。 |
ジョブ
Jobオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| テンプレートジョブID | 設定のコピー元となるテンプレートジョブIDを指定します。 |
| 求人枠数 | 求人枠数を指定します。 |
| ジョブ名 | 内部ジョブ名を指定します。 |
| ジョブ投稿名 | ジョブ投稿名を指定します。 |
| メモ | 内部メモを指定します。 |
| 部門ID | 部門IDを指定します。 |
| 外部部門ID | 外部部門IDを指定します。 |
| オフィスID | オフィスIDを指定します。 |
| 外部オフィスID | 外部オフィスIDを指定します。 |
| 求人依頼ID | 採用申請IDを指定します。 |
| 求人枠ID | 求人枠IDを指定します。 |
| カスタムフィールド | フィールドトークンをキーにしたカスタムフィールド値を指定します。 |
ユーザー
Userオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| 名 | ユーザーの名を指定します。 |
| 姓 | ユーザーの姓を指定します。 |
| Primary email | ユーザーのメールアドレスを指定します。 |
| 従業員ID | 従業員IDを指定します。 |
| 役職 | 役職を指定します。 |
| 代理店ID | 代理店IDを指定します。 |
| オフィスID | 関連付けられたオフィスIDを指定します。 |
| 部門ID | 関連付けられた部門IDを指定します。 |
オブジェクトの更新(v3)
オブジェクトの更新 (v3) アクションは、Greenhouseの既存のレコードを更新します。 オブジェクトタイプとレコードIDを指定します。
サポート対象オブジェクト
次のオブジェクトがサポートされています:
- 候補者
- 候補者の応募
- ジョブ
- ユーザー
候補者
Candidateオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| ID | 候補者IDを指定します。 |
| Createのすべての候補者フィールド | Create objectアクションの任意の候補者フィールドを指定します。 指定したフィールドのみが更新されます。 |
候補者の応募
Candidate applicationオブジェクトでは、次の追加フィールドがサポートされています:
| パラメーター | 説明 |
|---|---|
| ID | 応募IDを指定します。 |
| ソースID | ソースIDを指定します。 |
| 紹介者ID | 紹介者IDを指定します。 |
| 採用担当者ID | 採用担当者IDを指定します。 |
| コーディネーターID | コーディネーターIDを指定します。 |
| 見込み候補者プールID | 見込み候補者プールIDを指定します。 |
| 見込み候補者プールステージID | 見込み候補者プールステージIDを指定します。 |
| 不採用日時 | 不採用日を指定します。 |
| 作成日時 | 作成日時を指定します。 |
| カスタムフィールド | フィールドトークンをキーにしたカスタムフィールド値を指定します。 |
ジョブ
Jobオブジェクトでは、次の追加フィールドがサポートされています:
| 入力フィールド | 説明 |
|---|---|
| ID | ジョブIDを指定します。 |
| Createのすべてのジョブフィールド | Create objectアクションの任意のジョブフィールドを指定します。 指定したフィールドのみが更新されます。 |
ユーザー
Userオブジェクトでは、次の追加フィールドがサポートされています:
| 入力フィールド | 説明 |
|---|---|
| ID | ユーザーIDを指定します。 |
| Createのすべてのユーザーフィールド | Create objectアクションの任意のユーザーフィールドを指定します。 指定したフィールドのみが更新されます。 |
添付の作成(v3)
添付ファイルの作成 (v3) アクションは、ファイル添付を応募にアップロードします。
入力
次の入力フィールドを利用できます:
| 入力フィールド | 説明 |
|---|---|
| Application ID | ファイルを添付する応募IDを指定します。 |
| ファイル名 | 拡張子を含むファイル名を指定します。 |
| タイプ | 添付タイプを指定します。 |
| コンテンツ | ファイルコンテンツをBase64エンコード文字列として指定します。 URLが指定されていない場合は必須です。 |
| URL | 直接ファイルURLを指定します。 Contentが指定されていない場合は必須です。 |
| 表示設定 | 可視性設定を指定します。 |
応募の移動(v3)
応募の移動 (v3) アクションは、応募を別のステージに移動するか、別のジョブに転送します。
入力
次の入力フィールドを利用できます:
| 入力フィールド | 説明 |
|---|---|
| Application ID | 移動する応募IDを指定します。 |
| From stage ID | 応募の現在のステージIDを指定します。 |
| 移動先ステージID | 同じジョブ内の移動先ステージIDを指定します。 これを使用して、応募をパイプライン内で前後に移動します。 |
| 移動先ジョブID | 応募を別のジョブに転送する移動先ジョブIDを指定します。 |
| メール送信元ユーザーID | 通知メールを送信するユーザーIDを指定します。 |
応募の不採用(v3)
応募の却下 (v3) アクションは、応募を却下し、必要に応じて却下メールを送信します。
入力
次の入力フィールドを利用できます:
| 入力フィールド | 説明 |
|---|---|
| Application ID | 不採用にする応募IDを指定します。 |
| 却下理由ID | 不採用理由IDを指定します。 |
| メモ | 不採用に関する内部メモを指定します。 |
| メール送信日時 | 不採用メールを送信する日時を指定します。 |
| メールテンプレートID | 不採用メールに使用するメールテンプレートIDを指定します。 |
| メール送信元ユーザーID | 不採用メールを送信するユーザーIDを指定します。 |
| カスタムフィールド | カスタムフィールド値を指定します。 各項目にはフィールド識別子と値を含める必要があります。 |
候補者を採用済みにマーク(v3)
候補者を採用済みにマーク (v3) アクションは、応募を採用済みとしてマークし、必要に応じて開始日、オープニング、およびクローズ理由を割り当てます。
入力
次の入力フィールドを利用できます:
| 入力フィールド | 説明 |
|---|---|
| Application ID | 採用済みとしてマークする応募IDを指定します。 |
| 開始日 | 候補者の開始日を指定します。 |
| 求人枠ID | 採用に関連付ける求人枠IDを指定します。 |
| クローズ理由ID | 採用のクローズ理由IDを指定します。 |
トリガー対応範囲
トリガー別にサポートされるオブジェクトについては、次のセクションを参照してください:
新規オブジェクト(v3)
新規オブジェクト (v3) トリガーは、Greenhouseで新しいレコードが作成されたときに起動します。 カーソルベースのポーリングを使用します。
サポート対象オブジェクト
次のオブジェクトがサポートされています:
- 候補者
- 応募
- 面接
入力
次の入力フィールドを利用できます:
| 入力フィールド | 説明 |
|---|---|
| オブジェクト | 監視するオブジェクトタイプを選択します。 |
| 開始日 | 初回取得の開始タイムスタンプを指定します。 デフォルトは初回実行の1時間前です。 |
出力
選択したオブジェクトタイプの完全なオブジェクトフィールドを返します。
新規/更新済みオブジェクト(v3)
新規/更新済みオブジェクト (v3) トリガーは、Greenhouseでレコードが作成または更新されたときに起動します。 レコードをバッチで返します。
サポート対象オブジェクト
次のオブジェクトがサポートされています:
- 候補者
- 応募
- ジョブ投稿
- ジョブ
- オファー
- 面接
- スコアカード
入力
次の入力フィールドを利用できます:
| 入力フィールド | 説明 |
|---|---|
| オブジェクト | 監視するオブジェクトタイプを選択します。 |
| 開始 | 初回取得の開始タイムスタンプを指定します。 デフォルトは初回実行の1時間前です。 |
| バッチサイズ | バッチあたりのレコード数を指定します。 |
出力
選択したオブジェクトタイプの完全なオブジェクトフィールドを返します。
レガシー(v1)からv3へのマッピング
このセクションでは、レガシー(v1)アクションとトリガーがv3の同等機能にどのように対応するかを説明します。
アクション
次のマッピングでは、レガシー(v1)アクションがv3アクションおよびサポート対象オブジェクトにどのように対応するかを説明します。
Create object(v1)とCreate object(v3)
v3のCreate objectアクションは、サポート対象エンティティ全体のオブジェクト作成を統合して標準化します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| 候補者 | 候補者 |
| 候補者メモ | 候補者メモ |
| 候補者の学歴 | 候補者の学歴 |
| 候補者の職歴 | 候補者の職歴 |
| 候補者の応募 | 候補者の応募 |
| ジョブ | ジョブ |
| ユーザー | ユーザー |
候補者メールメモにはv3の同等機能がありません。
Update object(v1)とUpdate object(v3)
v3のUpdate objectアクションは作成と同じオブジェクトモデルを使用し、指定したフィールドのみを更新します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| 候補者 | 候補者 |
| アプリケーション | 候補者の応募 |
| ジョブ | ジョブ |
| ユーザー | ユーザー |
Search objects(v1)とSearch objects(v3)
v3のSearch objectsアクションはオブジェクト対応範囲を拡張し、統一された検索インターフェースを導入します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| 候補者 | 候補者 |
| アプリケーション | 応募 |
| ジョブ | ジョブ |
| オファー | オファー |
| ユーザー | ユーザー |
| スコアカード | スコアカード |
| 見込み候補者プール | 見込み候補者プール |
Degree、School、およびDisciplineには直接のv3検索エンドポイントがありません。
Upload attachment(v1)とCreate attachment(v3)
v3のCreate attachmentアクションは、応募へのファイルアップロードをサポートします。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| 応募の添付 | 添付ファイル |
候補者の添付には直接のv3同等機能がありません。
Advance application(v1)とMove application(v3)
v3のMove applicationアクションはadvance applicationに置き換わり、ステージ移動とジョブ転送をサポートします。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| アプリケーション | アプリケーション |
Reject application(v1)とReject application(v3)
v3のReject applicationアクションは同じ主要な動作を維持し、任意のメール制御を追加します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| アプリケーション | アプリケーション |
Mark candidate as hired(v1)とMark candidate as hired(v3)
v3のMark candidate as hiredアクションは同じ動作を維持し、開始日や求人枠などの任意フィールドを追加します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| アプリケーション | アプリケーション |
トリガー
次のマッピングでは、レガシー(v1)トリガーがv3トリガーおよびサポート対象オブジェクトにどのように対応するかを説明します。
New object(v1)とNew object(v3)
v3トリガーは、カーソルベースのポーリングで新規作成されたレコードを検出します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| 候補者 | 候補者 |
| アプリケーション | アプリケーション |
| スケジュール済み面接 | スケジュール済み面接 |
New/updated object(v1)とNew/updated object(v3)
v3トリガーは、作成および更新されたレコードを検出し、結果をバッチで返します。
次の表は、v1オブジェクトがv3にどのように対応するかを示しています:
| v1オブジェクト | v3オブジェクト |
|---|---|
| 候補者 | 候補者 |
| アプリケーション | アプリケーション |
| ジョブ投稿 | ジョブ投稿 |
| ジョブ | ジョブ |
| オファー | オファー |
| スケジュール済み面接 | スケジュール済み面接 |
| スコアカード | スコアカード |
Last updated: