HubL関数
HubLの関数は、パラメーターを受け入れて値を生成するという点でフィルターに似ています。ただし、全ての関数を初期テンプレート値に適用する必要はなく、HubSpot環境の他の領域とのやりとりに使用できます。
古いウェブサイトを維持している場合は、非推奨となったHubL関数のリストもご確認ください。
この記事では、各HubL関数とその構文についての詳細を確認できます。
blog_all_posts_url
関数は、指定されたブログ内の全てのブログ記事のリストページを指す完全なURLを返します。
以下の例は、この関数をアンカーのhref
として使用する方法を示しています。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。ブログIDはモジュールのブログフィールドによって返されます。 |
blog_author_url
関数は、指定されたブログ執筆者のリストページを指す完全なURLを返します。
以下の例は、この関数をアンカーのhref
として使用する方法を示しています。これをblog_authors
関数と組み合わせる例については、blog_authors関数の説明を参照してください。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | 執筆者のリストページがどのブログにあるかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
author_slug
| 文字列型またはHubL変数 | どの執筆者にリンクするかを指定します。 |
blog_authors
は、指定されたブログのブログ執筆者オブジェクトから成るシーケンスを、スラッグの昇順に並べ替えて返します。このシーケンスを変数の中に保存して反復処理すると、カスタムの執筆者記事フィルターを作成できます。
各執筆者による公開中の記事の数にアクセスするには、author.live_postsを使用できます。
注:この関数では執筆者数の上限が250件に設定されています。また、ページ1件につき10回の呼び出しという上限もあります。
以下の例の第1行は、この関数によって執筆者オブジェクトのシーケンスがどのように返されるかを示しています。例の残りの部分では、シーケンスを変数の中に保存し、執筆者オブジェクトを反復処理して執筆者リストのリンクをいくつか出力する例を示しています。この例では、ブログに4人の執筆者がいることを想定しています。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
limit
| 整数 | 取得する執筆者数の上限を設定します。 |
blog_by_id
関数はID別にブログを返します。以下のコード例は、この関数を使ってハイパーリンクされたリスト項目を生成する方法を示しています。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
blog_page_link
関数は、ページ番号付きのブログリスト表示のURLを生成します。この関数は1つの数値パラメーターを受け入れ、これによって現在のページ、次のページ、前のページ、または特定のページのリンクを生成できます。この関数は通常、ページ番号付きアンカータグのhref
属性で使用され、ブログ一覧テンプレートで使用する必要があります。
以下に示す例では、アンカーhref
としてこの関数を使用しています。最初の例では、現在のページを出力します。2番目の例では、7ページ目を指定する数値7をパラメーターとして受け入れています。3番目の例では、next_page_num
変数を使用し、現在のページからの相対ページ番号のリンクを生成しています(前のページを指定するにはlast_page_num
変数を使用できます)。最後の例では、current_page_num
変数と+
演算子を使用して、現在のページより4つ大きい番号のページへのリンクを作成しています。
Parameter | Type | Description |
---|---|---|
page
| 数値またはHubL変数 | ページ番号のURLまたはHubL変数の生成に使用するページ番号。 |
この関数は、特定数の人気のある記事をシーケンスとしてレンダリングします。このシーケンスを変数の中に保存することができ、forループでそれを反復処理すると、人気のある記事のカスタム記事リストを作成できます。
この関数の結果は6時間にわたりキャッシュされます。キャッシュを使用せずにHubLでブログ記事を取得するには、代わりにblog_recent_tag_postsを使用します。
以下のサンプルコードでは、最初の行にこの関数でどのようにシーケンスを取得するかが示されています。シーケンスは変数として保存され、その変数がforループで使用されます。ブログ記事の変数では例外なく、content
ではなく個々のループ項目の名前を使用する必要があります。この例ではpop_post.name
が使用されています。この手法は、ブログテンプレートやウェブサイトページに対して使用できます。
注:この関数では記事数の上限が200件に設定されています。また、ページ1件につき10回の呼び出しという上限もあります。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
limit
| 整数 | シーケンスに追加する投稿数を指定します(最大200件)。指定しない場合は、既定で10に設定されます。 |
tag_slug
| 配列 | 投稿を絞り込むための任意のタグのリスト。 |
time_frame
| 文字列 | アナリティクス上で投稿を絞り込むための任意の期間。
|
logical_operator
| 文字列 |
このパラメーターを含める場合は、 |
blog_post_archive_url
関数は、指定されたブログ上の特定の日付値に対応するアーカイブのリストページの完全なURLを返します。この関数には2つの必須パラメーターと2つの任意指定パラメーターがあります。最初のパラメーターにはブログIDまたは単にキーワード"default"
を指定します。2番目は、どの年のアーカイブされた記事を表示するかを指定します。
任意指定パラメーターには、それぞれどの月および日のアーカイブされた記事を表示するかが格納されます。
以下の例は、この関数をアンカーのhref
として使用する方法を示しています。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
year
| 整数 | 年。 |
month
| 整数 | 月(任意)。 |
day
| 整数 | 日(任意)。 |
blog_recent_author_posts
関数は、指定された執筆者のブログ記事オブジェクトから成るシーケンスを、新しい順に並べ替えて返します。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、特定の執筆者のカスタム記事リストを作成できます。
この関数は3つのパラメーターを受け入れます。最初のパラメーターにはどのブログから執筆者の記事を収集するかを指定します。値は"default"
、または(ブログダッシュボードのURLで取得できる)特定のブログのIDです。2番目のパラメーターには、どの執筆者を使用するかを指定します。このパラメーターでcontent.blog_post_author.slug
を使用すると、現在の記事の執筆者が指定されます。または、"brian-halligan"
などのハイフン付きの小文字の名前を受け入れることもできます。3番目のパラメーターには取得する記事数を指定します。
以下の例の1行目には、関数によってどのように執筆者の記事シーケンスが返されるかが示されています。この例では、具体的な執筆者名を指定する代わりに、現在の記事の執筆者が指定されています。シーケンスは1つの変数に保存され、ループ処理されます。ブログ記事の変数では例外なく、content
ではなく個々のループ項目の名前を使用する必要があります。この例ではauthor_post.name
が使用されています。この手法はブログテンプレートとページテンプレートで使用できます。
注:この関数にはページ1件につき200件の記事、10回の呼び出しという上限があります。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。ブログIDはモジュールのブログフィールドによって返されます。 |
author_slug
| 文字列 | 絞り込む執筆者を指定します。 |
limit
| 整数 | シーケンスに追加する投稿数を指定します(最大200件)。 |
blog_recent_posts
関数は、指定されたブログでのブログ記事オブジェクトから成るシーケンスを、新しい順に並べ替えて返します。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、人気のある記事を示すカスタム記事リストを作成できます。
この関数は2つのパラメーターを受け入れます。最初のパラメーターには、どのブログから人気のある記事を収集するかを指定します。値は"default"
、または(ブログダッシュボードのURLで取得できる)特定のブログのIDです。2番目のパラメーターには取得する記事数を指定します。
以下の例の1行目には、この関数によってどのようにシーケンスが返されるかが示されています。シーケンスは1つの変数に保存され、ループ処理されます。ブログ記事の変数では例外なく、content
ではなく個々のループ項目の名前を使用する必要があります。この例ではrec_post.name
が使用されています。この手法は、ブログテンプレートだけでなく通常のページに対しても使用できます。
注:この関数にはページ1件につき200件の記事、10回の呼び出しという上限があります。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
limit
| 整数 | シーケンスに追加する投稿数を指定します(最大200件)。 |
blog_recent_tag_posts
関数は、指定されたタグ(複数可)のブログ記事オブジェクトから成るシーケンスを、新しい順に並べ替えて返します。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、特定のタグのカスタム記事リストを作成できます。
以下のコード例で:
- 第1行は、関数がどのようにタグの記事シーケンスを返すかを示しています
。 - 第2行は、関数をシーケンス変数に保存する方法を示しています。コードの残りの部分は、forループを使用して変数値を循環処理します。ブログ記事の変数では例外なく、
content
ではなく個々のループ項目の名前を使用する必要があります。この例ではtag_post.name
が使用されています。この手法は、ブログページとウェブサイトページの両方で使用できます。
関連するブログ記事リストの作成について詳細をご確認ください。
注:この関数には1ページあたり100件の記事数、10回の呼び出しという上限があります。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
tag_slug
| 文字列 | 絞り込むタグを指定します。最大10個のタグをカンマ区切りで含めることができます。複数の単語を持つタグは、スペースをハイフンに置き換えた小文字にする必要があります。 |
limit
| 整数 | シーケンスに追加する投稿数を指定します。 |
logical_operator
| 文字列 |
このパラメーターを含める場合は、 |
blog_tag_url
関数は、指定されたブログタグのリストページを指す完全なURLを返します。
この関数は2つのパラメーターを受け入れます。最初のパラメーターには、そのタグのリストページがどのブログ内に存在するかを指定します。2番目のパラメーターには、どのタグにリンクするかを指定します。このパラメーターでは、content.topic_list
からの特定のタグを示すtopic.slug
を使用できます。または"marketing-tips"
などのハイフン付きの小文字の名前を受け入れることもできます。
以下の例は、この関数をアンカーの
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。特定のブログを指定する場合はIDを、既定のブログを指定する場合は |
tag_slug
| 文字列 | どのタグにリンクするかを指定します。 |
blog_tags
関数は、指定したブログで特によく使用されている(関連するブログ記事の数に基づく)250件のタグのシーケンスを、ブログ記事数順に並べ替えて返します。
このシーケンスを変数の中に保存して反復処理すると、カスタムのタグ記事フィルターを作成できます。各タグの記事数にアクセスするには、tag.live_posts
を使用できます。
この関数は2つのパラメーターを受け入れます。最初のパラメーターには、どのブログからタグを取得するかを指定します。2番目のパラメーターには、取得されるタグ数の上限を指定します。
以下の例の第1行は、関数がどのようにタグオブジェクトのシーケンスを返すかを示しています。例の残りの部分では、シーケンスを変数の中に保存し、タグオブジェクトを反復処理してタグのリンクをいくつか出力する例を示しています。この例では、ブログに4つのタグがあることを想定しています。
注:この関数ではタグ数の上限が250件に設定されています。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログを使用するかを指定します。ブログIDはモジュールのブログフィールドによって返されます。 |
limit
| 整数 | 返されるタグの最大数。 |
この関数は、指定されたブログでの公開済み記事の総数を返します。パラメーターを指定しない場合、既定のブログの記事数をカウントします。または、"default"
を指定することや、別のブログの記事数をカウントするようにブログIDを指定することもできます。ブログIDは、対象のブログのブログダッシュボードのURLで得られます。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
selected_blog
| ブログIDまたは"default" | どのブログの記事数をカウントするかを指定します。ブログIDはモジュールのブログフィールドによって返されます。 |
この関数は、16進数値または色変数の明暗を指定の程度に応じて調整します。最初のパラメーターは16進数表記の色(例えば#FFDDFF)、つまり16進数値を格納する変数です。2番目のパラメーターでは、この色を調整する程度を0~255の範囲で指定します。この関数をCSSファイルで使用すると、色のバリエーションを作成できます。別のケースとして、色モジュールの色パラメーターでこれを使用すると、色バリエーションを自動生成する基本色をユーザーが指定できます。
以下の例では、base_color
という変数に16進数表記の色#3A539Bが格納されます。色が-80調整され、より濃い青(#00034B)になります。
Parameter | Type | Description |
---|---|---|
base_color
| 16進数カラー文字列 | 変更の始点となる色(例: |
brightness_offset
| 整数 | base_colorの色の濃淡調整に使用するプラスまたはマイナスの数値。 |
Parameter | Type | Description |
---|---|---|
id
| ID | 検索するコンテンツのID。 |
特定のコンテンツIDのリストを基準にして、そのIDにマッチするランディングページ、ウェブサイトページまたはブログ記事から成るディクショナリー(辞書型)を返します。
この関数は1つのパラメーター、つまり検索するページまたはブログ記事のIDから成るリスト(配列)を受け入れます。最大で100個のコンテンツオブジェクトを渡すことができます。以下のサンプルコードでは、この関数を使ってハイパーリンクされたリスト項目のリストを生成する方法を示しています。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
ids
| リスト | 検索するページまたはブログ記事のIDのリスト。最大で100個のコンテンツオブジェクトを渡すことができます。 |
ある変数がリスト内に出現する回数を返します。
レコードID、関連付けカテゴリー、関連付け定義IDによって、別のレコードに関連付けられているCRMレコードのリストを取得します。
この関数は、オブジェクトおよびhas_more
、total
、offset
、results
の属性を返します。
has_more
は、このバッチに含まれるよりも多い結果が存在する(offsetよりもtotalが多い)ことを示します。total
は、得られる結果の総数です。offset
は、この次の結果バッチに使用されるオフセットです。results
は、関数のパラメーターに一致する特定のオブジェクトから成る配列を返します。
注:セキュリティー上の理由から、一般に公開されるページでは、HubSpotの標準オブジェクトタイプのうち、product
オブジェクトとmarketing_event
オブジェクトのみが取得できます。それ以外の標準オブジェクトタイプは、パスワードで保護されたページ、またはCMSメンバーシップログインを必要とするページでホスティングされる必要があります。カスタムオブジェクトには同様の制約はありません。
注:この関数の呼び出しは、ページ1件につき最大10回に制限されています。それぞれのcrm_associations
呼び出しで、最大100個のオブジェクトを取得できます。既定では10個のオブジェクトに制限されています。
Parameter | Type | Description |
---|---|---|
id
必須
| ID | 関連付けの検索元となるレコードのID。 |
association category
必須
| 文字列 | 関連付け定義のカテゴリー。有効な値は、 |
association type id
必須
| 整数 | 使用する関連付け定義のID。HubSpotでサポートされる標準オブジェクトについては、使用する関連付けタイプのID(英語)を参照してください。 |
query
| 文字列 |
クエリーには次のパラメーターを含めることができます。
|
properties
| 文字列 | 任意。返されるカンマ区切りリストのプロパティー。既定では、一般的なプロパティーから成る小さなセットが返されます。IDプロパティーは常に返されます。 プロパティーの一覧は全てのコンタクトプロパティーの取得(英語)と全ての会社プロパティーの取得(英語)のエンドポイントにて確認できます。 |
formatting
| ブール値 | 任意。ポータル設定に従って日付や通貨などの値の書式を設定します。文字列を未加工のままにするには、これを省略するか |
クエリーまたはIDを使用して1つのCRMレコードを取得します。レコードは、プロパティーと値から成るディクショナリーとして返されます。
この関数はカスタムオブジェクトおよびインテグレーターオブジェクトで使用(英語)することもできます。
注:セキュリティー上の理由から、一般に公開されるページでは、HubSpotの標準オブジェクトタイプのうち、product
オブジェクトとmarketing_event
オブジェクトのみが取得できます。それ以外の標準オブジェクトタイプは、パスワードで保護されたページ、またはCMSメンバーシップログインを必要とするページでホスティングされる必要があります。カスタムオブジェクトには同様の制約はありません。
in
とcontains
にはどのような違いがありますか?
in
は、プロパティー値が、指定された値のうちいずれかの値と一致するかどうかを返します。一方、contains
は、複数選択プロパティー値が、指定された全ての値を含むかどうかを返します。
注:この関数の呼び出しは、ページ1件につき最大10回に制限されています。
Parameter | Type | Description |
---|---|---|
object_type
| 文字列 | オブジェクトタイプ名。オブジェクトタイプ名では大文字と小文字が区別されます。 組み込みオブジェクトと同名のインテグレーター オブジェクト タイプとアカウント固有オブジェクトタイプの場合は、オブジェクトの完全修飾名(FQN)(英語)を使用します。 |
query
| 文字列 | 任意。
クエリーには次のパラメーターを含めることができます。
|
properties
| 文字列 | 任意。返されるカンマ区切りリストのプロパティー。既定では、一般的なプロパティーから成る小さなセットが返されます。IDプロパティーは常に返されます。 プロパティーの一覧は全てのコンタクトプロパティーの取得(英語)と全ての会社プロパティーの取得(英語)のエンドポイントにて確認できます。 |
formatting
| ブール値 | 任意。ポータル設定に従って日付や通貨などの値の書式を設定します。文字列を未加工のままにするには、 |
range
、distinct
、ndistinct
、およびstartswith
の値は予約済みのキーワードです。これらの名前のいずれかを使用するプロパティーを照会するには、次の形式を使用する必要があります:range__eq=
(range=
ではない)。
特定のオブジェクトタイプのレコードのリストをHubSpotのCRMから取得します。
この関数は、オブジェクトおよびhas_more
、total
、offset
、results
の属性を返します。
has_more
は、このバッチに含まれるよりも多い結果が存在する(offsetよりもtotalが多い)ことを示します。total
は、得られる結果の総数です。offset
は、この次の結果バッチに使用されるオフセットです。results
は、関数のパラメーターに一致する特定のオブジェクトから成る配列を返します。
crm_objects("contact", "firstname=Bob&order=lastname&order=createdate")
の場合、"Bob"
という名(ファーストネーム)のコンタクトが、まず姓の順序、次にcreatedate
順で並べ替えられます。逆順で並べ替えるには、例えばorder=-createdate
のようにプロパティー名の前に-
を付加します。CRMオブジェクト関数はカスタムオブジェクトおよびインテグレーターオブジェクトで使用(英語)することもできます。注:セキュリティー上の理由から、一般に公開されるページでは、HubSpotの標準オブジェクトタイプのうち、product
オブジェクトとmarketing_event
オブジェクトのみが取得できます。それ以外の標準オブジェクトタイプは、パスワードで保護されたページ、またはCMSメンバーシップログインを必要とするページでホスティングされる必要があります。カスタムオブジェクトには同様の制約はありません。
注:この関数の呼び出しは、ページ1件につき最大10回に制限されています。それぞれのcrm_objects
呼び出しで、最大100個のオブジェクトを取得できます。既定では10個のオブジェクトに制限されています。
Parameter | Type | Description |
---|---|---|
object_type
| 文字列 | オブジェクトのタイプの名前。オブジェクトタイプ名では大文字と小文字が区別されます。標準的なオブジェクトタイプでは、単数形と複数形を使用できます(例: 組み込みオブジェクトと同名のインテグレーター オブジェクト タイプとアカウント固有オブジェクトタイプの場合は、オブジェクトの完全修飾名(FQN)(英語)を使用します。 |
query
| 文字列 | 任意。 以下の演算子がサポートされます:
例: |
properties
| 文字列 | 任意。返されるカンマ区切りリストのプロパティー。既定では、一般的なプロパティーから成る小さなセットが返されます。IDプロパティーは常に返されます。プロパティーの一覧は全てのコンタクトプロパティーの取得(英語)と全ての会社プロパティーの取得(英語)のエンドポイントにて確認できます。 レコードIDは、プロパティーリストに明示的に追加されていない場合でも、返されるオブジェクトプロパティーに常に含まれます。 |
formatting
| ブール値 | 任意。ポータル設定に従って日付や通貨などの値の書式を設定します。文字列を未加工のままにするには、 |
range
、distinct
、ndistinct
、およびstartswith
の値は予約済みのキーワードです。これらの名前のいずれかを使用するプロパティーを照会するには、次の形式を使用する必要があります:range__eq=
(range=
ではない)。
指定したオブジェクトタイプと1つのプロパティー名のプロパティー定義を取得します。
サポート対象のオブジェクトタイプは、HubSpot標準オブジェクト(コンタクトなど)、ポータル固有のオブジェクト、インテグレーターオブジェクトです。
注:セキュリティー上の理由から、一般に公開されるページでは、HubSpotの標準オブジェクトタイプのうち、product
オブジェクトとmarketing_event
オブジェクトのみが取得できます。それ以外の標準オブジェクトタイプは、パスワードで保護されたページ、またはCMSメンバーシップログインを必要とするページでホスティングされる必要があります。カスタムオブジェクトには同様の制約はありません。
Parameter | Type | Description |
---|---|---|
object_type
| 文字列 | オブジェクトタイプ名。オブジェクトタイプ名では大文字と小文字が区別されます。サポートされるオブジェクトタイプ。 組み込みオブジェクトと同名のインテグレーター オブジェクト タイプとアカウント固有オブジェクトタイプの場合は、オブジェクトの完全修飾名(FQN)(英語)を使用します。 |
property_name
| 文字列 | 定義を取得するプロパティーの名前。大文字と小文字は区別されません。 |
指定されたオブジェクトタイプと一連のプロパティー名のプロパティー定義を取得します。
サポート対象のオブジェクトタイプは、HubSpot標準オブジェクト(コンタクトなど)、ポータル固有のオブジェクト、インテグレーターオブジェクトです。
注:セキュリティー上の理由から、一般に公開されるページでは、HubSpotの標準オブジェクトタイプのうち、product
オブジェクトとmarketing_event
オブジェクトのみが取得できます。それ以外の標準オブジェクトタイプは、パスワードで保護されたページ、またはCMSメンバーシップログインを必要とするページでホスティングされる必要があります。カスタムオブジェクトには同様の制約はありません。
Parameter | Type | Description |
---|---|---|
object_type
| 文字列 | オブジェクトタイプ名。オブジェクトタイプ名では大文字と小文字が区別されます。サポートされるオブジェクトタイプ。 組み込みオブジェクトと同名のインテグレーター オブジェクト タイプとアカウント固有オブジェクトタイプの場合は、オブジェクトの完全修飾名(FQN)(英語)を使用します。 |
property_name
| 文字列 | 任意。カンマで区切られた、定義を取得するプロパティーの名前(名前では大文字と小文字は区別されません)。空白の場合、全てのプロパティーの定義が取得されます。 |
CTAモジュールには、コードバリエーションを含むパラメーターが多数あるので、cta関数を使用するとテンプレート、ページ、Eメールの中に特定のCTAを簡単に生成できます。リッチテキストエディターを使ってCTAを追加するとき、エディターはこの関数を使用します。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
guid
| 文字列 | レンダリングするCTAのID。CTAの詳細画面のURLで確認できます。 |
align_opt
| 列挙 | CTAの位置を調整します。 |
この関数は、IDを基準に1件のファイルのメタデータを返します。唯一のパラメーターとして、検索するファイルを示す数値IDを受け入れます。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
file_id
| ID | 検索するファイルのID。 |
アカウントで設定されているソーシャル メディア アカウントへのリンクを返します。既定のfollow_meモジュール(英語)で使用されます。
コンテキストのロケールに基づいて住所の書式を設定します。
Parameter | Type | Description | Default |
---|---|---|---|
locale
必須
| 文字列 | 住所の書式設定に適用するロケール。 | |
address
必須
| 文字列 | 番地。 | |
address2
任意
| 文字列 | 住所の2行目(建物名、階数、部屋番号など)。 | |
city
必須
| 文字列 | 住所の市区町村。 | |
state
必須
| 文字列 | 住所の都道府県。 | |
country
必須
| 文字列 | 住所の国。 | |
zip
必須
| 文字列 | 住所の郵便番号。 |
必要に応じて日本語の敬称を追加するように会社名の書式を設定します。
Parameter | Type | Description | Default |
---|---|---|---|
companyName
必須
| 文字列 | 会社の名前。 | |
useHonorificIfApplicable
必須
| ブール値 |
|
Parameter | Type | Description | Default |
---|---|---|---|
firstName
必須
| 文字列 | 個人の名。 | |
surname
必須
| 文字列 | 個人の姓。 |
False
|
useHonorificIfApplicable
必須
| ブール値 |
|
format_datetimeのHubLフィルターと同様に、日付オブジェクトの日付と時刻の両方のコンポーネントの書式を設定します。この関数は、非推奨のdatetimeformat
関数に置き換わるものです。
Parameter | Type | Description | Default |
---|---|---|---|
format
必須
| 文字列 | 使用する形式。次のいずれかを使用できます。
| |
timeZone
任意
| 文字列 | IANA TZDB形式(英語)で出力される日付のタイムゾーン。 | |
locale
任意
| 文字列 | ロケール対応の形式に使用するロケール。 |
この関数には4つのパラメーターがあり、地球上の2地点間の楕円2D距離を計算します。この関数は、HubDBデータを取得するためのフィルタークエリーとして使用します。
Parameter | Type | Description |
---|---|---|
point1
| 設置場所 | HubDB列からの場所。 |
point2_lat
| 緯度 | point2の緯度。 |
point2_long
| 経度 | point2の経度。 |
units
| 文字列 | 戻り値の単位。 |
この関数は、指定したテンプレートまたはコードファイルの公開URLを返します。この関数のパラメーターは、デザインマネージャー内でのアセットのパスです。コードファイルURLは、公開されるたびに更新されます。従って、この関数を使用すると常にファイルの最新バージョンを使用できます。
ファイル名を右クリックして[公開URLをコピー]を選択するか、[アクション]をクリックして[公開URLをコピー]を選択することで、アプリ内でこの関数を自動的に生成できます。
以下の例では、デザインマネージャーで作成されたJavaScriptファイルのURLを取得します。これを<script>
タグのsrc
として含めることができます。
Parameter | Type | Description |
---|---|---|
path
| 文字列 | デザインマネージャー内でのテンプレートまたはファイルのパス。 |
この関数の動作はget_public_template_url
と同様で、指定したテンプレートまたはコードファイルの公開URLを返します。唯一の違いは、この関数のパラメーターがデザインマネージャー内でのパスではなく、テンプレートIDであることです(このIDはテンプレートまたはコードファイルのURLで確認できます)。
Parameter | Type | Description |
---|---|---|
template_id
| ID | ファイルのテンプレートのID番号。 |
HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。
hubdb_table()
関数を使用すると、テーブルの名前、列、最終更新日などの情報を取得できます。
適切な属性を呼び出すことで、次の情報を取得できます。
- ID:テーブルのID。
- name:テーブルの名前。
- columns:列情報のリスト。
- created_at:テーブルが初めて作成された時点のタイムスタンプ。
- published_at:このテーブルが公開された時点のタイムスタンプ。
- updated_at:このテーブルの直近で更新された時点のタイムスタンプ。
- row_count:テーブルの行数。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
table_id
| 文字列 | テーブルのIDまたは名前。 |
HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。
hubdb_table_column
関数を使用すると、テーブルの列に関する情報(ラベル、タイプ、オプションなど)を取得できます。この関数は2つのパラメーターを受け入れます。
適切な属性を呼び出すことで、列に関する次の情報を取得できます。
- ID:列のID。
- name:列の名前。
- label:列に使用されるラベル。
- type:列のタイプ。
- options:
select
タイプの列の場合、これはoptionId
からoption情報へのマップです。 - foreignIds:
"foreignId"
タイプの列の場合、これはforeignId
のリストです(id
プロパティーとname
プロパティーを含む)。
上記の属性に加えて、getOptionByName("<option name>")
というメソッドを呼び出すこともできます。"select"
タイプの列の場合、これによりオプションの名前を基準にoption情報が取得されます。
列名では大文字と小文字が区別されません。例えば、HS_ID
とhs_id
はどちらも有効です。
Parameter | Type | Description |
---|---|---|
table_id
| 文字列 | テーブルのIDまたは名前。 |
column
| 文字列 | 列のIDまたは名前。 |
HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。hubdb_table_row
関数を使用すると、HubDBテーブルから1つの行を取得できます。この行に関して、該当する属性を呼び出すことで、各テーブルセルから次の情報を取得できます。
- hs_id:この行のグローバルに固有のID。
- hs_created_at:この行が作成された時点を示すタイムスタンプ。
- hs_path:動的ページで使用される場合、この文字列はページのURLパスの最後のセグメントです。
- hs_name:動的ページで使用される場合、これはページのタイトルです。
- <column name>または["<column name>"]:列の
name
を基準に、この行の列の値を取得します。
列名では大文字と小文字が区別されません。例えば、HS_ID
とhs_id
はどちらも有効です。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
table_id
| 文字列 | テーブルのIDまたは名前。 |
row_id
| 整数 | テーブルの行のID。 |
HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。
hubdb_table_rows
関数を使用すると、反復処理用にHubDBテーブルの行のリストを取得できます。hubdb_table_rows()
の1回の呼び出しで、ページ1件につき最大10回のテーブルスキャンが実行できます。
既定では、この関数は最大1,000行を返します。これよりも多くの行を取得するには、以下のコードに示されているようにクエリー内でlimit
を指定します。
Parameter | Type | Description |
---|---|---|
table_id
| 文字列 | クエリー対象のテーブルのIDまたは名前。 |
query
| 文字列 | URLクエリー文字列と同じ形式のクエリー。指定しない場合、全ての行が返されます。HubDBテーブル行を照会するために使用できるフィルターについての詳細はこちらをご参照ください。 逆順で並べ替えるには、列名に 列を基準に並べ替えを行えるだけでなく、次の関数を含めることもできます。
この関数では逆順もサポートされます。例: |
range
、distinct
、ndistinct
、およびstartswith
の値は予約済みのキーワードです。これらの名前のいずれかを使用するプロパティーを照会するには、次の形式を使用する必要があります:range__eq=
(range=
ではない)。
この関数は、プライマリーCSSファイル(default_custom_style.min.css
)を参照するリンクタグを生成します。このファイルはグローバルCSSファイルとして用意され、全てのテンプレートに追加できます。この関数によってレンダリングするには、ブール値パラメーターの値True
が必要です。
0ベースのarray
の中で最初にマッチする項目の所在地を返します。
この関数は3つのパラメーターを受け入れ、最初のパラメーターは必須です。最初のパラメーターは、array
内で検索される項目です。2番目(start
)と3番目(end
)のパラメーターを使用すると、array
のスライス内でその項目を検出できます。
指定された_locales
フォルダーパスから翻訳を読み込み、値のマップを返します。
カスタムモジュールおよびテーマの中にフィールド翻訳を含めることについて詳しくは、こちらをご覧ください。
Parameter | Type | Description |
---|---|---|
path
| 文字列 | 翻訳の_localesディレクトリーへのファイルパス。 |
language_code
| 文字列 | 言語コード。 |
language_code_fallback
| 文字列 | 指定された |
詳細メニューのネストしたリンク構造を返します。メニューノードには、返されたオブジェクトで使用できるさまざまなプロパティーがあります。null
をmenu関数に渡した場合、空のpylistが返されます。名前でメニューを指定することもできます。名前を変更してもIDには影響しないため、ほとんどの場合にはメニューIDを使用するのが安全です。マーケットプレイス用にビルドする場合は、メニューがnull
であるなら、既定で"default"
にするのが理にかなっています。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
menu()
関数を使用してメニューを生成する場合、メニューにアクセスできることを確認する責任はユーザーにあります。
Parameter | Type | Description |
---|---|---|
menu_id
| id | 必須。数値として渡すメニューID。 |
root_type
| 列挙 | メニューのルートタイプ(
|
root_key
| 文字列 |
|
任意の属性を保持できる名前空間オブジェクトを作成します。これはディクショナリーから、またはキーワード引数を使用して初期化できます。
Parameter | Type | Description |
---|---|---|
dictionary
| 地図 | 初期化に使用するディクショナリー。 |
kwargs
| 文字列 | 名前空間辞書に入力するキーワード引数。 |
Parameter | Type | Description |
---|---|---|
request
| 文字列 | リクエストオブジェクト、 |
Parameter | Type | Description |
---|---|---|
expression
| 文字列 | レンダリングするオブジェクトとプロパティーの式。 |
default
| 文字列 | 任意。式に値がない場合に使用する既定値。 |
postal_location
関数は、特定の郵便番号と国コードに対応する所在地の緯度と経度のペアを返します(米国、カナダ、英国のみ)。注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
postal_code
| 文字列 | 所在地の郵便番号。 |
country_code
| 文字列 | 郵便番号の国コード。これを指定しない場合、郵便番号から国が推定されます。 |
整数から成る算術数列が入ったリストを返します。rangeで1つのパラメーターを指定すると、0からそのvalue
未満までのリストが返されます。rangeで2つのパラメーターを指定すると、最初の値から始まり、1つずつ増えて、2番目のvalue
未満までが返されます。3番目のパラメーターには段階的な増分を指定します。全ての値に負の数を指定できます。無効な範囲を指定すると、空のリストが返されます。rangeで生成できる値の数は最大1000個です。
rangeをforループの中で使用すると、実行する反復処理の回数を指定できます。
この関数は、レンダリングされるCSSファイルをhead要素に追加します。全てのCSS linkタグはグループ化され、JavaScriptタグの前にレンダリングされます。HubLは空の行に置換され、その後でlinkタグが{{ standard_header_includes }}
に追加されます。ここでは絶対URLが必要になります。get_asset_url()
関数を使用することで、既知の相対URL付きのCMSコンテンツを要求できます。
styleタグ要素を介して、レンダリングされるインラインスタイルをhead
に含めるには、styleタグとその中のCSSの代わりに{% require_css %}および{% end_require_css %}
タグを使用してください。
2番目のパラメーターは、生成されるタグを変更するためのオプションのディクショナリーです。web.devの記事で紹介されているasync
(true/false)がサポートされます。その他のキーと値のペアは、HTML属性としてスタイルタグに追加されます。
headまたはfooterでのレンダリングのために、スクリプトをキューに登録するかどうかを指定します(既定)。レンダリングする位置を指定するため、head
パラメーターまたはfooter
パラメーターをインクルードします。HubLは空の行に置換され、ヘッダーまたはフッターのインクルードのいずれかにインクルードされます。
script要素を使用してフッターにレンダリングされるインラインスクリプトをキューに登録するには、<script>
タグを{% require_js %}
と{% end_require_js %}
で囲みます。
この関数には追加のレンダリングオプションを含めることもできます。これらはスクリプトタグにHTML属性として追加されます。レンダリングオプションには次のものがあります。
- position:
head
/footer
- defer:
true
/false
- async:
true
/false
- type:
string
ファイルマネージャーに保存された画像のURLを、リクエスト時に画像のサイズを変更するURLに書き換えます。この関数は1つの必須パラメーターと5つの任意指定パラメーターを受け入れます。少なくとも1つの任意指定パラメーターを渡す必要があります。
必須
- URL:HubSpotでホスティングされている画像のURL(文字列)。
任意
- width:画像の新しい幅(ピクセル単位の数値)。
- height:画像の新しい高さ(ピクセル単位の数値)。
- length:画像の新しい長辺(ピクセル単位の数値)。
- upscale:画像の元の寸法よりも拡大される場合でもサイズ変更後の寸法を使用するかどうかを示すブール値(画像がぼやけて表示される可能性があります)。
- upsize:元のバイト数よりも増える場合でもサイズ変更後の画像を返すかどうかを示すブール値。
注:高さまたは幅が4096ピクセルを超える画像は、自動的にサイズ変更されません。代わりに、手動で画像のサイズを変更する必要があります。
Parameter | Type | Description |
---|---|---|
url
| 文字列 | HubSpotでホスティングされている画像のURL。 |
width
| 整数(px) | 画像の新しい幅(ピクセル単位)。 |
height
| 整数(px) | 画像の新しい高さ(ピクセル単位)。 |
length
| 整数(px) | 画像の新しい長辺(ピクセル単位)。 |
upscale
| ブール値 | 画像の元の寸法よりも拡大される場合でもサイズ変更後の寸法を使用するかどうかを示すブール値(画像がぼやけて表示される可能性があります)。 既定値は |
upsize
| ブール値 | 元のバイト数よりも増える場合でもサイズ変更後の画像を返すかどうかを示すブール値。 |
リスト内の項目の順序を逆にします。受け入れるパラメーターはありません。オブジェクトを逆にするか、リスト内を逆に反復処理するイテレーターを返すには、|reverse
を使用します。
レスポンスコードを指定されたコードに設定します。現在、指定できるコードは404だけです。これを使用すると、ページから404
エラーが返されます。
Parameter | Type | Description |
---|---|---|
code
| 整数 | HTTPレスポンスコード。現在、指定できるコードは |
この関数は、extendsタグを使用して、親テンプレートの内容を子テンプレート内に出力します。
例えば下記のコードでは、sidebar
という名前のHubLブロックを使って基本HTMLテンプレートが作成され、parent.html
として保存されます。その親ファイルを拡張する2番目のテンプレートファイルが作成されます。通常、<h3>
は親HTMLのsidebarブロック内に出力されます。しかし、super
を使用すると、親テンプレートのsidebarブロックの内容が子テンプレートの内容と結合されます。
コンテンツ部分に関連するトピッククラスターを表すHubLディクショナリーを(渡されたコンテンツIDで判別して)返します。これには、関連付けられているピラーページ、コアトピック、サブトピックについてのメタデータが含まれます。これを使用すると、関連ピラーページが存在する場合、それをコンテンツ部分に「自動リンク」させることができます。
取得可能なメタデータがある場所は、attachableContent(現在のコンテンツのメタデータ)、topic(現在のコンテンツの関連トピックメタデータ)、coreTopic(関連クラスターのコアトピックのメタデータ)、およびpillarPage(関連ピラーページのメタデータ)です。
可能なプロパティーと属性を全て表示するには、{{ topicCluster|pprint }}
を使用してください。
注:この関数の呼び出しは、ページ1件につき10回に制限されています。
Parameter | Type | Description |
---|---|---|
content_id
| id | 検索するページのID。 |
truncate関数の動作はtruncateフィルターとまったく同じですが、フィルター構文ではなく関数構文を使用します。最初のパラメーターには、文字列を指定します。2番目のパラメーターには、どこで切り捨てるかを長さで指定します。最後のパラメーターには、切り捨てが発生した場合に追加する文字を指定します。
Parameter | Type | Description |
---|---|---|
string_to_truncate
| 文字列 | 切り詰められる文字列。 |
length
| integer | テキストをどこで切り詰めるかを長さで指定します(HTML文字を含む)。 |
killwords
| ブール値 | trueの場合、単語の途中であっても、文字列は指定された長さに切り詰められます。 |
end
| 文字列 | テキストが切り詰められた位置を示すために付加される文字。 |
別のディクショナリーオブジェクトから、または反復可能なキーと値のペアからの要素を使って、ディクショナリーを更新します。
貴重なご意見をありがとうございました。