Search APIでカスタムのPipelineとDealStageを文字列で取得する方法について

[so79]

現在、HubSpotのSearch APIを使用して取引（deals）の情報を取得しています。しかし、カスタム作成したPipelineとDealStageの値が内部ID（数値）で返されることに気づきました。デフォルトのパイプラインではこれらの値は文字列で返されるため、私のカスタム作成したPipelineとDealStageも同様に文字列で取得する方法を探しています。カスタムパイプラインのPipelineとDealStageを文字列で取得するにはどのような手順や設定が必要か教えていただけますでしょうか？

例:

```
Received response:

{Results:[

{Properties:{RecordID:16362668610 PromotionURL: Pipeline:default DealStage:appointmentscheduled}}

{Properties:{RecordID:16363434033 PromotionURL:あとで入れる Pipeline:default DealStage:qualifiedtobuy}}

{Properties:{RecordID:16363435028 PromotionURL:https://www.yahoo.co.jp/
https://www.google.co.jp/ Pipeline:68546190 DealStage:133171124}} {Properties:{RecordID:16363492937 PromotionURL:https://robertsspaceindustries.com/ Pipeline:68625705 DealStage:133243016}}] Paging:<nil>}
```

最初の2件は文字列で返ってくるが、残りは内部IDらしきものが返ってきている

[so79]

@natsumimori @skimura 

ありがとうございます。

参考にさせていただきます。

[skimura · Accepted solution]

@so79 

APIはいずれもパイプライン、ステージの内部値を返却していると思います。

その上で

デフォルトのパイプライン、ステージの内部値が文字列で

カスタムで作成したパイプライン、ステージの内部値が数字になっていると思われます。

下記の手順で対象のパイプラインとステージの内部値を確認できます。

取引のパイプラインページを開く

https://app.hubspot.com/pipelines-settings/{ポータルID}/object/0-3/default

確認したいパイプラインの内部値を確認する

確認したいステージの内部値を確認する

検証のため上記のパイプラインにカスタムのステージを作成したところ

内部値は数字でした。

APIでパイプライン、ステージの値を取得すると内部値を扱うことになりますので

パイプライン、ステージを文字列で扱うには下記の方法があると思います。

静的：API呼び出し元で [名称：内部値」の情報（辞書）を持っておく。

（上記のページでパイプライン、ステージの内部値を確認して辞書を作成）

動的：パイプラインAPIで特定のパイプラインのステージ一覧情報を取得して

ラベル（文字列）でフィルターして内部値をさがす。

https://developers.hubspot.jp/docs/api/crm/pipelines

参考になれば幸いです。

よろしくお願いします。

@natsumimori 

知らせていただきありがとうございます。

[natsumimori]

@so79 さん、コミュニティーへのご相談ありがとうございます。

API関係なので、@skimura さん, @shizaki さん, メンションさせてください🙏

こちらのご相談にアドバイス・ナレッジを共有いただけないでしょうか？