curl --request GET \
--url 'https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}?hapikey='{
"objectTypeId": "<string>",
"objectTypeName": "<string>",
"properties": [
{
"objectTypeId": "<string>",
"property": {
"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": false,
"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
},
"calculationExpression": {
"operator": "CONSTANT_BOOLEAN",
"inputs": [
"<unknown>"
],
"propertyName": "<string>",
"value": true
},
"calculationFormula": "<string>",
"definitionSource": {
"type": "GLOBAL",
"name": "<string>"
},
"extensionData": {
"extensionStatusMap": {},
"tags": [
"<string>"
],
"caseChangeTestExtensionData": {
"mood": "<string>"
},
"optionDecoratorsExtensionData": {
"optionDecoratorStyle": "<string>",
"optionDecorators": {}
},
"requiredPropertiesExtensionData": {
"isRequiredProperty": true
},
"softRequiredPropertiesExtensionData": {
"isSoftRequiredProperty": true
}
},
"externalOptionsMetaData": {
"filter": {
"includeUnconfirmedUsers": true,
"pipelineIds": [
"<string>"
]
},
"relatedObjectTypeId": "<string>"
},
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"janusGroup": "<string>",
"permission": {
"accessLevel": "<string>"
},
"propertyDefinitionSource": {
"type": "<string>",
"name": "<string>"
},
"propertyRequirements": {
"gates": [
"<string>"
],
"operator": "AND",
"scopeNames": [
"<string>"
],
"settings": [
"<string>"
]
},
"rollupExpression": {
"associationTypes": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 123
}
],
"rollupOperator": "<string>",
"sourceObjectTypeId": "<string>",
"sourcePropertyName": "<string>",
"conditionalExpression": {
"operator": "CONSTANT_BOOLEAN",
"inputs": [
"<unknown>"
],
"propertyName": "<string>",
"value": true
},
"conditionalFormula": "<string>",
"emptyRollupValue": "<string>",
"sourceCompareByPropertyName": "<string>"
}
}
],
"propertyGroups": [
{
"displayName": "<string>",
"displayOrder": 123,
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"hubspotDefined": true,
"name": "<string>"
}
],
"schema": {
"allowsSensitiveProperties": true,
"createDatePropertyName": "<string>",
"defaultSearchPropertyNames": [
"<string>"
],
"deleted": true,
"fullyQualifiedName": "<string>",
"hasCustomProperties": true,
"hasDefaultProperties": true,
"hasExternalObjectIds": true,
"hasOwners": true,
"hasPipelines": true,
"id": 123,
"indexedForFiltersAndReports": true,
"lastModifiedPropertyName": "<string>",
"metaType": "CMS_HUBDB",
"metaTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"permissioningType": "<string>",
"pipelinePropertyName": "<string>",
"pipelineStagePropertyName": "<string>",
"requiredProperties": [
"<string>"
],
"restorable": true,
"scopeMappings": [
{
"accessLevel": "<string>",
"requestAction": "<string>",
"scopeName": "<string>"
}
],
"secondaryDisplayLabelPropertyNames": [
"<string>"
],
"accessScopeName": "<string>",
"createdAt": 123,
"description": "<string>",
"integrationAppId": 123,
"janusGroup": "<string>",
"ownerPortalId": 123,
"pipelineCloseDatePropertyName": "<string>",
"pipelineTimeToClosePropertyName": "<string>",
"pluralForm": "<string>",
"primaryDisplayLabelPropertyName": "<string>",
"readScopeName": "<string>",
"singularForm": "<string>",
"status": "<string>",
"visibility": "<string>",
"writeScopeName": "<string>"
}
}Obtenha os tipos de objetos existentes que pertencem ao tipo de mídia especificado.
curl --request GET \
--url 'https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}?hapikey='{
"objectTypeId": "<string>",
"objectTypeName": "<string>",
"properties": [
{
"objectTypeId": "<string>",
"property": {
"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": false,
"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
},
"calculationExpression": {
"operator": "CONSTANT_BOOLEAN",
"inputs": [
"<unknown>"
],
"propertyName": "<string>",
"value": true
},
"calculationFormula": "<string>",
"definitionSource": {
"type": "GLOBAL",
"name": "<string>"
},
"extensionData": {
"extensionStatusMap": {},
"tags": [
"<string>"
],
"caseChangeTestExtensionData": {
"mood": "<string>"
},
"optionDecoratorsExtensionData": {
"optionDecoratorStyle": "<string>",
"optionDecorators": {}
},
"requiredPropertiesExtensionData": {
"isRequiredProperty": true
},
"softRequiredPropertiesExtensionData": {
"isSoftRequiredProperty": true
}
},
"externalOptionsMetaData": {
"filter": {
"includeUnconfirmedUsers": true,
"pipelineIds": [
"<string>"
]
},
"relatedObjectTypeId": "<string>"
},
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"janusGroup": "<string>",
"permission": {
"accessLevel": "<string>"
},
"propertyDefinitionSource": {
"type": "<string>",
"name": "<string>"
},
"propertyRequirements": {
"gates": [
"<string>"
],
"operator": "AND",
"scopeNames": [
"<string>"
],
"settings": [
"<string>"
]
},
"rollupExpression": {
"associationTypes": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 123
}
],
"rollupOperator": "<string>",
"sourceObjectTypeId": "<string>",
"sourcePropertyName": "<string>",
"conditionalExpression": {
"operator": "CONSTANT_BOOLEAN",
"inputs": [
"<unknown>"
],
"propertyName": "<string>",
"value": true
},
"conditionalFormula": "<string>",
"emptyRollupValue": "<string>",
"sourceCompareByPropertyName": "<string>"
}
}
],
"propertyGroups": [
{
"displayName": "<string>",
"displayOrder": 123,
"fulcrumPortalId": 123,
"fulcrumTimestamp": 123,
"hubspotDefined": true,
"name": "<string>"
}
],
"schema": {
"allowsSensitiveProperties": true,
"createDatePropertyName": "<string>",
"defaultSearchPropertyNames": [
"<string>"
],
"deleted": true,
"fullyQualifiedName": "<string>",
"hasCustomProperties": true,
"hasDefaultProperties": true,
"hasExternalObjectIds": true,
"hasOwners": true,
"hasPipelines": true,
"id": 123,
"indexedForFiltersAndReports": true,
"lastModifiedPropertyName": "<string>",
"metaType": "CMS_HUBDB",
"metaTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"permissioningType": "<string>",
"pipelinePropertyName": "<string>",
"pipelineStagePropertyName": "<string>",
"requiredProperties": [
"<string>"
],
"restorable": true,
"scopeMappings": [
{
"accessLevel": "<string>",
"requestAction": "<string>",
"scopeName": "<string>"
}
],
"secondaryDisplayLabelPropertyNames": [
"<string>"
],
"accessScopeName": "<string>",
"createdAt": 123,
"description": "<string>",
"integrationAppId": 123,
"janusGroup": "<string>",
"ownerPortalId": 123,
"pipelineCloseDatePropertyName": "<string>",
"pipelineTimeToClosePropertyName": "<string>",
"pluralForm": "<string>",
"primaryDisplayLabelPropertyName": "<string>",
"readScopeName": "<string>",
"singularForm": "<string>",
"status": "<string>",
"visibility": "<string>",
"writeScopeName": "<string>"
}
}O appId do aplicativo Media Bridge. É possível ter vários aplicativos na sua conta de desenvolvedor que usam a Media Bridge.
O tipo de mídia para o qual você deseja obter os tipos de objeto.
AUDIO, DOCUMENT, IMAGE, OTHER, VIDEO Inclua a definição completa na resposta.
successful operation
Mostrar atributos filhos
A HubSpot property
Mostrar atributos filhos
Se a propriedade é um campo calculado.
A data e hora em que a propriedade foi criada, no formato ISO 8601.
O ID do usuário que criou a propriedade.
O nome da propriedade de moeda relacionada.
Indica o nível de sensibilidade da propriedade, como "non_sensitive", "sensitive" ou "highly_sensitive".
high, none, standard absolute, absolute_with_relative, time_since, time_until Se a propriedade foi excluída.
Um resumo da finalidade da propriedade.
O modo em que a propriedade é exibida. Pode ser: "current_value" ou "all_unique_versions".
all_unique_versions, current_value A posição do item em relação aos outros na lista.
Aplicável apenas a propriedades do tipo enumeração. Deve ser definido como verdadeiro com um "referencedObjectType" de "PROPRIETÁRIO". Caso contrário, falso.
Quando externalOptions é verdadeiro, indica que os valores de opção da propriedade serão preenchidos de outros sistemas (por exemplo, "PROPRIETÁRIO" para a propriedade hubspot_owner_id).
Obsoleto. Se a propriedade está marcada como favorita.
Obsoleto. A posição na ordem quando marcada como favorita.
Determina como a propriedade aparecerá na interface do HubSpot ou em um formulário. Saiba mais no guia da API de propriedades.
Se a propriedade pode aparecer em formulários.
O ID do usuário que atualizou a propriedade pela última vez.
O nome do grupo ao qual a propriedade é atribuída.
Se a propriedade é uma propriedade de identificador exclusivo.
Se a propriedade será ou não ocultada da interface do HubSpot. É recomendado definir como falso para propriedades personalizadas.
false
Um valor booleano definido como verdadeiro para propriedades padrão do HubSpot.
Para propriedades padrão, indica se a propriedade foi personalizada. Equivalente ao campo "isCustomizedDefault".
Se a propriedade pode conter vários valores.
Para propriedades padrão, indica se a propriedade foi personalizada. Equivalente ao campo "isCustomizedDefault".
O rótulo de exibição da propriedade.
Se a definição da propriedade pode ser personalizada, mas não excluída.
O nome interno da propriedade.
Dica de como uma propriedade numérica é exibida e validada na interface do HubSpot. Pode ser: "sem formato", "formatado", "moeda", "porcentagem", "duração" ou "probabilidade".
currency, duration, formatted, percentage, probability, unformatted Especifica como classificar as opções de propriedade. Pode ser "DISPLAY_ORDER" para adiar para o campo displayOrder ou "ALFABÉTICO".
ALPHABETICAL, DISPLAY_ORDER Uma lista de opções válidas para a propriedade. Este campo é obrigatório para propriedades enumeradas.
Mostrar atributos filhos
Uma descrição da opção.
A posição do item em relação aos outros na lista.
Se a opção é exibida na interface do HubSpot.
Um rótulo amigável que identifica a opção.
Se a opção é somente leitura.
O valor real da opção.
Se as opções podem ser modificadas após a criação.
O ID da conta da HubSpot onde a propriedade está definida.
Se a descrição da propriedade é somente leitura.
Indica se o valor da propriedade é somente leitura.
Obsoleto. Em vez disso, use externalOptionsReferenceType.
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 Se a propriedade pode ser pesquisada globalmente.
Quando sensitiveData é verdadeiro, lista o tipo de dados confidenciais contidos na propriedade (por exemplo, "HIPAA").
Se o símbolo da moeda deve ser exibido na interface do HubSpot.
Dica de como o texto é exibido e validado na interface do HubSpot. Pode ser: "unformatted_single_line", "multi_line", "email", "phone_number", "domain_name", "ip_address", "physical_address" ou "postal_code".
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line O tipo de dados da propriedade, como string ou número.
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string A data e hora em que a propriedade foi atualizada pela última vez, no formato ISO 8601.
Mostrar atributos filhos
CONSTANT_BOOLEAN Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
Mostrar atributos filhos
A categoria da associação, por exemplo, "HUBSPOT_DEFINED".
HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED O ID que representa o tipo específico de associação.
Mostrar atributos filhos
CONSTANT_BOOLEAN Mostrar atributos filhos
CONSTANT_NUMBER Mostrar atributos filhos
Mostrar atributos filhos
CMS_HUBDB, HUBSPOT, HUBSPOT_EVENT, INTEGRATION, INTEGRATION_EVENT, PORTAL_SPECIFIC, PORTAL_SPECIFIC_EVENT