Zum Hauptinhalt springen
GET
/
media-bridge
/
v1
/
{appId}
/
properties
/
{objectType}
/
{propertyName}
プロパティーの詳細を取得
curl --request GET \
  --url https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}
{
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "calculated": true,
  "canArchive": true,
  "canRestore": true,
  "createdAt": 123,
  "createdUserId": 123,
  "currencyPropertyName": "<string>",
  "dataSensitivity": "high",
  "dateDisplayHint": "absolute",
  "deleted": true,
  "description": "<string>",
  "displayMode": "all_unique_versions",
  "displayOrder": 123,
  "enforceMultivalueUniqueness": true,
  "externalOptions": true,
  "externalOptionsReferenceType": "<string>",
  "favorited": true,
  "favoritedOrder": 123,
  "fieldType": "<string>",
  "formField": true,
  "fromUserId": 123,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": true,
  "hubspotDefined": true,
  "isCustomizedDefault": true,
  "isMultiValued": true,
  "isPartial": true,
  "label": "<string>",
  "mutableDefinitionNotDeletable": true,
  "name": "<string>",
  "numberDisplayHint": "currency",
  "optionSortStrategy": "ALPHABETICAL",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "doubleData": 123,
      "hidden": true,
      "label": "<string>",
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "optionsAreMutable": true,
  "owningAppId": 123,
  "portalId": 123,
  "readOnlyDefinition": true,
  "readOnlyValue": true,
  "referencedObjectType": "ABANDONED_CART",
  "searchTextAnalysisMode": "NONE",
  "searchableInGlobalSearch": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "type": "bool",
  "updatedAt": 123
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales Hub無料ツール
Service HubService Hub無料ツール
Content HubContent Hub無料ツール

Authorizations

hapikey
string
query
required

Path Parameters

appId
integer
required

メディアブリッジアプリのappId。メディアブリッジを使用する開発者アカウント内に複数のアプリを持つことが可能です。

objectType
string
required

プロパティーのオブジェクトタイプ。

propertyName
string
required

詳細を取得するプロパティーの名前。

Query Parameters

archived
boolean
default:false

アーカイブ済みの結果のみを返すかどうか。

properties
string

指定されたプロパティーのみが含まれるようにレスポンスを制限してください。

Response

successful operation

A HubSpot property

allowedObjectTypes
object[]
required

このプロパティーの使用が許可されているオブジェクトタイプ。

calculated
boolean
required

プロパティーが計算フィールドかどうか。

canArchive
boolean
required
canRestore
boolean
required
createdAt
integer
required

プロパティーが作成された時刻のタイムスタンプ(ISO 8601形式)。

createdUserId
integer
required

プロパティーを作成したユーザーのID。

currencyPropertyName
string
required

関連する通貨プロパティーの名前。

dataSensitivity
enum<string>
required

「non_sensitive」、「sensitive」、「highly_sensitive」など、プロパティーのセンシティブ(慎重に扱うべき)レベルを示します。

Verfügbare Optionen:
high,
none,
standard
dateDisplayHint
enum<string>
required
Verfügbare Optionen:
absolute,
absolute_with_relative,
time_since,
time_until
deleted
boolean
required

プロパティーが削除済みかどうか。

description
string
required

プロパティーの目的の要約。

displayMode
enum<string>
required

プロパティーの表示モード。「current_value」または「all_unique_versions」にできます。

Verfügbare Optionen:
all_unique_versions,
current_value
displayOrder
integer
required

リスト内項目の他の項目との相対位置。

enforceMultivalueUniqueness
boolean
required
externalOptions
boolean
required

列挙型のプロパティーにのみ適用されます。trueに設定し、「referencedObjectType」を「OWNER」に設定します。それ以外の場合はfalse。

externalOptionsReferenceType
string
required

externalOptionsがtrueの場合、プロパティーのオプション値が他のシステムから埋められることを示します(例えば、hubspot_owner_idプロパティーの場合は「OWNER」)。

favorited
boolean
required

非推奨。プロパティーがお気に入り済みかどうか。

favoritedOrder
integer
required

非推奨。お気に入りにしたときの順序の位置。

fieldType
string
required

HubSpotのUIまたはフォーム上でプロパティーがどう表示されるかを指定します。詳細はプロパティーAPIガイドをご確認ください。

formField
boolean
required

プロパティーをフォームで表示できるかどうか。

fromUserId
integer
required

プロパティーを最後に更新したユーザーのID。

groupName
string
required

プロパティーが割り当てられているグループの名前。

hasUniqueValue
boolean
required

プロパティーが固有IDプロパティーかどうか。

hidden
boolean
required

プロパティーをHubSpot UIから非表示にするかどうか。カスタムプロパティーの場合は、これをfalseに設定することが推奨されます。

hubspotDefined
boolean
required

HubSpotデフォルトプロパティーについてtrueに設定されるブール値。

isCustomizedDefault
boolean
required

デフォルトプロパティーの場合、プロパティーがカスタマイズ済みかどうか。isCustomizedDefaultフィールドと同等。

isMultiValued
boolean
required

プロパティーに複数の値を含めることができるかどうか。

isPartial
boolean
required

デフォルトプロパティーの場合、プロパティーがカスタマイズ済みかどうか。isCustomizedDefaultフィールドと同等。

label
string
required

プロパティーの表示ラベル。

mutableDefinitionNotDeletable
boolean
required

プロパティー定義をカスタマイズできるが、削除はできないかどうか。

name
string
required

プロパティーの内部名。

numberDisplayHint
enum<string>
required

HubSpotのUIでの数値プロパティーの表示方法と検証方法に関するヒント。「unformatted」、「formatted」、「currency」、「percentage」、「duration」、「probability」のいずれかにできます。

Verfügbare Optionen:
currency,
duration,
formatted,
percentage,
probability,
unformatted
optionSortStrategy
enum<string>
required

プロパティーオプションの並べ替え方法を指定します。displayOrderフィールドに従う「DISPLAY_ORDER」、または「ALPHABETICAL」のいずれかにできます。

Verfügbare Optionen:
ALPHABETICAL,
DISPLAY_ORDER
options
object[]
required

プロパティーの有効なオプションのリスト。このフィールドは列挙型のプロパティーに必要です。

optionsAreMutable
boolean
required

作成後にオプションを変更できるかどうか。

owningAppId
integer
required
portalId
integer
required

プロパティーが定義されているHubSpotアカウントのID。

readOnlyDefinition
boolean
required

プロパティーの説明が読み取り専用かどうか。

readOnlyValue
boolean
required

プロパティーの値が読み取り専用かどうかを示します。

referencedObjectType
enum<string>
required

非推奨。代わりにexternalOptionsReferenceTypeを使用してください。

Verfügbare Optionen:
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
searchTextAnalysisMode
enum<string>
required
Verfügbare Optionen:
NONE,
NOT_ANALYZED_TEXT

プロパティーがグローバル検索可能かどうか。

sensitiveDataCategories
string[]
required

sensitiveDataがtrueの場合、プロパティーに含まれるセンシティブデータのタイプを示します(例:「HIPAA」)。

showCurrencySymbol
boolean
required

HubSpotのUIに通貨記号を表示するかどうか。

textDisplayHint
enum<string>
required

HubSpotのUIでのテキストの表示方法と検証方法に関するヒント。「unformatted_single_line」、「multi_line」、「email」、「phone_number」、「domain_name」、「ip_address」、「physical_address」、「postal_code」のいずれかにできます。

Verfügbare Optionen:
domain_name,
email,
ip_address,
multi_line,
phone_number,
physical_address,
postal_code,
unformatted_single_line
type
enum<string>
required

文字列や数値など、プロパティーのデータ型。

Verfügbare Optionen:
bool,
currency_number,
date,
datetime,
enumeration,
json,
number,
object_coordinates,
phone_number,
string
updatedAt
integer
required

プロパティーが最後に更新されたタイムスタンプ(ISO 8601形式)。