Get the details for a property
指定されたアプリ内で、特定のオブジェクトタイプのプロパティーを取得します。このエンドポイントを使用すると、プロパティー名で識別される特定のオブジェクトタイプのプロパティーについて、構成や設定を含む詳細情報にアクセスできます。これは、プロパティーの設定を理解したり、連携に使用したりする際に役立ちます。
Supported products
Supported products
承認
The access token received from the authorization server in the OAuth 2.0 flow.
レスポンス
successful operation
A HubSpot property
このプロパティーで許可されるオブジェクトタイプを表す文字列の配列。
プロパティーが計算されるかどうかを示すブール値。
プロパティーをアーカイブできるかどうかを示すブール値。
プロパティーを復元できるかどうかを示すブール値。
プロパティーが作成された日時を表すISO 8601形式の文字列。
プロパティを作成したユーザーのIDを表す文字列。
このプロパティーに関連付けられている通貨プロパティーの名前を表す文字列。
データの機密性レベルを示す文字列。
high, none, standard 日付の表示に関するヒントを提供する文字列。
absolute, absolute_with_relative, time_since, time_until プロパティーが削除されたかどうかを示すブール値。
プロパティーの説明を提供する文字列。
プロパティーの表示モードを示す文字列。
all_unique_versions, current_value プロパティーが表示される順序を指定する整数。
複数値プロパティーの一意性が適用されるかどうかを示すブール値。
プロパティーに外部オプションがあるかどうかを示すブール値。
外部オプションの参照タイプを示す文字列。
プロパティーがお気に入りとしてマークされているかどうかを示すブール値。
お気に入りの中でのプロパティーの順序を指定する整数。
booleancheckbox、calculation_equation、checkbox、date、file、html、number、phonenumber、radio、select、text、textareaなど、プロパティーのフィールドタイプを示す文字列。
プロパティーがフォームフィールドとして使用されているかどうかを示すブール値。
プロパティーの発生元であるユーザーIDを表す文字列。
プロパティーが属するグループの名前を表す文字列。
プロパティーに一意の値があるかどうかを示すブール値。
プロパティーが非表示かどうかを示すブール値。
false
プロパティーがHubSpotによって定義されているかどうかを示すブール値。
プロパティーがカスタマイズされたデフォルトであるかどうかを示すブール値。
プロパティが複数の値を持つことができるかどうかを示すブール値。
プロパティーが部分的なものかどうかを示すブール値。
表示目的で使用される、プロパティーのラベルを表す文字列。
プロパティー定義が変更可能だが削除はできないことを示すブール値。
プロパティーの名前を表す文字列。
数値の表示に関するヒントを提供する文字列。オプションは「unformatted」、「formatted」、「currency」、「percentage」、「duration」、「probability」などです。
currency, duration, formatted, percentage, probability, unformatted オプションの並べ替えに使用される戦略を示す文字列。
ALPHABETICAL, DISPLAY_ORDER プロパティータイプがオプションをサポートしている場合に適用される、プロパティーで利用可能なオプションの配列。
プロパティーのオプションが変更可能かどうかを示すブール値。
プロパティーを所有するアプリのIDを表す整数。
ポータルの固有IDを表す整数。
プロパティーの定義が読み取り専用であるかどうかを示すブール値。
プロパティーの値が読み取り専用であるかどうかを示すブール値。
プロパティーによって参照されるオブジェクトのタイプを示す文字列。
ABANDONED_CART, ACCEPTANCE_TEST, AD, AD_ACCOUNT, AD_CAMPAIGN, AD_GROUP, AI_FORECAST, ALL_PAGES, APPROVAL, APPROVAL_STEP, ATTRIBUTION, AUDIENCE, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM_FLOW, AUTOMATION_PLATFORM_FLOW_ACTION, BET_ALERT, BET_DELIVERABLE_SERVICE, BLOG_LISTING_PAGE, BLOG_POST, CALL, CAMPAIGN, CAMPAIGN_BUDGET_ITEM, CAMPAIGN_SPEND_ITEM, CAMPAIGN_STEP, CAMPAIGN_TEMPLATE, CAMPAIGN_TEMPLATE_STEP, CART, CASE_STUDY, CHATFLOW, CLIP, CMS_URL, COMBO_EVENT_CONFIGURATION, COMMERCE_PAYMENT, COMMUNICATION, COMPANY, CONTACT, CONTACT_CREATE_ATTRIBUTION, CONTENT, CONTENT_AUDIT, CONTENT_AUDIT_PAGE, CONVERSATION, CONVERSATION_INBOX, CONVERSATION_SESSION, CRM_OBJECTS_DUMMY_TYPE, CRM_PIPELINES_DUMMY_TYPE, CTA, CTA_VARIANT, DATA_PRIVACY_CONSENT, DATA_SYNC_STATE, DEAL, DEAL_CREATE_ATTRIBUTION, DEAL_REGISTRATION, DEAL_SPLIT, DISCOUNT, DISCOUNT_CODE, DISCOUNT_TEMPLATE, EMAIL, ENGAGEMENT, EXPORT, EXTERNAL_WEB_URL, FEE, FEEDBACK_SUBMISSION, FEEDBACK_SURVEY, FILE_MANAGER_FILE, FILE_MANAGER_FOLDER, FOLDER, FORECAST, FORM, FORM_SUBMISSION_INBOUNDDB, GOAL_TARGET, GOAL_TARGET_GROUP, GOAL_TEMPLATE, GSC_PROPERTY, HUB, IMPORT, INVOICE, KEYWORD, KNOWLEDGE_ARTICLE, LANDING_PAGE, LEAD, LINE_ITEM, MARKETING_CALENDAR, MARKETING_CAMPAIGN_UTM, MARKETING_EMAIL, MARKETING_EVENT, MARKETING_EVENT_ATTENDANCE, MARKETING_SMS, MEDIA_BRIDGE, MEETING_EVENT, MIC, NOTE, OBJECT_LIST, ORDER, OWNER, PARTNER_ACCOUNT, PARTNER_CLIENT, PARTNER_CLIENT_REVENUE, PARTNER_SERVICE, PAYMENT_LINK, PAYMENT_SCHEDULE, PAYMENT_SCHEDULE_INSTALLMENT, PERMISSIONS_TESTING, PLAYBOOK, PLAYBOOK_QUESTION, PLAYBOOK_SUBMISSION, PLAYBOOK_SUBMISSION_ANSWER, PLAYLIST, PLAYLIST_FOLDER, PODCAST_EPISODE, PORTAL, PORTAL_OBJECT_SYNC_MESSAGE, POSTAL_MAIL, PRIVACY_SCANNER_COOKIE, PRODUCT, PRODUCT_OR_FOLDER, PROPERTY_INFO, PROSPECTING_AGENT_CONTACT_ASSIGNMENT, PUBLISHING_TASK, QUARANTINED_SUBMISSION, QUOTA, QUOTE, QUOTE_FIELD, QUOTE_MODULE, QUOTE_MODULE_FIELD, QUOTE_TEMPLATE, RESTORABLE_CRM_OBJECT, ROSTER, ROSTER_MEMBER, SALES_DOCUMENT, SALES_TASK, SALES_WORKLOAD, SALESFORCE_SYNC_ERROR, SCHEDULING_PAGE, SCHEMAS_BACKEND_TEST, SCORE_CONFIGURATION, SEQUENCE, SEQUENCE_ENROLLMENT, SEQUENCE_STEP, SEQUENCE_STEP_ENROLLMENT, SERVICE, SITE_PAGE, SNIPPET, SOCIAL_BROADCAST, SOCIAL_CHANNEL, SOCIAL_POST, SOCIAL_PROFILE, SOX_PROTECTED_DUMMY_TYPE, SOX_PROTECTED_TEST_TYPE, SUBMISSION_TAG, SUBSCRIPTION, TASK, TASK_TEMPLATE, TAX, TEMPLATE, TICKET, UNKNOWN, UNSUBSCRIBE, USER, VIEW, VIEW_BLOCK, WEB_INTERACTIVE 検索目的のテキスト分析モードを示す文字列。
NONE, NOT_ANALYZED_TEXT プロパティーがグローバル検索で検索可能かどうかを示すブール値。
このプロパティーに関連付けられているセンシティブデータのカテゴリを表す文字列の配列。
プロパティーの通貨記号を表示するかどうかを示すブール値。
テキスト表示のヒントを提供する文字列で、「unformatted_single_line」、「multi_line」、「email」、「phone_number」、「domain_name」、「ip_address」、「physical_address」、「postal_code」などのオプションがあります。
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line 「bool」、「date」、「datetime」、「enumeration」、「number」、「phone_number」、「string」など、プロパティーのタイプを示す文字列。
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string, time_range プロパティーが最後に更新された日時を表すISO 8601形式の文字列。