> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve workflows > リクエスト本文でフローIDをバッチ指定して、複数の自動化フローの詳細を取得します。このエンドポイントにより、複数のフローを一度に効率的に取得し、1つのレスポンスでその詳細を返すことができます。 export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => { const translations = { header: "サポートされる製品", description: "次のいずれかの製品またはそれ以上が必要です。", productNames: { marketing: "Marketing Hub", sales: "Sales Hub", service: "Service Hub", cms: "Content Hub" }, tiers: { free: "無料ツール", starter: "Starter", professional: "Professional", enterprise: "Enterprise" } }; const translateTier = tier => { if (!tier) return ''; const lowerTier = tier.toLowerCase(); return translations.tiers[lowerTier] || tier; }; const products = [{ name: marketing ? translations.productNames.marketing : '', level: translateTier(marketingLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg", alt: "Marketing Hub" }, { name: sales ? translations.productNames.sales : '', level: translateTier(salesLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg", alt: "Sales Hub" }, { name: service ? translations.productNames.service : '', level: translateTier(serviceLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg", alt: "Service Hub" }, { name: cms ? translations.productNames.cms : '', level: translateTier(cmsLevel), icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg", alt: "Content Hub" }].filter(product => product.name && product.level); if (products.length === 0) return null; return
{translations.description}
{products.map((product, index) =>
{product.alt} {product.name} - {product.level}
)}
; }; ## OpenAPI ````yaml specs/legacy/v4/automation-automation-v4-v4.json POST /automation/v4/flows/batch/read openapi: 3.0.1 info: title: Automation Automation V4 description: Basepom for all HubSpot Projects version: v4 x-hubspot-product-tier-requirements: marketing: PROFESSIONAL sales: PROFESSIONAL service: PROFESSIONAL cms: PROFESSIONAL commerce: PROFESSIONAL crmHub: PROFESSIONAL dataHub: PROFESSIONAL servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Batch paths: /automation/v4/flows/batch/read: post: tags: - Batch summary: ワークフローを取得 description: >- リクエスト本文でフローIDをバッチ指定して、複数の自動化フローの詳細を取得します。このエンドポイントにより、複数のフローを一度に効率的に取得し、1つのレスポンスでその詳細を返すことができます。 operationId: post-/automation/v4/flows/batch/read parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ApiFlowBatchInput' required: true responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/BatchResponseApiFlow' '207': description: multiple statuses content: application/json: schema: $ref: '#/components/schemas/BatchResponseApiFlowWithErrors' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - automation components: schemas: ApiFlowBatchInput: required: - inputs type: object properties: inputs: type: array items: oneOf: - $ref: '#/components/schemas/ApiFlowBatchFetchFlowIdCoordinate' BatchResponseApiFlow: required: - completedAt - results - startedAt - status type: object properties: completedAt: type: string description: 日付-時刻文字列として書式設定される、バッチ処理が完了された日時。 format: date-time links: type: object additionalProperties: type: string description: バッチ処理に関連付けられたURLのコレクションで、この処理では空です。 requestedAt: type: string description: 日付-時刻文字列として書式設定される、バッチリクエストが開始された日時。 format: date-time results: type: array items: $ref: '#/components/schemas/ApiFlow' startedAt: type: string description: 日付-時刻文字列として書式設定される、バッチ処理が開始された日時。 format: date-time status: type: string description: 次の値を取り得る、バッチ処理の現在のステータス：CANCELED、COMPLETE、PENDING、PROCESSING。 enum: - CANCELED - COMPLETE - PENDING - PROCESSING BatchResponseApiFlowWithErrors: required: - completedAt - results - startedAt - status type: object properties: completedAt: type: string description: 日付-時刻文字列として書式設定される、バッチ処理が完了された日時。 format: date-time errors: type: array items: $ref: '#/components/schemas/StandardError' links: type: object additionalProperties: type: string description: バッチ処理に関連付けられたURLのコレクション。 numErrors: type: integer description: バッチ処理中に発生したエラーの合計数。 format: int32 requestedAt: type: string description: 日付-時刻文字列として書式設定される、バッチリクエストが開始された日時。 format: date-time results: type: array items: $ref: '#/components/schemas/ApiFlow' startedAt: type: string description: 日付-時刻文字列として書式設定される、バッチ処理が開始された日時。 format: date-time status: type: string description: 次の値を取り得る、バッチ処理の現在のステータス：CANCELED、COMPLETE、PENDING、PROCESSING。 enum: - CANCELED - COMPLETE - PENDING - PROCESSING ApiFlowBatchFetchFlowIdCoordinate: title: FLOW_ID required: - flowId - type type: object properties: flowId: type: string description: 自動化フローの固有ID。 type: type: string description: 座標のタイプを指定します：FLOW_ID。 default: FLOW_ID enum: - FLOW_ID x-hubspot-sub-type-impl: true ApiFlow: properties: {} oneOf: - $ref: '#/components/schemas/ApiContactFlow' - $ref: '#/components/schemas/ApiPlatformFlow' StandardError: required: - category - context - errors - links - message - status type: object properties: category: type: string description: エラーの主カテゴリー。 context: type: object additionalProperties: type: array items: type: string description: エラーに関連する、状況に固有の追加情報。 errors: type: array description: 詳細なエラーオブジェクト。 items: $ref: '#/components/schemas/ErrorDetail' id: type: string description: エラーインスタンスの固有ID。 links: type: object additionalProperties: type: string description: エラーに関連付けられているドキュメントまたは資料につながるURL。 message: type: string description: エラーと取り得る修正手順を記した、人が理解できる文字列。 status: type: string description: エラーに関連付けられたHTTPステータスコード。 subCategory: type: object properties: {} description: それぞれの主カテゴリー内の、さらに具体的なエラーカテゴリー。 description: HubSpot APIにおける標準的なエラーレスポンスを表し、APIリクエスト中に発生したエラーに関する詳細情報を提供します。 Error: required: - category - correlationId - message type: object properties: category: type: string description: エラーカテゴリー context: type: object additionalProperties: type: array items: type: string description: エラー条件に関する背景状況 example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: リクエストの固有ID。エラー報告またはサポートチケットには必ずこの値を含めてください format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: エラーに関する詳細情報 items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: エラーまたは推奨の修正手順に関するドキュメントが含まれる関連付けられたURIへのリンク名の対応付け message: type: string description: エラーと修正手順（該当する場合）を記した、人が理解できるメッセージ example: An error occurred subCategory: type: string description: エラーに関する具体的な詳細が含まれる特定のカテゴリー example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base ApiContactFlow: required: - actions - blockedDates - canEnrollFromSalesforce - createdAt - crmObjectCreationStatus - customProperties - dataSources - flowType - id - isEnabled - nextAvailableActionId - objectTypeId - revisionId - suppressionListIds - timeWindows - type - updatedAt type: object properties: actions: type: array items: oneOf: - $ref: '#/components/schemas/ApiStaticBranchAction' - $ref: '#/components/schemas/ApiListBranchAction' - $ref: '#/components/schemas/ApiABTestBranchAction' - $ref: '#/components/schemas/ApiCustomCodeAction' - $ref: '#/components/schemas/ApiWebhookAction' - $ref: '#/components/schemas/ApiSingleConnectionAction' blockedDates: type: array items: $ref: '#/components/schemas/ApiBlockedDate' canEnrollFromSalesforce: type: boolean createdAt: type: string format: date-time crmObjectCreationStatus: type: string enum: - COMPLETE - PENDING customProperties: type: object additionalProperties: type: string dataSources: type: array items: oneOf: - $ref: '#/components/schemas/ApiAssociationDataSource' - $ref: '#/components/schemas/ApiAssociationTimestampDataSource' - $ref: '#/components/schemas/ApiStaticPropertyFilterDataSource' - $ref: '#/components/schemas/ApiEnrolledRecordPropertyFilterDataSource' - $ref: '#/components/schemas/ApiDatasetFieldPropertyFilterDataSource' - $ref: >- #/components/schemas/ApiEnrolledArgumentPropertyFilterDataSource description: type: string enrollmentCriteria: oneOf: - $ref: '#/components/schemas/ApiListBasedEnrollmentCriteria' - $ref: '#/components/schemas/ApiEventBasedEnrollmentCriteria' - $ref: '#/components/schemas/ApiManualEnrollmentCriteria' - $ref: '#/components/schemas/ApiDatasetBasedEnrollmentCriteria' enrollmentSchedule: oneOf: - $ref: '#/components/schemas/ApiDailyEnrollmentSchedule' - $ref: '#/components/schemas/ApiWeeklyEnrollmentSchedule' - $ref: '#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule' - $ref: '#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule' - $ref: '#/components/schemas/ApiYearlyEnrollmentSchedule' - $ref: '#/components/schemas/ApiPropertyBasedEnrollmentSchedule' eventAnchor: oneOf: - $ref: '#/components/schemas/ApiContactPropertyAnchor' - $ref: '#/components/schemas/ApiStaticDateAnchor' flowType: type: string enum: - ACTION_SET - UNKNOWN - WORKFLOW goalFilterBranch: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' id: type: string isEnabled: type: boolean name: type: string nextAvailableActionId: type: string objectTypeId: type: string revisionId: type: string startActionId: type: string suppressionListIds: type: array items: type: integer format: int32 timeWindows: type: array items: $ref: '#/components/schemas/ApiTimeWindow' type: type: string default: CONTACT_FLOW enum: - CONTACT_FLOW unEnrollmentSetting: $ref: '#/components/schemas/ApiUnEnrollmentSetting' updatedAt: type: string format: date-time uuid: type: string x-hubspot-sub-type-impl: true ApiPlatformFlow: required: - actions - blockedDates - createdAt - crmObjectCreationStatus - customProperties - dataSources - flowType - id - isEnabled - nextAvailableActionId - objectTypeId - revisionId - timeWindows - type - updatedAt type: object properties: actions: type: array items: oneOf: - $ref: '#/components/schemas/ApiStaticBranchAction' - $ref: '#/components/schemas/ApiListBranchAction' - $ref: '#/components/schemas/ApiABTestBranchAction' - $ref: '#/components/schemas/ApiCustomCodeAction' - $ref: '#/components/schemas/ApiWebhookAction' - $ref: '#/components/schemas/ApiSingleConnectionAction' blockedDates: type: array items: $ref: '#/components/schemas/ApiBlockedDate' createdAt: type: string format: date-time crmObjectCreationStatus: type: string enum: - COMPLETE - PENDING customProperties: type: object additionalProperties: type: string dataSources: type: array items: oneOf: - $ref: '#/components/schemas/ApiAssociationDataSource' - $ref: '#/components/schemas/ApiAssociationTimestampDataSource' - $ref: '#/components/schemas/ApiStaticPropertyFilterDataSource' - $ref: '#/components/schemas/ApiEnrolledRecordPropertyFilterDataSource' - $ref: '#/components/schemas/ApiDatasetFieldPropertyFilterDataSource' - $ref: >- #/components/schemas/ApiEnrolledArgumentPropertyFilterDataSource description: type: string enrollmentCriteria: oneOf: - $ref: '#/components/schemas/ApiListBasedEnrollmentCriteria' - $ref: '#/components/schemas/ApiEventBasedEnrollmentCriteria' - $ref: '#/components/schemas/ApiManualEnrollmentCriteria' - $ref: '#/components/schemas/ApiDatasetBasedEnrollmentCriteria' enrollmentSchedule: oneOf: - $ref: '#/components/schemas/ApiDailyEnrollmentSchedule' - $ref: '#/components/schemas/ApiWeeklyEnrollmentSchedule' - $ref: '#/components/schemas/ApiMonthlySpecificDaysEnrollmentSchedule' - $ref: '#/components/schemas/ApiMonthlyRelativeDaysEnrollmentSchedule' - $ref: '#/components/schemas/ApiYearlyEnrollmentSchedule' - $ref: '#/components/schemas/ApiPropertyBasedEnrollmentSchedule' flowType: type: string enum: - ACTION_SET - UNKNOWN - WORKFLOW id: type: string isEnabled: type: boolean name: type: string nextAvailableActionId: type: string objectTypeId: type: string revisionId: type: string startActionId: type: string suppressionFilterBranch: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' timeWindows: type: array items: $ref: '#/components/schemas/ApiTimeWindow' type: type: string default: PLATFORM_FLOW enum: - PLATFORM_FLOW updatedAt: type: string format: date-time uuid: type: string x-hubspot-sub-type-impl: true ErrorDetail: required: - message type: object properties: code: type: string description: エラーの詳細に関連付けられているステータスコード context: type: object additionalProperties: type: array items: type: string description: エラー条件に関する背景状況 example: '{missingScopes=[scope1, scope2]}' in: type: string description: エラーが見つかったフィールドまたはパラメーターの名前。 message: type: string description: エラーと修正手順（該当する場合）を記した、人が理解できるメッセージ subCategory: type: string description: エラーに関する具体的な詳細が含まれる特定のカテゴリー ApiStaticBranchAction: title: STATIC_BRANCH required: - actionId - inputValue - staticBranches - type type: object properties: actionId: type: string description: この静的な分岐アクションの固有ID。 defaultBranch: $ref: '#/components/schemas/ApiConnection' defaultBranchName: type: string description: 静的な分岐アクション内のデフォルトの分岐の名前。 inputValue: description: 静的な分岐アクションの入力値を表し、アクションデータ、オブジェクトプロパティー、静的な値などのさまざまなタイプを取り得ます。 oneOf: - $ref: '#/components/schemas/ApiActionDataValue' - $ref: '#/components/schemas/ApiObjectPropertyValue' - $ref: '#/components/schemas/ApiStaticValue' - $ref: '#/components/schemas/ApiRelativeDateTimeValue' - $ref: '#/components/schemas/ApiTimestampValue' - $ref: '#/components/schemas/ApiIncrementValue' - $ref: '#/components/schemas/ApiFetchedObjectPropertyValue' - $ref: '#/components/schemas/ApiAppendObjectPropertyValue' - $ref: '#/components/schemas/ApiStaticAppendValue' - $ref: '#/components/schemas/ApiEnrollmentEventPropertyValue' - $ref: '#/components/schemas/ApiActionOutputObjectPropertyValue' staticBranches: type: array items: $ref: '#/components/schemas/ApiStaticBranch' type: type: string description: アクションのタイプを示し、デフォルトではSTATIC_BRANCHです。 default: STATIC_BRANCH enum: - STATIC_BRANCH x-hubspot-sub-type-impl: true ApiListBranchAction: title: LIST_BRANCH required: - actionId - listBranches - type type: object properties: actionId: type: string description: リスト分岐アクションの固有ID。 defaultBranch: $ref: '#/components/schemas/ApiConnection' defaultBranchName: type: string description: リストアクション内のデフォルトの分岐の名前。 listBranches: type: array items: $ref: '#/components/schemas/ApiListBranch' type: type: string description: アクションのタイプを示し、デフォルトではLIST_BRANCHです。 default: LIST_BRANCH enum: - LIST_BRANCH x-hubspot-sub-type-impl: true ApiABTestBranchAction: title: AB_TEST_BRANCH required: - actionId - testBranches - type type: object properties: actionId: type: string description: A/Bテストの分岐アクションの固有ID。 testBranches: type: array items: $ref: '#/components/schemas/ApiABTestBranch' type: type: string description: アクションのタイプを示し、デフォルトではAB_TEST_BRANCHです。 default: AB_TEST_BRANCH enum: - AB_TEST_BRANCH x-hubspot-sub-type-impl: true ApiCustomCodeAction: title: CUSTOM_CODE required: - actionId - inputFields - outputFields - runtime - secretNames - sourceCode - type type: object properties: actionId: type: string description: カスタム コード アクションの固有ID。 connection: $ref: '#/components/schemas/ApiConnection' inputFields: type: array items: $ref: '#/components/schemas/ApiInputVariable' outputFields: type: array items: oneOf: - $ref: '#/components/schemas/ApiEnumerationOutputField' runtime: type: string description: カスタム コード アクションのランタイム環境を指定します。 secretNames: type: array items: type: string sourceCode: type: string description: カスタム コード アクションのソースコードが含まれます。 type: type: string description: アクションのタイプを示し、デフォルトではCUSTOM_CODEです。 default: CUSTOM_CODE enum: - CUSTOM_CODE x-hubspot-sub-type-impl: true ApiWebhookAction: title: WEBHOOK required: - actionId - method - queryParams - type - webhookUrl type: object properties: actionId: type: string description: Webhookアクションの固有ID。 authSettings: description: Webhookの認証設定を定義します。認証キーまたは署名を含めることができます。 oneOf: - $ref: '#/components/schemas/ApiAuthKeyWebhookAuthSettings' - $ref: '#/components/schemas/ApiSignatureWebhookAuthSettings' connection: $ref: '#/components/schemas/ApiConnection' method: type: string description: >- Webhookリクエストに使用されるHTTPメソッドを指定します。受け入れられる値は、CONNECT、DELETE、GET、HEAD、OPTIONS、PATCH、POST、PUT、TRACEなどです。 enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE queryParams: type: array items: $ref: '#/components/schemas/ApiInputVariable' type: type: string description: アクションのタイプを示し、デフォルトではWEBHOOKです。 default: WEBHOOK enum: - WEBHOOK webhookUrl: type: string description: Webhookリクエストが送信されるURL。 x-hubspot-sub-type-impl: true ApiSingleConnectionAction: title: SINGLE_CONNECTION required: - actionId - actionTypeId - actionTypeVersion - fields - type type: object properties: actionId: type: string description: 1つの接続アクションの固有ID。 actionTypeId: type: string description: 実行されるアクションのタイプのID。 actionTypeVersion: type: integer description: アクションタイプのバージョンを指定します。 format: int32 connection: $ref: '#/components/schemas/ApiConnection' fields: type: object additionalProperties: type: object properties: {} description: 1つの接続アクションと関連付けられたフィールドが含まれます。 type: type: string description: アクションのタイプを示し、デフォルトではSINGLE_CONNECTIONです。 default: SINGLE_CONNECTION enum: - SINGLE_CONNECTION x-hubspot-sub-type-impl: true ApiBlockedDate: required: - dayOfMonth - month type: object properties: dayOfMonth: type: integer description: ブロックされた日付の月の特定の日。 format: int32 month: type: string description: >- ブロックされた日付の月。受け入れられる値：APRIL、AUGUST、DECEMBER、FEBRUARY、JANUARY、JULY、JUNE、MARCH、MAY、NOVEMBER、OCTOBER、SEPTEMBER。 enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER year: type: integer description: ブロックされた日付の年。 format: int32 ApiAssociationDataSource: title: ASSOCIATION required: - associationCategory - associationTypeId - name - objectTypeId - type type: object properties: associationCategory: type: string description: >- 関連付けのカテゴリーを定義します。可能な値は、HUBSPOT_DEFINED、INTEGRATOR_DEFINED、またはUSER_DEFINEDです。 enum: - HUBSPOT_DEFINED - INTEGRATOR_DEFINED - USER_DEFINED - WORK associationTypeId: type: integer description: 関連付けのタイプを表すID。 format: int32 name: type: string description: データソースの名前。 objectTypeId: type: string description: データソースと関連付けられたオブジェクトタイプのIDを表します。 sortBy: $ref: '#/components/schemas/ApiSort' type: type: string description: データソースのタイプを示し、デフォルトではASSOCIATIONです。 default: ASSOCIATION enum: - ASSOCIATION x-hubspot-sub-type-impl: true ApiAssociationTimestampDataSource: title: ASSOCIATION_TIMESTAMP required: - associationCategory - associationTypeId - name - objectTypeId - type type: object properties: associationCategory: type: string description: >- 関連付けのカテゴリーを定義します。可能な値は、HUBSPOT_DEFINED、INTEGRATOR_DEFINED、またはUSER_DEFINEDです。 enum: - HUBSPOT_DEFINED - INTEGRATOR_DEFINED - USER_DEFINED - WORK associationTypeId: type: integer description: 関連付けのタイプを表すID。 format: int32 name: type: string description: データソースの名前を指定します。 objectTypeId: type: string description: データソースと関連付けられたオブジェクトタイプのIDを表します。 type: type: string description: データソースのタイプを示し、デフォルトではASSOCIATION_TIMESTAMPです。 default: ASSOCIATION_TIMESTAMP enum: - ASSOCIATION_TIMESTAMP x-hubspot-sub-type-impl: true ApiStaticPropertyFilterDataSource: title: STATIC_PROPERTY_FILTER required: - name - propertyName - staticValue - type type: object properties: name: type: string description: データソースの名前を定義します。 propertyName: type: string description: 静的なプロパティーフィルターで使用されるプロパティーの名前を指定します。 sortBy: $ref: '#/components/schemas/ApiSort' staticValue: type: string description: プロパティーフィルターで使用される静的な値を表します。 type: type: string description: データソースのタイプを示し、デフォルトではSTATIC_PROPERTY_FILTERです。 default: STATIC_PROPERTY_FILTER enum: - STATIC_PROPERTY_FILTER x-hubspot-sub-type-impl: true ApiEnrolledRecordPropertyFilterDataSource: title: ENROLLED_RECORD_PROPERTY_FILTER required: - name - propertyName - recordFieldName - type type: object properties: name: type: string description: データソースの名前を定義します。 propertyName: type: string description: 登録されたレコード プロパティー フィルターで使用されるプロパティーの名前を指定します。 recordFieldName: type: string description: 絞り込むレコードのフィールドの名前。 sortBy: $ref: '#/components/schemas/ApiSort' type: type: string description: データソースのタイプを示し、デフォルトではENROLLED_RECORD_PROPERTY_FILTERです。 default: ENROLLED_RECORD_PROPERTY_FILTER enum: - ENROLLED_RECORD_PROPERTY_FILTER x-hubspot-sub-type-impl: true ApiDatasetFieldPropertyFilterDataSource: title: DATASET_FIELD_PROPERTY_FILTER required: - datasetFieldName - name - propertyName - type type: object properties: datasetFieldName: type: string description: プロパティーフィルターで使用されるデータセットフィールドの名前を指定します。 name: type: string description: データソースの名前を定義します。 propertyName: type: string description: データセットフィールドのプロパティーフィルターで使用されるプロパティーの名前を指定します。 sortBy: $ref: '#/components/schemas/ApiSort' type: type: string description: データソースのタイプを示し、デフォルトではDATASET_FIELD_PROPERTY_FILTERです。 default: DATASET_FIELD_PROPERTY_FILTER enum: - DATASET_FIELD_PROPERTY_FILTER x-hubspot-sub-type-impl: true ApiEnrolledArgumentPropertyFilterDataSource: title: ENROLLED_ARGUMENT_PROPERTY_FILTER required: - argumentName - name - propertyName - type type: object properties: argumentName: type: string description: 登録された引数プロパティーフィルターで使用される引数の名前。 name: type: string description: データソースの名前を定義します。 propertyName: type: string description: 登録された引数プロパティーフィルターで使用されるプロパティーの名前を指定します。 sortBy: $ref: '#/components/schemas/ApiSort' type: type: string description: データソースのタイプを示し、デフォルトではENROLLED_ARGUMENT_PROPERTY_FILTERです。 default: ENROLLED_ARGUMENT_PROPERTY_FILTER enum: - ENROLLED_ARGUMENT_PROPERTY_FILTER x-hubspot-sub-type-impl: true ApiListBasedEnrollmentCriteria: title: LIST_BASED required: - listFilterBranch - reEnrollmentTriggersFilterBranches - shouldReEnroll - type - unEnrollObjectsNotMeetingCriteria type: object properties: listFilterBranch: description: リストに基づく登録条件を判定するために使用されるフィルター分岐を定義します。 oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' reEnrollmentTriggersFilterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' shouldReEnroll: type: boolean description: オブジェクトが再び条件を満たしたときに再登録するかどうかを判定します。 type: type: string description: 登録条件のタイプを指定し、デフォルトでは「LIST_BASED」です。 default: LIST_BASED enum: - LIST_BASED unEnrollObjectsNotMeetingCriteria: type: boolean description: 条件を満たさないオブジェクトを登録解除するかどうかを示します。 x-hubspot-sub-type-impl: true ApiEventBasedEnrollmentCriteria: title: EVENT_BASED required: - eventFilterBranches - listMembershipFilterBranches - shouldReEnroll - type type: object properties: eventFilterBranches: type: array items: $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' listMembershipFilterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' refinementCriteria: description: 登録プロセスをブラッシュアップする追加の条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' shouldReEnroll: type: boolean description: オブジェクトが再び条件を満たしたときに再登録するかどうかを判定します。 type: type: string description: 登録条件のタイプを指定し、デフォルトでは「EVENT_BASED」です。 default: EVENT_BASED enum: - EVENT_BASED x-hubspot-sub-type-impl: true ApiManualEnrollmentCriteria: title: MANUAL required: - shouldReEnroll - type type: object properties: shouldReEnroll: type: boolean description: 登録を繰り返すかどうかを示します。 type: type: string description: 登録条件のタイプを指定します（「MANUAL」）。 default: MANUAL enum: - MANUAL x-hubspot-sub-type-impl: true ApiDatasetBasedEnrollmentCriteria: title: DATASET required: - datasetId - shouldReEnroll - type type: object properties: datasetId: type: integer format: int64 shouldReEnroll: type: boolean subviewId: type: string type: type: string default: DATASET enum: - DATASET x-hubspot-sub-type-impl: true ApiDailyEnrollmentSchedule: title: DAILY required: - timeOfDay - type type: object properties: timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' type: type: string description: 登録スケジュールのタイプを指定します（「DAILY」）。 default: DAILY enum: - DAILY x-hubspot-sub-type-impl: true ApiWeeklyEnrollmentSchedule: title: WEEKLY required: - daysOfWeek - timeOfDay - type type: object properties: daysOfWeek: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' type: type: string description: 登録スケジュールのタイプを示します（「WEEKLY」）。 default: WEEKLY enum: - WEEKLY x-hubspot-sub-type-impl: true ApiMonthlySpecificDaysEnrollmentSchedule: title: MONTHLY_SPECIFIC_DAYS required: - daysOfMonth - timeOfDay - type type: object properties: daysOfMonth: type: array items: type: integer format: int32 timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' type: type: string description: 登録スケジュールのタイプを指定します（「MONTHLY_SPECIFIC_DAYS」）。 default: MONTHLY_SPECIFIC_DAYS enum: - MONTHLY_SPECIFIC_DAYS x-hubspot-sub-type-impl: true ApiMonthlyRelativeDaysEnrollmentSchedule: title: MONTHLY_RELATIVE_DAYS required: - monthlyRelativeDays - timeOfDay - type type: object properties: monthlyRelativeDays: type: string description: 登録が可能な相対的な日数の1つ：LAST_DAY_OF_MONTHまたはFIRST_MONDAY_OF_MONTH enum: - FIRST_MONDAY_OF_MONTH - LAST_DAY_OF_MONTH timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' type: type: string description: スケジュールのタイプ。常にMONTHLY_RELATIVE_DAYS default: MONTHLY_RELATIVE_DAYS enum: - MONTHLY_RELATIVE_DAYS x-hubspot-sub-type-impl: true ApiYearlyEnrollmentSchedule: title: YEARLY required: - dayOfMonth - month - timeOfDay - type type: object properties: dayOfMonth: type: integer description: 年次登録スケジュールの月の特定の日。 format: int32 month: type: string description: >- 年次登録スケジュールの月。受け入れられる値：APRIL、AUGUST、DECEMBER、FEBRUARY、JANUARY、JULY、JUNE、MARCH、MAY、NOVEMBER、OCTOBER、SEPTEMBER。 enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' type: type: string description: 登録スケジュールのタイプを示し、デフォルトでは「YEARLY」です。 default: YEARLY enum: - YEARLY x-hubspot-sub-type-impl: true ApiPropertyBasedEnrollmentSchedule: title: PROPERTY_BASED required: - dateProperty - daysDelta - timeOfDay - type - yearly type: object properties: dateProperty: type: string description: 登録スケジュール設定の日付を判定するために使用されるプロパティー。 daysDelta: type: integer description: datePropertyに対して相対的な登録日を調整する日数。 format: int32 timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' type: type: string description: 登録スケジュールのタイプを指定します（「PROPERTY_BASED」）。 default: PROPERTY_BASED enum: - PROPERTY_BASED yearly: type: boolean description: 登録スケジュールを毎年繰り返すように設定するかどうかを示します。 x-hubspot-sub-type-impl: true ApiContactPropertyAnchor: title: CONTACT_PROPERTY_ANCHOR required: - contactProperty - type type: object properties: contactProperty: type: string description: アンカーと関連付けられたコンタクトプロパティーを指定します。 type: type: string description: コンタクトプロパティーのアンカーのタイプを示し、デフォルトではCONTACT_PROPERTY_ANCHORです。 default: CONTACT_PROPERTY_ANCHOR enum: - CONTACT_PROPERTY_ANCHOR x-hubspot-sub-type-impl: true ApiStaticDateAnchor: title: STATIC_DATE_ANCHOR required: - dayOfMonth - month - type type: object properties: dayOfMonth: type: integer description: 静的な日付アンカーの月の特定の日。 format: int32 month: type: string description: >- 静的な日付アンカーの月コンポーネント。受け入れられる値：APRIL、AUGUST、DECEMBER、FEBRUARY、JANUARY、JULY、JUNE、MARCH、MAY、NOVEMBER、OCTOBER、SEPTEMBER。 enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER type: type: string description: 日付アンカーのタイプを示し、デフォルトではSTATIC_DATE_ANCHORです。 default: STATIC_DATE_ANCHOR enum: - STATIC_DATE_ANCHOR year: type: integer description: 静的な日付アンカーの年コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicOrFilterBranch: title: OR required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではORです。 default: OR enum: - OR filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicAndFilterBranch: title: AND required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではANDです。 default: AND enum: - AND filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAllFilterBranch: title: NOT_ALL required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではNOT_ALLです。 default: NOT_ALL enum: - NOT_ALL filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicNotAnyFilterBranch: title: NOT_ANY required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではNOT_ANYです。 default: NOT_ANY enum: - NOT_ANY filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicRestrictedFilterBranch: title: RESTRICTED required: - filterBranchOperator - filterBranchType - filterBranches - filters type: object properties: filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではRESTRICTEDです。 default: RESTRICTED enum: - RESTRICTED filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' x-hubspot-sub-type-impl: true PublicUnifiedEventsFilterBranch: title: UNIFIED_EVENTS required: - eventTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - operator type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、イベントをブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: 統合イベントのフィルター分岐と関連付けられたイベントのタイプのID。 filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではUNIFIED_EVENTSです。 default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' operator: type: string description: >- 統合イベントのフィルター分岐で使用される演算子を指定します。受け入れられる値は、HAS_COMPLETEDまたはHAS_NOT_COMPLETEDです。 enum: - HAS_COMPLETED - HAS_NOT_COMPLETED pruningRefineBy: oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicAssociationFilterBranch: title: ASSOCIATION required: - associationCategory - associationTypeId - filterBranchOperator - filterBranchType - filterBranches - filters - objectTypeId - operator type: object properties: associationCategory: type: string description: 関連付けのカテゴリーを定義します。 associationTypeId: type: integer description: 関連付けのタイプを表すID。 format: int32 filterBranchOperator: type: string description: 複数のフィルター分岐を結合するために使用される論理演算子を定義します。 filterBranchType: type: string description: フィルター分岐のタイプを示し、デフォルトではASSOCIATIONです。 default: ASSOCIATION enum: - ASSOCIATION filterBranches: type: array items: oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' filters: type: array items: oneOf: - $ref: '#/components/schemas/PublicPropertyFilter' - $ref: '#/components/schemas/PublicAssociationInListFilter' - $ref: '#/components/schemas/PublicPageViewAnalyticsFilter' - $ref: '#/components/schemas/PublicCtaAnalyticsFilter' - $ref: '#/components/schemas/PublicEventAnalyticsFilter' - $ref: '#/components/schemas/PublicFormSubmissionFilter' - $ref: '#/components/schemas/PublicFormSubmissionOnPageFilter' - $ref: '#/components/schemas/PublicIntegrationEventFilter' - $ref: '#/components/schemas/PublicEmailSubscriptionFilter' - $ref: '#/components/schemas/PublicCommunicationSubscriptionFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyFilter' - $ref: '#/components/schemas/PublicSurveyMonkeyValueFilter' - $ref: '#/components/schemas/PublicWebinarFilter' - $ref: '#/components/schemas/PublicEmailEventFilter' - $ref: '#/components/schemas/PublicPrivacyAnalyticsFilter' - $ref: '#/components/schemas/PublicAdsSearchFilter' - $ref: '#/components/schemas/PublicAdsTimeFilter' - $ref: '#/components/schemas/PublicInListFilter' - $ref: '#/components/schemas/PublicUnifiedEventsFilter' - $ref: '#/components/schemas/PublicConstantFilter' objectTypeId: type: string description: フィルター分岐と関連付けられたオブジェクトタイプのIDを表します。 operator: type: string description: 関連付けフィルターに適用される演算子を指定します。 x-hubspot-sub-type-impl: true ApiTimeWindow: required: - day type: object properties: day: type: string description: >- 時間枠の曜日を指定します。受け入れられる値：FRIDAY、MONDAY、SATURDAY、SUNDAY、THURSDAY、TUESDAY、WEDNESDAY。 enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY endTime: $ref: '#/components/schemas/ApiTimeOfDay' startTime: $ref: '#/components/schemas/ApiTimeOfDay' ApiUnEnrollmentSetting: required: - flowIds - type type: object properties: flowIds: type: array items: type: string type: type: string description: 登録解除設定のタイプを指定します。受け入れられる値はALLまたはSELECTIVEです。 enum: - ALL - SELECTIVE ApiConnection: required: - edgeType - nextActionId type: object properties: edgeType: type: string description: 自動化フローのアクション間の接続のタイプを指定します。 enum: - GOTO - STANDARD nextActionId: type: string description: 自動化シーケンスの後続のアクションのID。 ApiActionDataValue: title: FIELD_DATA required: - actionId - dataKey - type type: object properties: actionId: type: string description: データ値と関連付けられたアクションの固有ID。 dataKey: type: string description: アクション内の特定のデータ値を特定するために使用されるキー。 type: type: string description: データ値のタイプを示し、デフォルトではFIELD_DATAです。 default: FIELD_DATA enum: - FIELD_DATA x-hubspot-sub-type-impl: true ApiObjectPropertyValue: title: OBJECT_PROPERTY required: - propertyName - type type: object properties: propertyName: type: string description: オブジェクトで使用されるプロパティーの名前を指定します。 type: type: string description: オブジェクトプロパティーのタイプを示し、デフォルトではOBJECT_PROPERTYです。 default: OBJECT_PROPERTY enum: - OBJECT_PROPERTY x-hubspot-sub-type-impl: true ApiStaticValue: title: STATIC_VALUE required: - staticValue - type type: object properties: staticValue: type: string description: APIのコンテキスト内で使用される特定の静的な値。 type: type: string description: 値のタイプを示し、デフォルトではSTATIC_VALUEです。 default: STATIC_VALUE enum: - STATIC_VALUE x-hubspot-sub-type-impl: true ApiRelativeDateTimeValue: title: RELATIVE_DATETIME required: - timeDelay - type type: object properties: timeDelay: $ref: '#/components/schemas/ApiTimeDelay' type: type: string description: 値のタイプを示し、デフォルトではRELATIVE_DATETIMEです。 default: RELATIVE_DATETIME enum: - RELATIVE_DATETIME x-hubspot-sub-type-impl: true ApiTimestampValue: title: TIMESTAMP required: - timestampType - type type: object properties: timestampType: type: string description: タイムスタンプのタイプを指定します。受け入れられる値はEXECUTION_TIMEです。 enum: - EXECUTION_TIME type: type: string description: タイムスタンプ値のタイプを示し、デフォルトではTIMESTAMPです。 default: TIMESTAMP enum: - TIMESTAMP x-hubspot-sub-type-impl: true ApiIncrementValue: title: INCREMENT required: - incrementAmount - type type: object properties: incrementAmount: type: number description: 増分する金額を指定します。 type: type: string description: 増分値のタイプを示し、デフォルトではINCREMENTです。 default: INCREMENT enum: - INCREMENT x-hubspot-sub-type-impl: true ApiFetchedObjectPropertyValue: title: FETCHED_OBJECT_PROPERTY required: - propertyToken - type type: object properties: propertyToken: type: string description: 取得したオブジェクトの特定のプロパティーを識別するために使用されるトークン。 type: type: string description: 取得したオブジェクトプロパティーのタイプを示し、デフォルトではFETCHED_OBJECT_PROPERTYです。 default: FETCHED_OBJECT_PROPERTY enum: - FETCHED_OBJECT_PROPERTY x-hubspot-sub-type-impl: true ApiAppendObjectPropertyValue: title: APPEND_OBJECT_PROPERTY required: - appendPropertyName - type type: object properties: appendPropertyName: type: string description: 値の追加先となるプロパティーの名前。 type: type: string description: アクションのタイプを示し、デフォルトではAPPEND_OBJECT_PROPERTYです。 default: APPEND_OBJECT_PROPERTY enum: - APPEND_OBJECT_PROPERTY x-hubspot-sub-type-impl: true ApiStaticAppendValue: title: STATIC_APPEND_VALUE required: - staticAppendValue - type type: object properties: staticAppendValue: type: string description: 指定したプロパティーに追加される値。 type: type: string description: 追加アクションのタイプを示し、デフォルトではSTATIC_APPEND_VALUEです。 default: STATIC_APPEND_VALUE enum: - STATIC_APPEND_VALUE x-hubspot-sub-type-impl: true ApiEnrollmentEventPropertyValue: title: ENROLLMENT_EVENT_PROPERTY required: - enrollmentEventPropertyToken - type type: object properties: enrollmentEventPropertyToken: type: string description: 特定の登録イベントプロパティーを特定するために使用されるトークン。 type: type: string description: 登録イベントプロパティーのタイプを示し、デフォルトではENROLLMENT_EVENT_PROPERTYです。 default: ENROLLMENT_EVENT_PROPERTY enum: - ENROLLMENT_EVENT_PROPERTY x-hubspot-sub-type-impl: true ApiActionOutputObjectPropertyValue: title: ACTION_OUTPUT_OBJECT_PROPERTY required: - actionOutputPropertyToken - type type: object properties: actionOutputPropertyToken: type: string type: type: string default: ACTION_OUTPUT_OBJECT_PROPERTY enum: - ACTION_OUTPUT_OBJECT_PROPERTY x-hubspot-sub-type-impl: true ApiStaticBranch: required: - branchValue type: object properties: branchValue: type: string description: 静的な分岐と関連付けられた値を指定します。 connection: $ref: '#/components/schemas/ApiConnection' ApiListBranch: type: object properties: branchName: type: string description: 分岐の名前を指定します。 connection: $ref: '#/components/schemas/ApiConnection' filterBranch: description: 論理演算子と条件を使用して、分岐のフィルター条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicOrFilterBranch' - $ref: '#/components/schemas/PublicAndFilterBranch' - $ref: '#/components/schemas/PublicNotAllFilterBranch' - $ref: '#/components/schemas/PublicNotAnyFilterBranch' - $ref: '#/components/schemas/PublicRestrictedFilterBranch' - $ref: '#/components/schemas/PublicUnifiedEventsFilterBranch' - $ref: '#/components/schemas/PublicAssociationFilterBranch' ApiABTestBranch: required: - connection type: object properties: connection: $ref: '#/components/schemas/ApiConnection' percentage: type: integer format: int32 ApiInputVariable: required: - name - value type: object properties: name: type: string description: 入力変数の名前。 value: description: >- 入力変数と関連付けられた値で、アクションデータ、オブジェクトプロパティー、静的な値、相対的な日時、タイムスタンプ、増分値、取得したオブジェクトプロパティー、追加されたオブジェクトプロパティー、静的な追加された値、登録イベントプロパティーなど、さまざまなタイプを取り得ます。 oneOf: - $ref: '#/components/schemas/ApiActionDataValue' - $ref: '#/components/schemas/ApiObjectPropertyValue' - $ref: '#/components/schemas/ApiStaticValue' - $ref: '#/components/schemas/ApiRelativeDateTimeValue' - $ref: '#/components/schemas/ApiTimestampValue' - $ref: '#/components/schemas/ApiIncrementValue' - $ref: '#/components/schemas/ApiFetchedObjectPropertyValue' - $ref: '#/components/schemas/ApiAppendObjectPropertyValue' - $ref: '#/components/schemas/ApiStaticAppendValue' - $ref: '#/components/schemas/ApiEnrollmentEventPropertyValue' - $ref: '#/components/schemas/ApiActionOutputObjectPropertyValue' ApiEnumerationOutputField: title: ENUMERATION required: - name - options - type type: object properties: name: type: string description: 列挙出力フィールドの名前。 options: type: array items: type: string type: type: string description: フィールドのタイプが「ENUMERATION」であることを指定します。 default: ENUMERATION enum: - ENUMERATION x-hubspot-sub-type-impl: true ApiAuthKeyWebhookAuthSettings: title: AUTH_KEY required: - location - name - secretName - type type: object properties: location: type: string description: 認証キーがある場所を指定します。可能な値はHEADERまたはQUERY_PARAMです。 enum: - HEADER - QUERY_PARAM name: type: string description: 認証キーと関連付けられた名前。 secretName: type: string description: 認証に使用されるシークレットの名前。 type: type: string description: 認証のタイプを示し、デフォルトではAUTH_KEYです。 default: AUTH_KEY enum: - AUTH_KEY x-hubspot-sub-type-impl: true ApiSignatureWebhookAuthSettings: title: SIGNATURE required: - appId - type type: object properties: appId: type: integer description: このWebhookコールの認証に使用されているHubSpot appId format: int32 type: type: string description: 認証のタイプ：SIGNATURE default: SIGNATURE enum: - SIGNATURE x-hubspot-sub-type-impl: true ApiSort: required: - order - property type: object properties: missing: type: string description: プロパティーが欠落している場合に並べ替えを処理する方法を指定します。 order: type: string description: 表示順。受け入れられる値は、昇順の場合はASC、降順の場合はDESC。 enum: - ASC - DESC property: type: string description: 並べ替えの基準にするプロパティーの名前。 ApiTimeOfDay: required: - hour - minute type: object properties: hour: type: integer description: 整数で表される、時間の時間コンポーネント。 format: int32 minute: type: integer description: 整数で表される、時間の分コンポーネント。 format: int32 PublicPropertyFilter: title: PROPERTY required: - filterType - operation - property type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではPROPERTYです。 default: PROPERTY enum: - PROPERTY operation: description: プロパティーで実行される操作を定義します。ブール値、数値、文字列、日時、その他など、さまざまなタイプを含めることができます。 oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' property: type: string description: 絞り込むプロパティーの名前を指定します。 x-hubspot-sub-type-impl: true PublicAssociationInListFilter: title: ASSOCIATION required: - associationCategory - associationTypeId - coalescingRefineBy - filterType - listId - operator type: object properties: associationCategory: type: string description: 関連付けのカテゴリーを定義します。 associationTypeId: type: integer description: 関連付けのタイプを表すID。 format: int32 coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、関連付けをブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: フィルターのタイプを示し、デフォルトではASSOCIATIONです。 default: ASSOCIATION enum: - ASSOCIATION listId: type: string description: 関連付けフィルターで使用されるリストのID。 operator: type: string description: 関連付けフィルターで使用される演算子を指定します。 toObjectType: type: string description: 関連付けを行うオブジェクトのタイプを指定します。 toObjectTypeId: type: string description: フィルターと関連付けられたオブジェクトタイプのIDを表します。 x-hubspot-sub-type-impl: true PublicPageViewAnalyticsFilter: title: PAGE_VIEW required: - filterType - operator - pageUrl type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、ページ ビュー アナリティクスをブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' enableTracking: type: boolean description: ページ ビュー アナリティクス フィルターでトラッキングが有効になっているかどうかを判定します。 filterType: type: string description: フィルターのタイプを示し、デフォルトではPAGE_VIEWです。 default: PAGE_VIEW enum: - PAGE_VIEW operator: type: string description: ページ ビュー アナリティクス フィルターで使用される演算子を指定します。 pageUrl: type: string description: ページ ビュー アナリティクス フィルターで使用されるページのURL。 pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、ページ ビュー アナリティクスを枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicCtaAnalyticsFilter: title: CTA required: - ctaName - filterType - operator type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、CTAアナリティクスをブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' ctaName: type: string description: アナリティクスフィルターで使用されるCTAの名前。 filterType: type: string description: フィルターのタイプを示し、デフォルトではCTAです。 default: CTA enum: - CTA operator: type: string description: CTAアナリティクスフィルターで使用される演算子を指定します。 pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、CTAアナリティクスを枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicEventAnalyticsFilter: title: EVENT required: - eventId - filterType - operator type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、イベントをブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventId: type: string description: イベント アナリティクス フィルターで使用されるイベントのID。 filterType: type: string description: フィルターのタイプを示し、デフォルトではEVENTです。 default: EVENT enum: - EVENT operator: type: string description: イベント アナリティクス フィルターで使用される演算子を指定します。 pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、イベントを枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionFilter: title: FORM_SUBMISSION required: - filterType - operator type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、フォーム送信をブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: フィルターのタイプを示し、デフォルトではFORM_SUBMISSIONです。 default: FORM_SUBMISSION enum: - FORM_SUBMISSION formId: type: string description: フォーム送信フィルターで使用されるフォームの固有ID。 operator: type: string description: フォーム送信フィルターで使用される演算子を指定します。受け入れられる値は、FILLED_OUTまたはNOT_FILLED_OUTです。 enum: - FILLED_OUT - NOT_FILLED_OUT pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、フォーム送信を枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicFormSubmissionOnPageFilter: title: FORM_SUBMISSION_ON_PAGE required: - filterType - operator - pageId type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、フォーム送信をブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' filterType: type: string description: フィルターのタイプを示し、デフォルトではFORM_SUBMISSION_ON_PAGEです。 default: FORM_SUBMISSION_ON_PAGE enum: - FORM_SUBMISSION_ON_PAGE formId: type: string description: ページフィルターのフォーム送信で使用されるフォームの固有ID。 operator: type: string description: >- ページフィルターのフォーム送信で使用される演算子を指定します。受け入れられる値は、FILLED_OUTまたはNOT_FILLED_OUTです。 enum: - FILLED_OUT - NOT_FILLED_OUT pageId: type: string description: ページフィルターのフォーム送信で使用されるページのID。 pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、フォーム送信を枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicIntegrationEventFilter: title: INTEGRATION_EVENT required: - eventTypeId - filterLines - filterType type: object properties: eventTypeId: type: integer description: 連携イベントフィルターと関連付けられたイベントのタイプのID。 format: int32 filterLines: type: array items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: フィルターのタイプを示し、デフォルトではINTEGRATION_EVENTです。 default: INTEGRATION_EVENT enum: - INTEGRATION_EVENT x-hubspot-sub-type-impl: true PublicEmailSubscriptionFilter: title: EMAIL_SUBSCRIPTION required: - acceptedStatuses - filterType - subscriptionIds type: object properties: acceptedStatuses: type: array items: type: string filterType: type: string description: フィルターのタイプを示し、デフォルトではEMAIL_SUBSCRIPTIONです。 default: EMAIL_SUBSCRIPTION enum: - EMAIL_SUBSCRIPTION subscriptionIds: type: array items: type: string subscriptionType: type: string description: Eメール配信登録フィルターと関連付けられた配信登録のタイプを指定します。 x-hubspot-sub-type-impl: true PublicCommunicationSubscriptionFilter: title: COMMUNICATION_SUBSCRIPTION required: - acceptedOptStates - channel - filterType - subscriptionIds - subscriptionType type: object properties: acceptedOptStates: type: array items: type: string businessUnitId: type: string description: 配信登録フィルターと関連付けられたビジネスユニットを示します。 channel: type: string description: 配信登録フィルターと関連付けられたコミュニケーションチャネルを指定します。 filterType: type: string description: フィルターのタイプを示し、デフォルトではCOMMUNICATION_SUBSCRIPTIONです。 default: COMMUNICATION_SUBSCRIPTION enum: - COMMUNICATION_SUBSCRIPTION subscriptionIds: type: array items: type: string subscriptionType: type: string description: フィルターに関連付けられた配信登録のタイプを定義します。 x-hubspot-sub-type-impl: true PublicSurveyMonkeyFilter: title: SURVEY_MONKEY required: - filterType - operator - surveyId type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではSURVEY_MONKEYです。 default: SURVEY_MONKEY enum: - SURVEY_MONKEY operator: type: string description: フィルターで使用される演算子を指定します。 surveyId: type: string description: アンケートのID。 x-hubspot-sub-type-impl: true PublicSurveyMonkeyValueFilter: title: SURVEY_MONKEY_VALUE required: - filterType - operator - surveyId - surveyQuestion - valueComparison type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではSURVEY_MONKEY_VALUEです。 default: SURVEY_MONKEY_VALUE enum: - SURVEY_MONKEY_VALUE operator: type: string description: フィルターで使用される演算子を指定します。 surveyAnswerColId: type: string description: アンケート回答の列のID。 surveyAnswerRowId: type: string description: アンケート回答の行のID。 surveyId: type: string description: アンケートのID。 surveyQuestion: type: string description: アンケート質問のテキスト。 valueComparison: description: アンケート回答値を比較する条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicWebinarFilter: title: WEBINAR required: - filterType - operator type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではWEBINARです。 default: WEBINAR enum: - WEBINAR operator: type: string description: ウェビナーフィルターで使用される演算子を指定します。 webinarId: type: string description: フィルターで使用されるウェビナーのID。 x-hubspot-sub-type-impl: true PublicEmailEventFilter: title: EMAIL_EVENT required: - appId - emailId - filterType - level - operator type: object properties: appId: type: string description: Eメールイベントと関連付けられたアプリケーションのID。 clickUrl: type: string description: EメールイベントでクリックされたURL。 emailId: type: string description: イベントと関連付けられたEメールのID。 filterType: type: string description: フィルターのタイプを示し、デフォルトではEMAIL_EVENTです。 default: EMAIL_EVENT enum: - EMAIL_EVENT level: type: string description: Eメール イベント フィルターのレベルを指定します。 operator: type: string description: >- Eメール イベント フィルターでで使用される演算子を指定します。受け入れられる値は、BOUNCED, LINK_CLICKED、MARKED_SPAM、OPENED, OPENED_BUT_LINK_NOT_CLICKED、OPENED_BUT_NOT_REPLIED、RECEIVED、RECEIVED_BUT_NOT_OPENED、REPLIED、SENT、SENT_BUT_LINK_NOT_CLICKED、SENT_BUT_NOT_RECEIVED、UNSUBSCRIBEDです。 enum: - BOUNCED - LINK_CLICKED - MARKED_SPAM - OPENED - OPENED_BUT_LINK_NOT_CLICKED - OPENED_BUT_NOT_REPLIED - RECEIVED - RECEIVED_BUT_NOT_OPENED - REPLIED - SENT - SENT_BUT_LINK_NOT_CLICKED - SENT_BUT_NOT_RECEIVED - UNSUBSCRIBED pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、Eメールイベントをブラッシュアップする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicPrivacyAnalyticsFilter: title: PRIVACY required: - filterType - operator - privacyName type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではPRIVACYです。 default: PRIVACY enum: - PRIVACY operator: type: string description: プライバシー アナリティクス フィルターで使用される演算子を指定します。 privacyName: type: string description: プライバシー アナリティクス フィルターと関連付けられた名前。 x-hubspot-sub-type-impl: true PublicAdsSearchFilter: title: ADS_SEARCH required: - adNetwork - entityType - filterType - operator - searchTermType - searchTerms type: object properties: adNetwork: type: string description: 広告検索フィルターと関連付けられた広告ネットワークを指定します。 entityType: type: string description: 広告検索フィルターで使用されるエンティティーのタイプを指定します。 filterType: type: string description: フィルターのタイプを示し、デフォルトではADS_SEARCHです。 default: ADS_SEARCH enum: - ADS_SEARCH operator: type: string description: 広告検索フィルターで使用される演算子を定義します。 searchTermType: type: string description: 広告検索フィルターで使用される検索語句のタイプを示します。 searchTerms: type: array items: type: string x-hubspot-sub-type-impl: true PublicAdsTimeFilter: title: ADS_TIME required: - filterType - pruningRefineBy type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではADS_TIMEです。 default: ADS_TIME enum: - ADS_TIME pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、広告時間データを枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicInListFilter: title: IN_LIST required: - filterType - listId - operator type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではIN_LISTです。 default: IN_LIST enum: - IN_LIST listId: type: string description: リスト内フィルターで使用されるリストのID。 metadata: $ref: '#/components/schemas/PublicInListFilterMetadata' operator: type: string description: リスト内フィルターで使用される演算子を指定します。 x-hubspot-sub-type-impl: true PublicUnifiedEventsFilter: title: UNIFIED_EVENTS required: - filterLines - filterType type: object properties: coalescingRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeComparativeTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、イベントをブラッシュアップする条件を定義します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' eventTypeId: type: string description: 統合イベントのフィルターと関連付けられたイベントのタイプのID。 filterLines: type: array items: $ref: '#/components/schemas/PublicEventFilterMetadata' filterType: type: string description: フィルターのタイプを示し、デフォルトではUNIFIED_EVENTSです。 default: UNIFIED_EVENTS enum: - UNIFIED_EVENTS pruningRefineBy: description: >- PublicNumOccurrencesRefineByやPublicRelativeRangedTimestampRefineByなど、使用可能ないくつかのスキーマのいずれかを使用して、イベントを枝刈りする条件を指定します。 oneOf: - $ref: '#/components/schemas/PublicNumOccurrencesRefineBy' - $ref: '#/components/schemas/PublicSetOccurrencesRefineBy' - $ref: '#/components/schemas/PublicRelativeComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicRelativeRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteComparativeTimestampRefineBy' - $ref: '#/components/schemas/PublicAbsoluteRangedTimestampRefineBy' - $ref: '#/components/schemas/PublicAllHistoryRefineBy' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' x-hubspot-sub-type-impl: true PublicConstantFilter: title: CONSTANT required: - filterType - shouldAccept type: object properties: filterType: type: string description: フィルターのタイプを示し、デフォルトではCONSTANTです。 default: CONSTANT enum: - CONSTANT shouldAccept: type: boolean description: フィルターが指定した条件を受け入れるかどうかを判定します。 source: type: string description: フィルターのソースを指定します。 x-hubspot-sub-type-impl: true PublicNumOccurrencesRefineBy: title: NUM_OCCURRENCES required: - type type: object properties: maxOccurrences: type: integer description: 許可される発生の最大数を指定します。 format: int32 minOccurrences: type: integer description: 必要な発生の最小数を指定します。 format: int32 type: type: string description: ブラッシュアップのタイプを示し、デフォルトではNUM_OCCURRENCESです。 default: NUM_OCCURRENCES enum: - NUM_OCCURRENCES x-hubspot-sub-type-impl: true PublicSetOccurrencesRefineBy: title: SET_OCCURRENCES required: - setType - type type: object properties: setType: type: string description: 発生のブラッシュアップで使用される設定済みタイプを定義します。 type: type: string description: ブラッシュアップのタイプを指定し、デフォルトではSET_OCCURRENCESです。 default: SET_OCCURRENCES enum: - SET_OCCURRENCES x-hubspot-sub-type-impl: true PublicRelativeComparativeTimestampRefineBy: title: RELATIVE_COMPARATIVE required: - comparison - timeOffset - type type: object properties: comparison: type: string description: 相対比較タイムスタンプのブラッシュアップで使用される比較操作を定義します。 timeOffset: $ref: '#/components/schemas/PublicTimeOffset' type: type: string description: ブラッシュアップのタイプを指定し、デフォルトではRELATIVE_COMPARATIVEです。 default: RELATIVE_COMPARATIVE enum: - RELATIVE_COMPARATIVE x-hubspot-sub-type-impl: true PublicRelativeRangedTimestampRefineBy: title: RELATIVE_RANGED required: - lowerBoundOffset - rangeType - type - upperBoundOffset type: object properties: lowerBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' rangeType: type: string description: タイムスタンプのブラッシュアップで使用される範囲のタイプを指定します。 type: type: string description: タイムスタンプのブラッシュアップのタイプを示し、デフォルトではRELATIVE_RANGEDです。 default: RELATIVE_RANGED enum: - RELATIVE_RANGED upperBoundOffset: $ref: '#/components/schemas/PublicTimeOffset' x-hubspot-sub-type-impl: true PublicAbsoluteComparativeTimestampRefineBy: title: ABSOLUTE_COMPARATIVE required: - comparison - timestamp - type type: object properties: comparison: type: string description: 絶対比較タイムスタンプのブラッシュアップで使用される比較操作を定義します。 timestamp: type: integer description: 整数で表される、絶対比較のブラッシュアップに使用されるタイムスタンプを指定します。 format: int64 type: type: string description: ブラッシュアップのタイプを示し、デフォルトではABSOLUTE_COMPARATIVEです。 default: ABSOLUTE_COMPARATIVE enum: - ABSOLUTE_COMPARATIVE x-hubspot-sub-type-impl: true PublicAbsoluteRangedTimestampRefineBy: title: ABSOLUTE_RANGED required: - lowerTimestamp - rangeType - type - upperTimestamp type: object properties: lowerTimestamp: type: integer description: タイムスタンプ範囲の下限を指定します。 format: int64 rangeType: type: string description: タイムスタンプのブラッシュアップで使用される範囲のタイプを指定します。 type: type: string description: タイムスタンプのブラッシュアップのタイプを示し、デフォルトではABSOLUTE_RANGEDです。 default: ABSOLUTE_RANGED enum: - ABSOLUTE_RANGED upperTimestamp: type: integer description: タイムスタンプ範囲の上限を指定します。 format: int64 x-hubspot-sub-type-impl: true PublicAllHistoryRefineBy: title: ALL_HISTORY required: - type type: object properties: type: type: string description: ブラッシュアップのタイプを指定し、デフォルトではALL_HISTORYです。 default: ALL_HISTORY enum: - ALL_HISTORY x-hubspot-sub-type-impl: true PublicTimePointOperation: title: TIME_POINT required: - includeObjectsWithNoValueSet - operationType - operator - timePoint - type type: object properties: endpointBehavior: type: string description: 操作に関するエンドポイントの動作を説明します。 includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを操作に含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「TIME_POINT」です。 default: TIME_POINT enum: - TIME_POINT operator: type: string description: 時点操作で使用される演算子を定義します。 propertyParser: type: string description: 操作のプロパティー値の解釈に使用されるパーサーを定義します。 timePoint: description: 操作で使用される時点を指定します。日付、インデックス付けされた時間、またはプロパティーで参照される時間を指定できます。 oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' type: type: string description: 操作の特定のタイプを示します。 x-hubspot-sub-type-impl: true PublicRangedTimeOperation: title: TIME_RANGED required: - includeObjectsWithNoValueSet - lowerBoundTimePoint - operationType - operator - type - upperBoundTimePoint type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを操作に含めるかどうかを判定します。 lowerBoundEndpointBehavior: type: string description: 時間範囲の下限エンドポイントでの動作を示します。 lowerBoundTimePoint: description: 時間範囲の下限を定義します。 oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' operationType: type: string description: 操作のタイプを指定します（TIME_RANGED）。 operator: type: string description: 時間範囲操作で使用される演算子を定義します。 propertyParser: type: string description: 操作のプロパティーに使用されるパーサーを指定します。 type: type: string description: 操作のタイプを指定し、デフォルトでは「TIME_RANGED」です。 default: TIME_RANGED enum: - TIME_RANGED upperBoundEndpointBehavior: type: string description: 時間範囲の上限エンドポイントでの動作を示します。 upperBoundTimePoint: description: 時間範囲の上限を定義します。 oneOf: - $ref: '#/components/schemas/PublicDatePoint' - $ref: '#/components/schemas/PublicIndexedTimePoint' - $ref: '#/components/schemas/PublicPropertyReferencedTime' x-hubspot-sub-type-impl: true ApiTimeDelay: required: - daysOfWeek - delta - timeUnit type: object properties: daysOfWeek: type: array items: type: string enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY delta: type: integer description: 整数で指定される、遅延する時間。 format: int32 timeOfDay: $ref: '#/components/schemas/ApiTimeOfDay' timeUnit: type: string description: >- 遅延の時間の単位を定義します。受け入れられる値：CENTURIES、DAYS、DECADES、ERAS、FOREVER、HALF_DAYS、HOURS、MICROS、MILLENNIA、MILLIS、MINUTES、MONTHS、NANOS、SECONDS、WEEKS、YEARS。 enum: - CENTURIES - DAYS - DECADES - ERAS - FOREVER - HALF_DAYS - HOURS - MICROS - MILLENNIA - MILLIS - MINUTES - MONTHS - NANOS - SECONDS - WEEKS - YEARS timeZoneStrategy: description: 遅延のタイムゾーンを判定する戦略を指定します。 oneOf: - $ref: '#/components/schemas/ApiStaticTimeZoneStrategy' PublicBoolPropertyOperation: title: BOOL required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「BOOL」です。 default: BOOL enum: - BOOL operator: type: string description: ブール値プロパティー操作で使用される演算子を定義します。 value: type: boolean description: 操作で使用されるブール値。 x-hubspot-sub-type-impl: true PublicNumberPropertyOperation: title: NUMBER required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「NUMBER」です。 default: NUMBER enum: - NUMBER operator: type: string description: 数値プロパティー操作で使用される演算子を定義します。 value: type: number description: 操作で使用される数値。 x-hubspot-sub-type-impl: true PublicStringPropertyOperation: title: STRING required: - includeObjectsWithNoValueSet - operationType - operator - value type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「STRING」です。 default: STRING enum: - STRING operator: type: string description: 文字列プロパティー操作で使用される演算子を定義します。 value: type: string description: 操作で使用される文字列値。 x-hubspot-sub-type-impl: true PublicDateTimePropertyOperation: title: DATETIME required: - includeObjectsWithNoValueSet - operationType - operator - requiresTimeZoneConversion - timestamp type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを操作に含めるかどうかを判定します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「DATETIME」です。 default: DATETIME enum: - DATETIME operator: type: string description: 日時プロパティー操作で使用される演算子を定義します。 requiresTimeZoneConversion: type: boolean description: 操作にタイムゾーン変換が必要かどうかを示します。 timestamp: type: integer description: 日時プロパティー操作で使用されるタイムスタンプを指定します。 format: int64 x-hubspot-sub-type-impl: true PublicRangedDatePropertyOperation: title: RANGED_DATE required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - requiresTimeZoneConversion - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを判定します。 lowerBound: type: integer description: 日付範囲の下限を指定します。 format: int64 operationType: type: string description: 操作のタイプを指定します（RANGED_DATE）。 default: RANGED_DATE enum: - RANGED_DATE operator: type: string description: 日付範囲操作で使用される演算子を定義します。 requiresTimeZoneConversion: type: boolean description: タイムゾーン変換が必要かどうかを示します。 upperBound: type: integer description: 日付範囲の上限を指定します。 format: int64 x-hubspot-sub-type-impl: true PublicComparativePropertyUpdatedOperation: title: COMPARATIVE_PROPERTY_UPDATED required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: 操作で比較に使用されるプロパティーの名前。 defaultComparisonValue: type: string description: プロパティー値が設定されていない場合に比較に使用されるデフォルト値を指定します。 includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「COMPARATIVE_PROPERTY_UPDATED」です。 default: COMPARATIVE_PROPERTY_UPDATED enum: - COMPARATIVE_PROPERTY_UPDATED operator: type: string description: 比較プロパティー更新操作で使用される演算子を定義します。 x-hubspot-sub-type-impl: true PublicComparativeDatePropertyOperation: title: COMPARATIVE_DATE required: - comparisonPropertyName - includeObjectsWithNoValueSet - operationType - operator type: object properties: comparisonPropertyName: type: string description: 操作で比較に使用されるプロパティーの名前。 defaultComparisonValue: type: string description: 操作で比較に使用されるデフォルト値。 includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを操作に含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「COMPARATIVE_DATE」です。 default: COMPARATIVE_DATE enum: - COMPARATIVE_DATE operator: type: string description: 比較日付プロパティー操作で使用される演算子を定義します。 x-hubspot-sub-type-impl: true PublicRollingDateRangePropertyOperation: title: ROLLING_DATE_RANGE required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator - requiresTimeZoneConversion type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを判定します。 numberOfDays: type: integer description: 移動日付範囲の日数を示します。 format: int32 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「ROLLING_DATE_RANGE」です。 default: ROLLING_DATE_RANGE enum: - ROLLING_DATE_RANGE operator: type: string description: 移動日付範囲操作で使用される演算子を定義します。 requiresTimeZoneConversion: type: boolean description: タイムゾーン変換が必要かどうかを示します。 x-hubspot-sub-type-impl: true PublicRollingPropertyUpdatedOperation: title: ROLLING_PROPERTY_UPDATED required: - includeObjectsWithNoValueSet - numberOfDays - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean numberOfDays: type: integer format: int32 operationType: type: string default: ROLLING_PROPERTY_UPDATED enum: - ROLLING_PROPERTY_UPDATED operator: type: string x-hubspot-sub-type-impl: true PublicEnumerationPropertyOperation: title: ENUMERATION required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「ENUMERATION」です。 default: ENUMERATION enum: - ENUMERATION operator: type: string description: 列挙プロパティー操作で使用される演算子を定義します。 values: type: array items: type: string x-hubspot-sub-type-impl: true PublicAllPropertyTypesOperation: title: ALL_PROPERTY required: - includeObjectsWithNoValueSet - operationType - operator type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「ALL_PROPERTY」です。 default: ALL_PROPERTY enum: - ALL_PROPERTY operator: type: string description: 全てのプロパティータイプ操作で使用される演算子を定義します。 x-hubspot-sub-type-impl: true PublicRangedNumberPropertyOperation: title: NUMBER_RANGED required: - includeObjectsWithNoValueSet - lowerBound - operationType - operator - upperBound type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 lowerBound: type: integer description: 数値範囲の下限を指定します。 format: int64 operationType: type: string description: 操作のタイプを指定します（「NUMBER_RANGED」）。 default: NUMBER_RANGED enum: - NUMBER_RANGED operator: type: string description: 範囲設定された数値プロパティー操作で使用される演算子を定義します。 upperBound: type: integer description: 数値範囲の上限を指定します。 format: int64 x-hubspot-sub-type-impl: true PublicMultiStringPropertyOperation: title: MULTISTRING required: - includeObjectsWithNoValueSet - operationType - operator - values type: object properties: includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「MULTISTRING」です。 default: MULTISTRING enum: - MULTISTRING operator: type: string description: 複数文字列プロパティー操作で使用される演算子を定義します。 values: type: array items: type: string x-hubspot-sub-type-impl: true PublicDatePropertyOperation: title: DATE required: - day - includeObjectsWithNoValueSet - month - operationType - operator - year type: object properties: day: type: integer description: 日付操作の日コンポーネント。 format: int32 includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 month: type: string description: 日付操作の月コンポーネント。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「DATE」です。 default: DATE enum: - DATE operator: type: string description: 日付プロパティー操作で使用される演算子を定義します。 year: type: integer description: 日付操作の年コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicCalendarDatePropertyOperation: title: CALENDAR_DATE required: - includeObjectsWithNoValueSet - operationType - operator - timeUnit type: object properties: fiscalYearStart: type: string description: >- 会計年度の開始月を定義します。受け入れられる値：APRIL、AUGUST、DECEMBER、FEBRUARY、JANUARY、JULY、JUNE、MARCH、MAY、NOVEMBER、OCTOBER、SEPTEMBER。 enum: - APRIL - AUGUST - DECEMBER - FEBRUARY - JANUARY - JULY - JUNE - MARCH - MAY - NOVEMBER - OCTOBER - SEPTEMBER includeObjectsWithNoValueSet: type: boolean description: 値が設定されていないオブジェクトを含めるかどうかを示します。 operationType: type: string description: 操作のタイプを指定し、デフォルトでは「CALENDAR_DATE」です。 default: CALENDAR_DATE enum: - CALENDAR_DATE operator: type: string description: カレンダー日付プロパティー操作で使用される演算子を定義します。 timeUnit: type: string description: 操作で使用される時間の単位を指定します。 timeUnitCount: type: integer description: 操作で使用される時間単位数を示します。 format: int32 useFiscalYear: type: boolean description: 操作で会計年度が使用されるかどうかを判定します。 x-hubspot-sub-type-impl: true PublicEventFilterMetadata: required: - operation - property type: object properties: operation: oneOf: - $ref: '#/components/schemas/PublicBoolPropertyOperation' - $ref: '#/components/schemas/PublicNumberPropertyOperation' - $ref: '#/components/schemas/PublicStringPropertyOperation' - $ref: '#/components/schemas/PublicDateTimePropertyOperation' - $ref: '#/components/schemas/PublicRangedDatePropertyOperation' - $ref: '#/components/schemas/PublicComparativePropertyUpdatedOperation' - $ref: '#/components/schemas/PublicComparativeDatePropertyOperation' - $ref: '#/components/schemas/PublicRollingDateRangePropertyOperation' - $ref: '#/components/schemas/PublicRollingPropertyUpdatedOperation' - $ref: '#/components/schemas/PublicEnumerationPropertyOperation' - $ref: '#/components/schemas/PublicAllPropertyTypesOperation' - $ref: '#/components/schemas/PublicRangedNumberPropertyOperation' - $ref: '#/components/schemas/PublicMultiStringPropertyOperation' - $ref: '#/components/schemas/PublicDatePropertyOperation' - $ref: '#/components/schemas/PublicCalendarDatePropertyOperation' - $ref: '#/components/schemas/PublicTimePointOperation' - $ref: '#/components/schemas/PublicRangedTimeOperation' property: type: string PublicInListFilterMetadata: required: - id - inListType type: object properties: id: type: string description: フィルターメタデータの固有ID。 inListType: type: string description: フィルターと関連付けられたリストのタイプを指定します。 PublicTimeOffset: required: - amount - offsetDirection - timeUnit type: object properties: amount: type: integer format: int64 offsetDirection: type: string timeUnit: type: string PublicDatePoint: title: DATE required: - day - month - timeType - year - zoneId type: object properties: day: type: integer format: int32 hour: type: integer format: int32 millisecond: type: integer format: int32 minute: type: integer format: int32 month: type: integer format: int32 second: type: integer format: int32 timeType: type: string default: DATE enum: - DATE timezoneSource: type: string year: type: integer format: int32 zoneId: type: string x-hubspot-sub-type-impl: true PublicIndexedTimePoint: title: INDEXED required: - indexReference - timeType - zoneId type: object properties: indexReference: description: >- インデックスの基準点を指定します。これは、NOW、TODAY、または特定の会計年度期間など、あらかじめ定義されたいくつかの時間基準のいずれかにできます。 oneOf: - $ref: '#/components/schemas/PublicNowReference' - $ref: '#/components/schemas/PublicTodayReference' - $ref: '#/components/schemas/PublicWeekReference' - $ref: '#/components/schemas/PublicFiscalQuarterReference' - $ref: '#/components/schemas/PublicFiscalYearReference' - $ref: '#/components/schemas/PublicYearReference' - $ref: '#/components/schemas/PublicQuarterReference' - $ref: '#/components/schemas/PublicMonthReference' offset: $ref: '#/components/schemas/PublicIndexOffset' timeType: type: string description: 時点のタイプを示し、デフォルトではINDEXEDです。 default: INDEXED enum: - INDEXED timezoneSource: type: string description: インデックス付けされた時点のタイムゾーン情報のソースを指定します。 zoneId: type: string description: インデックス付けされた時点に使用されるタイムゾーンIDを定義します。 x-hubspot-sub-type-impl: true PublicPropertyReferencedTime: title: PROPERTY_REFERENCED required: - property - referenceType - timeType - zoneId type: object properties: property: type: string description: 参照するプロパティーの名前を指定します。 referenceType: type: string description: プロパティーに使用される基準のタイプを示します。 timeType: type: string description: 時刻基準のタイプを示し、デフォルトでは「PROPERTY_REFERENCED」です。 default: PROPERTY_REFERENCED enum: - PROPERTY_REFERENCED timezoneSource: type: string description: プロパティーを基準とした時刻におけるタイムゾーン情報のソースを指定します。 zoneId: type: string description: プロパティーを基準とした時刻におけるタイムゾーンIDを定義します。 x-hubspot-sub-type-impl: true ApiStaticTimeZoneStrategy: title: STATIC_TIME_ZONE required: - timeZoneId - type type: object properties: timeZoneId: type: string description: タイムゾーンのID。 type: type: string description: タイムゾーン戦略のタイプを指定し、デフォルトではSTATIC_TIME_ZONEです。 default: STATIC_TIME_ZONE enum: - STATIC_TIME_ZONE x-hubspot-sub-type-impl: true PublicNowReference: title: NOW required: - referenceType type: object properties: hour: type: integer description: 現在時刻を基準とした時間コンポーネント。 format: int32 millisecond: type: integer description: 現在時刻を基準としたミリ秒コンポーネント。 format: int32 minute: type: integer description: 現在時刻を基準とした分コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「NOW」です。 default: NOW enum: - NOW second: type: integer description: 現在時刻を基準とした秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicTodayReference: title: TODAY required: - referenceType type: object properties: hour: type: integer description: 今日を基準とした時刻における時間コンポーネント。 format: int32 millisecond: type: integer description: 今日を基準とした時刻におけるミリ秒コンポーネント。 format: int32 minute: type: integer description: 今日を基準とした時刻における分コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「TODAY」です。 default: TODAY enum: - TODAY second: type: integer description: 今日を基準とした時刻における秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicWeekReference: title: WEEK required: - dayOfWeek - referenceType type: object properties: dayOfWeek: type: string description: >- 週を基準とした曜日。受け入れられる値：MONDAY、TUESDAY、WEDNESDAY、THURSDAY、FRIDAY、SATURDAY、SUNDAY。 enum: - FRIDAY - MONDAY - SATURDAY - SUNDAY - THURSDAY - TUESDAY - WEDNESDAY hour: type: integer description: 週を基準とした時刻における時間コンポーネント。 format: int32 millisecond: type: integer description: 週を基準とした時刻におけるミリ秒コンポーネント。 format: int32 minute: type: integer description: 週を基準とした時刻における分コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「WEEK」です。 default: WEEK enum: - WEEK second: type: integer description: 週を基準とした時刻における秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicFiscalQuarterReference: title: FISCAL_QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: 整数で表される、会計四半期を基準とした日コンポーネント。 format: int32 hour: type: integer description: 会計四半期を基準とした時刻における時間コンポーネント。 format: int32 millisecond: type: integer description: 会計四半期を基準とした時間のミリ秒コンポーネント。 format: int32 minute: type: integer description: 会計四半期を基準とした時間の分コンポーネント。 format: int32 month: type: integer description: 整数で表される、会計四半期を基準とした月コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「FISCAL_QUARTER」です。 default: FISCAL_QUARTER enum: - FISCAL_QUARTER second: type: integer description: 会計四半期を基準とした時間の秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicFiscalYearReference: title: FISCAL_YEAR required: - day - month - referenceType type: object properties: day: type: integer description: 整数で表される、会計年度を基準とした日コンポーネント。 format: int32 hour: type: integer description: 会計年度を基準とした時間の時間コンポーネント。 format: int32 millisecond: type: integer description: 会計年度を基準とした時間のミリ秒コンポーネント。 format: int32 minute: type: integer description: 会計年度を基準とした時刻における分コンポーネント。 format: int32 month: type: integer description: 整数で表される、会計年度を基準とした月コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「FISCAL_YEAR」です。 default: FISCAL_YEAR enum: - FISCAL_YEAR second: type: integer description: 会計年度を基準とした時刻における秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicYearReference: title: YEAR required: - day - month - referenceType type: object properties: day: type: integer description: 整数で表される、年を基準とした日コンポーネント。 format: int32 hour: type: integer description: 年を基準とした時刻における時間コンポーネント。 format: int32 millisecond: type: integer description: 年を基準とした時刻におけるミリ秒コンポーネント。 format: int32 minute: type: integer description: 年を基準とした時刻における分コンポーネント。 format: int32 month: type: integer description: 整数で表される、年を基準とした月コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「YEAR」です。 default: YEAR enum: - YEAR second: type: integer description: 年を基準とした時刻における秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicQuarterReference: title: QUARTER required: - day - month - referenceType type: object properties: day: type: integer description: 四半期を基準とした日コンポーネント。 format: int32 hour: type: integer description: 四半期を基準とした時刻における時間コンポーネント。 format: int32 millisecond: type: integer description: 四半期を基準とした時刻におけるミリ秒コンポーネント。 format: int32 minute: type: integer description: 四半期を基準とした時刻における分コンポーネント。 format: int32 month: type: integer description: 四半期を基準とした月コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「QUARTER」です。 default: QUARTER enum: - QUARTER second: type: integer description: 四半期を基準とした時刻における秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicMonthReference: title: MONTH required: - day - referenceType type: object properties: day: type: integer description: 整数で表される、月を基準とした日コンポーネント。 format: int32 hour: type: integer description: 月を基準とした時刻における時間コンポーネント。 format: int32 millisecond: type: integer description: 月を基準とした時刻におけるミリ秒コンポーネント。 format: int32 minute: type: integer description: 月を基準とした時刻における分コンポーネント。 format: int32 referenceType: type: string description: 基準のタイプを示し、デフォルトでは「MONTH」です。 default: MONTH enum: - MONTH second: type: integer description: 月を基準とした時刻における秒コンポーネント。 format: int32 x-hubspot-sub-type-impl: true PublicIndexOffset: type: object properties: days: type: integer description: インデックスでオフセットする日数。 format: int32 hours: type: integer description: インデックスでオフセットする時間数。 format: int32 milliseconds: type: integer description: インデックスでオフセットするミリ秒数。 format: int32 minutes: type: integer description: インデックスでオフセットする分数。 format: int32 months: type: integer description: インデックスでオフセットする月数。 format: int32 quarters: type: integer description: インデックスでオフセットする四半期数。 format: int32 seconds: type: integer description: インデックスでオフセットする秒数。 format: int32 weeks: type: integer description: インデックスでオフセットする週数。 format: int32 years: type: integer description: インデックスでオフセットする年数。 format: int32 responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: automation: '' ````