見積もりテンプレートの変数

Last updated:

カスタムの見積もりテンプレートから直接、見積もりデータと一部の関連オブジェクトにアクセスできます。利用可能なデータは、CRM内にあるデータと、見積もり自体に追加されたデータによって異なります。

見積もりテンプレートを開発する際には、HubSpotが提供しているモックデータを使用してテンプレートに値を取り込むことができます。テンプレートをプレビューする際は、モックデータを取り込むと役立ちます。@hubspotフォルダー内にあるcms-quotes-themeフォルダーに移動します。templatesフォルダー内にあるbasic.html、modern.html、またはoriginal.htmlテンプレートを表示します。これらのテンプレートの先頭には、以下のコードブロックが含まれています。

{% from "../imports/mock_data.html" import SAMPLE_TEMPLATE_DATA as mock_data %} {% from "../imports/module_defaults.html" import MODULE_DEFAULTS as module_defaults %} {% set QUOTE = template_data.quote || mock_data.quote %} {% set CURRENCY = QUOTE.hs_currency || "USD" %} {% set LOCALE = QUOTE.hs_locale || "en-US" %} {% set ASSOCIATED_OBJECTS = QUOTE.associated_objects %} {% set LINE_ITEMS = ASSOCIATED_OBJECTS.line_items %} {% set ADDITIONAL_FEES = ASSOCIATED_OBJECTS.additional_fees %} {% set TOTALS = ASSOCIATED_OBJECTS.totals || ASSOCIATED_OBJECTS.totals %} {% set QUOTE_TOTAL = TOTALS.total %} {% set SUB_TOTALS = TOTALS.subtotals %} {% set DEAL = ASSOCIATED_OBJECTS.deal %}

モックデータはmock_data.htmlファイルからインポートされた後、template_data内のデータ（存在する場合）を使用するためにQUOTE変数に設定されます。QUOTE変数は、上記にリストされている他の変数（ASSOCIATED_OBJECTSなど）に値を取り込むためにも使用されます。これにより、簡単なコードで該当のデータににアクセスできます。ただし、好みに応じて別の方法でデータを構造化することもできます。

上記のコードでは、メインのQUOTE変数を設定するためにtemplate_dataも使用されています。template_dataは、ページ内の見積もりと取引の実データの全てを格納するオブジェクトです。このオブジェクトがテンプレート内で見つからない場合、HubSpotは代わりにmock_data.htmlからデータを読み込みます。

template_dataオブジェクト

template_dataオブジェクトを介してほとんどのデータに、直接アクセスできます。提供されているオブジェクト全体を確認するには、テンプレート内で{{ template_data|pprint }}を使用します。 

テンプレート データ オブジェクトのパラメーター
変数TypeDescription
template_data
dict

quote、quote.associated_objects、および合計dict数を格納するdict

見積もりの変数

この見積もりにおける固有の情報

テンプレート データ オブジェクトのパラメーター
変数TypeDescription
template_data.quote
dict

見積もり自体の全てのデータを格納するdict

template_data.quote.associated_objects.deal.hs_object_id
Integer

取引ID

template_data.quote.hubspot_owner_id
Integer

取引担当者ID

template_data.quote.hs_all_owner_ids
integer or array of integers

全ての取引担当者ID

template_data.quote.hs_created_by_user_id
Integer

見積もりを作成したユーザー

template_data.quote.hs_lastmodifieddate
datetime

見積もりが最後に更新された日付エポック形式

template_data.quote.hubspot_owner_assigneddate
datetime

見積もりに担当者が割り当てられた日付エポック形式

template_data.quote.hs_createdate
datetime

見積もりが作成された日時エポック形式

template_data.quote.hs_expiration_date
datetime

見積もりの有効期限が切れる日付エポック形式

template_data.quote.hs_title
String

見積もりのタイトル

template_data.quote.hs_template_type
String

"CUSTOMIZABLE_QUOTE_TEMPLATE"

template_data.quote.hs_slug
String

見積もりウェブページのURLスラッグ

template_data.quote.hs_proposal_template_path
String

デベロッパー ファイル システムでのテンプレートのパス（ファイル拡張子を含む）

template_data.quote.hs_quote_amount
String

金額

template_data.quote.hs_currency
String

見積もり金額の通貨（3文字のISO 4217通貨コード形式）
"USD"

template_data.quote.hs_language
String

言語コード
"en"

template_data.quote.hs_locale
String

ロケールコード
"en-us"

template_data.quote.hs_terms
String

見積もり作成者が指定した条件テキスト

template_data.quote.hs_sender_firstname
String

見積もりの送信者の名

template_data.quote.hs_sender_company_name
String

見積もりの送信者の会社名

template_data.quote.hs_sender_company_image_url
String

見積もりの送信者の会社ロゴ

template_data.quote.hs_status
String

見積もりのステータス
"APPROVAL_NOT_NEEDED"

template_data.quote.hs_primary_color
string/hex color code

"#425b76"

template_data.quote.hs_quote_number
String

一意の見積もりID番号

template_data.quote.hs_payment_enabled
boolean

支払いフィールドを表示する必要があるかどうかをテストするために使用

template_data.quote.hs_esign_enabled
boolean

電子署名フィールドを表示する必要があるかどうかをテストするために使用

お探しの変数が見つかりませんか？
template_data内で他の変数にもアクセスできます。これらを表示するには、|pprintをご利用ください。また、見積もりの関連付けに含まれる一部の変数は、見積もり／取引に基づいてのみ使用できます。 

今後もこのドキュメントで、アクセスできる他のデータに関する情報をご紹介していきます。プリティープリントに加え、cms-quote-theme内にあるモック データ ファイルを表示して、利用可能なデータとその構造を確認することもできます。

関連オブジェクト

見積もりテンプレート内ではassociated_objectsを使用して、見積もりに関連付けられているレコード内のデータ（取引、会社など）にアクセスできます。

例えば次のコードを使用すると、見積もりの受信者に関連付けられている会社レコード内の会社ロゴを見積もりに追加できます。

{% set company_avatar_url = template_data.quote.associated_objects.company.hs_avatar_filemanager_key %} {% if company_avatar_url %} <img src="{{ template_data.quote.associated_objects.company.hs_avatar_filemanager_key }}" width="400" alt="{{ template_data.quote.associated_objects.company.name }}"> {% else %} <!-- company does not have an assigned image--> {% endif %}

注：表示されるロゴは、手動で設定されたものに限られます。意図しないロゴが見積もりテンプレートに表示されるのを防ぐために、自動的に検出されたロゴは表示されません。

上記のコードでは、最初に設定している変数により、見積もりに関連付けられている会社のロゴを検索します。次に、ifステートメントを使用して、検出されたロゴをテンプレートに表示します（利用可能な場合）。会社のロゴが手動で設定されていない場合、ロゴは表示されません。

カスタムオブジェクト

カスタム オブジェクト データを見積もり内で表示または使用するには、いくつかの方法があります。カスタムオブジェクトの構造はそれぞれに異なる場合があるため、カスタムオブジェクトをどのように構造化したかに基づいて特定のプロパティーを取得する必要があります。

既定では、見積もりtemplate_data内でカスタムオブジェクトが関連付けられます。例えば、取引に関連付けられたカスタムオブジェクトが含まれます。

これらのオブジェクトにアクセスするには、次のコードを使用します。

{% set quote_associated_custom_objects = template_data.quote.associated_objects.deal.associated_objects.custom_objects %} {{ quote_associated_custom_objects|pprint }} {# |pprint is useful for understanding the structure of the data, you can leave it off when outputting values for display. #}

注:カスタムオブジェクトは各アカウントに固有であるため、モックデータにサンプル カスタム オブジェクトは含まれていません。つまり、デザインマネージャーでテンプレートをプレビューする際にエラーが表示される場合があります。あるいは、カスタム オブジェクト データが表示されません。代わりに、テンプレートから見積もりを作成して、実際のCRMデータを使用してテンプレートをプレビューする必要があります。

カスタムオブジェクトの末尾にアンダースコアを使用して書式設定したカスタム オブジェクト タイプIDを追加することにより、各カスタム オブジェクト タイプにアクセスできるようになります。以下に例を示します。

template_data.quote.associated_objects.deal.associated_objects.custom_objects._2_2193031

crm_associations()関数とcrm_objects()関数を使用して、カスタムオブジェクトを検索することもできます。 

例えば、取引に関連付けられているカスタムオブジェクトを検索する場合は、次のようにtemplate_dataからデータを渡します。

{% set quote_associated_object = crm_associations(template_data.quote.associated_objects.deal.hs_object_id, "USER_DEFINED", 152) %} {# 152 is an example of an association type id, you would need to use the appropriate id for your use-case. #} {{ quote_associated_object }}

関連コンテンツ

参考になりましたか？
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。