为自助源配置源规范(批处理SDK)

源规范包含特定于源的信息,包括与源的类别、测试版状态和目录图标相关的属性。 它们还包含有用的信息,如URL参数、内容、标题和计划。 源规范还描述了从基本连接创建源连接所需的参数的模式。 要创建源连接,必须使用架构。

请参阅 附录 例如,完全填充的源规范。

"sourceSpec": {
  "attributes": {
    "uiAttributes": {
      "isSource": true,
      "isPreview": true,
      "isBeta": true,
      "category": {
        "key": "protocols"
      },
      "icon": {
        "key": "genericRestIcon"
      },
      "description": {
        "key": "genericRestDescription"
      },
      "label": {
        "key": "genericRestLabel"
      }
    },
    "spec": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "description": "Defines static and user input parameters to fetch resource values.",
      "properties": {
        "urlParams": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string",
              "description": "Enter resource url host path.",
              "example": "https://{domain}.api.mailchimp.com"
            },
            "path": {
              "type": "string",
              "description": "Enter resource path",
              "example": "/3.0/reports/campaignId/email-activity"
            },
            "method": {
              "type": "string",
              "description": "HTTP method type.",
              "enum": [
                "GET",
                "POST"
              ]
            },
            "queryParams": {
              "type": "object",
              "description": "The query parameters in json format",
            }
          },
          "required": [
            "host",
            "path",
            "method"
          ]
        },
        "headerParams": {
          "type": "object",
          "description": "The header parameters in json format",
        },
        "contentPath": {
          "type": "object",
          "description": "The parameters required for main collection content.",
          "properties": {
            "path": {
              "description": "The path to the main content.",
              "type": "string",
              "example": "$.emails"
            },
            "skipAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be skipped while fattening the array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "keepAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be kept while fattening the array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "overrideWrapperAttribute": {
              "type": "string",
              "description": "The new name to be used for the root content path node.",
              "example": "email"
            }
          },
          "required": [
            "path"
          ]
        },
        "explodeEntityPath": {
          "type": "object",
          "description": "The parameters required for the sub-array content.",
          "properties": {
            "path": {
              "description": "The path to the sub-array content.",
              "type": "string",
              "example": "$.email.activity"
            },
            "skipAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be skipped while fattening sub-array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "keepAttributes": {
              "type": "array",
              "description": "The list of attributes that needs to be kept while fattening the sub-array.",
              "example": "[total_items]",
              "items": {
                "type": "string"
              }
            },
            "overrideWrapperAttribute": {
              "type": "string",
              "description": "The new name to be used for the  root content path node.",
              "example": "activity"
            }
          },
          "required": [
            "path"
          ]
        },
        "paginationParams": {
          "type": "object",
          "description": "The parameters required to fetch data using pagination.",
          "properties": {
            "type": {
              "description": "The pagination fetch type.",
              "type": "string",
              "enum": [
                "OFFSET",
                "POINTER"
              ]
            },
            "limitName": {
              "type": "string",
              "description": "The limit property name",
              "example": "limit or count"
            },
            "limitValue": {
              "type": "integer",
              "description": "The number of records to fetch per page.",
              "example": "limit=10 or count=10"
            },
            "offsetName": {
              "type": "string",
              "description": "The offset property name",
              "example": "offset"
            },
            "pointerPath": {
              "type": "string",
              "description": "The path to pointer property",
              "example": "$.paging.next"
            }
          },
          "required": [
            "type",
            "limitName",
            "limitValue"
          ]
        },
        "scheduleParams": {
          "type": "object",
          "description": "The parameters required to fetch data for batch schedule.",
          "properties": {
            "scheduleStartParamName": {
              "type": "string",
              "description": "The order property name to get the order by date."
            },
            "scheduleEndParamName": {
              "type": "string",
              "description": "The order property name to get the order by date."
            },
            "scheduleStartParamFormat": {
              "type": "string",
              "description": "The order property name to get the order by date.",
              "example": "yyyy-MM-ddTHH:mm:ssZ"
            },
            "scheduleEndParamFormat": {
              "type": "string",
              "description": "The order property name to get the order by date.",
              "example": "yyyy-MM-ddTHH:mm:ssZ"
            }
          },
          "required": [
            "scheduleStartParamName",
            "scheduleEndParamName"
          ]
        }
      },
      "required": [
        "urlParams",
        "contentPath",
        "paginationParams",
        "scheduleParams"
      ]
    }
  },
}
属性
描述
示例
sourceSpec.attributes
包含有关UI或API专属源的信息。
sourceSpec.attributes.uiAttributes
显示特定于UI的源的信息。
sourceSpec.attributes.uiAttributes.isBeta
一个布尔属性,指示源是否需要客户提供更多反馈才能添加到其功能中。
  • true
  • false
sourceSpec.attributes.uiAttributes.category
定义源的类别。
  • advertising
  • crm
  • customer success
  • database
  • ecommerce
  • marketing automation
  • payments
  • protocols
sourceSpec.attributes.uiAttributes.icon
定义用于在Platform UI中呈现源的图标。
mailchimp-icon.svg
sourceSpec.attributes.uiAttributes.description
显示源的简要说明。
sourceSpec.attributes.uiAttributes.label
显示用于在Platform UI中呈现源的标签。
sourceSpec.attributes.spec.properties.urlParams
包含有关URL资源路径、方法和支持的查询参数的信息。
sourceSpec.attributes.spec.properties.urlParams.properties.path
定义从中获取数据的资源路径。
/3.0/reports/${campaignId}/email-activity
sourceSpec.attributes.spec.properties.urlParams.properties.method
定义请求资源获取数据时使用的HTTP方法。
GETPOST
sourceSpec.attributes.spec.properties.urlParams.properties.queryParams
定义支持的查询参数,这些参数可用于在发出获取数据的请求时附加源URL。 注意:任何用户提供的参数值都必须设置为占位符的格式。 例如:${USER_PARAMETER}
"queryParams" : {"key" : "value", "key1" : "value1"} 将作为附加到源URL中: /?key=value&key1=value1
sourceSpec.attributes.spec.properties.spec.properties.headerParams
定义在提取数据时需要在到源URL的HTTP请求中提供的标头。
"headerParams" : {"Content-Type" : "application/json", "x-api-key" : "key"}
sourceSpec.attributes.spec.properties.bodyParams
此属性可以配置为通过POST请求发送HTTP正文。
sourceSpec.attributes.spec.properties.contentPath
定义包含需要引入到Platform的项目列表的节点。 此属性应遵循有效的JSON路径语法,且必须指向特定数组。
查看 其他资源部分 有关内容路径中包含的资源的示例。
sourceSpec.attributes.spec.properties.contentPath.path
指向要引入到Platform的收藏集记录的路径。
$.emails
sourceSpec.attributes.spec.properties.contentPath.skipAttributes
通过此属性,可识别内容路径中标识的资源中将被排除在摄取范围之外的特定项目。
[total_items]
sourceSpec.attributes.spec.properties.contentPath.keepAttributes
此属性允许您明确指定要保留的个别属性。
[total_items]
sourceSpec.attributes.spec.properties.contentPath.overrideWrapperAttribute
此属性允许您覆盖在中指定的属性名称值 contentPath.
email
sourceSpec.attributes.spec.properties.explodeEntityPath
此属性允许您扁平化两个数组并将资源数据转换为Platform资源。
sourceSpec.attributes.spec.properties.explodeEntityPath.path
指向要拼合的收藏集记录的路径。
$.email.activity
sourceSpec.attributes.spec.properties.explodeEntityPath.skipAttributes
此属性允许您从实体路径中标识的资源中标识要排除以不被引入的特定项目。
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.keepAttributes
此属性允许您明确指定要保留的个别属性。
[total_items]
sourceSpec.attributes.spec.properties.explodeEntityPath.overrideWrapperAttribute
此属性允许您覆盖在中指定的属性名称值 explodeEntityPath.
activity
sourceSpec.attributes.spec.properties.paginationParams
定义从用户的当前页面响应中或在创建下一页URL时必须提供的参数或字段,才能获取到下一页的链接。
sourceSpec.attributes.spec.properties.paginationParams.type
显示源支持的分页类型的类型。
  • OFFSET:利用此分页类型,可通过指定从何处开始生成数组的索引以及限制返回的结果数来解析结果。
  • POINTER:此分页类型允许您使用 pointer 变量来指向需要随请求一起发送的特定项目。 指针类型分页要求有效负载中的路径指向下一页。
  • CONTINUATION_TOKEN:利用此分页类型,可将查询或标头参数附加到连续令牌,以从源中检索因预设最大值而未最初返回的剩余返回数据。
  • PAGE:此分页类型允许您将查询参数附加到分页参数,以按页遍历返回数据,从第0页开始。
  • NONE:此分页类型可用于不支持任何可用分页类型的源。 分页类型 NONE 在请求后返回整个响应数据。
sourceSpec.attributes.spec.properties.paginationParams.limitName
限制的名称,API可通过该名称指定页面中要提取的记录数。
limitcount
sourceSpec.attributes.spec.properties.paginationParams.limitValue
页面中要获取的记录数。
limit=10count=10
sourceSpec.attributes.spec.properties.paginationParams.offSetName
偏移属性名称。 如果将分页类型设置为,则必须执行此操作 offset.
offset
sourceSpec.attributes.spec.properties.paginationParams.pointerPath
指针属性名称。 这需要指向指向下一页的属性的json路径。 如果将分页类型设置为,则必须执行此操作 pointer.
pointer
sourceSpec.attributes.spec.properties.scheduleParams
包含定义源支持的计划格式的参数。 计划参数包括 startTimeendTime,这两种方法都允许您为批处理运行设置特定的时间间隔,从而确保不再获取在上一次批处理运行中获取的记录。
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamName
定义开始时间参数名称
since_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamName
定义结束时间参数名称
before_last_changed
sourceSpec.attributes.spec.properties.scheduleParams.scheduleStartParamFormat
定义支持的格式 scheduleStartParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.attributes.spec.properties.scheduleParams.scheduleEndParamFormat
定义支持的格式 scheduleEndParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.spec.properties
定义用户提供的用于获取资源值的参数。
请参阅 其他资源 例如,用户输入的参数对于 spec.properties.

其他资源 appendix

以下部分提供了有关您可以对进行的其他配置的信息 sourceSpec,包括高级计划和自定义架构。

内容路径示例 content-path

以下示例介绍了 contentPath 中的属性 MailChimp Members 连接规范。

"contentPath": {
  "path": "$.members",
  "skipAttributes": [
    "_links",
    "total_items",
    "list_id"
  ],
  "overrideWrapperAttribute": "member"
}

spec.properties 用户输入示例 user-input

以下是用户提供的示例 spec.properties 使用 MailChimp Members 连接规范。

在此示例中, listId 作为的一部分提供 urlParams.path. 如果您需要检索 listId 之后,您还必须将其定义为的一部分 spec.properties.

"urlParams": {
        "path": "/3.0/lists/${listId}/members",
        "method": "GET"
      }
"spec": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "description": "Define user input parameters to fetch resource values.",
      "properties": {
        "listId": {
          "type": "string",
          "description": "listId for which members need to fetch."
        }
      }
    }

源规格示例 source-spec

以下是已完成的源规格,使用 MailChimp Members:

  "sourceSpec": {
    "attributes": {
      "uiAttributes": {
        "isSource": true,
        "isPreview": true,
        "isBeta": true,
        "category": {
          "key": "marketingAutomation"
        },
        "icon": {
          "key": "mailchimpMembersIcon"
        },
        "description": {
          "key": "mailchimpMembersDescription"
        },
        "label": {
          "key": "mailchimpMembersLabel"
        }
      },
      "urlParams": {
        "host": "https://{domain}.api.mailchimp.com",
        "path": "/3.0/lists/${listId}/members",
        "method": "GET"
      },
      "contentPath": {
        "path": "$.members",
        "skipAttributes": [
          "_links",
          "total_items",
          "list_id"
        ],
        "overrideWrapperAttribute": "member"
      },
      "paginationParams": {
        "type": "OFFSET",
        "limitName": "count",
        "limitValue": "100",
        "offSetName": "offset"
      },
      "scheduleParams": {
        "scheduleStartParamName": "since_last_changed",
        "scheduleEndParamName": "before_last_changed",
        "scheduleStartParamFormat": "yyyy-MM-ddTHH:mm:ss:fffffffK",
        "scheduleEndParamFormat": "yyyy-MM-ddTHH:mm:ss:fffffffK"
      }
    },
    "spec": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "type": "object",
      "description": "Define user input parameters to fetch resource values.",
      "properties": {
        "listId": {
          "type": "string",
          "description": "listId for which members need to fetch."
        }
      }
    }
  }

为源配置不同的分页类型 pagination

以下是自助源(批处理SDK)支持的其他分页类型示例:

偏移

此分页类型允许您通过指定从何处开始结果数组的索引以及返回结果数的限制来解析结果。 例如:

code language-json
"paginationParams": {
        "type": "OFFSET",
        "limitName": "limit",
        "limitValue": "4",
        "offSetName": "offset",
        "endConditionName": "$.hasMore",
        "endConditionValue": "Const:false"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
属性 描述
type 用于返回数据的分页类型。
limitName 限制的名称,API可通过该名称指定页面中要提取的记录数。
limitValue 页面中要获取的记录数。
offSetName 偏移属性名称。 如果将分页类型设置为,则必须执行此操作 offset.
endConditionName 用户定义的值,指示将在下一个HTTP请求中结束分页循环的条件。 必须提供要放置结束条件的属性名称。
endConditionValue 要放置结束条件的属性值。
指针

此分页类型允许您使用 pointer 变量来指向需要随请求一起发送的特定项目。 指针类型分页要求有效负载中的路径指向下一页。 例如:

code language-json
{
 "type": "POINTER",
 "limitName": "limit",
 "limitValue": 1,
 "pointerPath": "paging.next"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
属性 描述
type 用于返回数据的分页类型。
limitName 限制的名称,API可通过该名称指定页面中要提取的记录数。
limitValue 页面中要获取的记录数。
pointerPath 指针属性名称。 这需要指向指向下一页的属性的json路径。
继续令牌

连续令牌类型的分页会返回一个字符串令牌,表示存在更多无法返回的项目,因为单个响应中可以返回的项目数已达到预设的最大值。

支持连续令牌类型分页的源可能具有类似于以下内容的分页参数:

code language-json
"paginationParams": {
  "type": "CONTINUATION_TOKEN",
  "continuationTokenPath": "$.meta.after_cursor",
  "parameterType": "QUERYPARAM",
  "parameterName": "page[after]",
  "delayRequestMillis": "850"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
属性 描述
type 用于返回数据的分页类型。
continuationTokenPath 为移动到返回结果的下一页而必须附加到查询参数的值。
parameterType parameterType 属性定义 parameterName 必须添加。 此 QUERYPARAM 类型允许您将查询附加到 parameterName. 此 HEADERPARAM 允许您添加 parameterName 到您的标头请求中。
parameterName 用于合并连续令牌的参数的名称。 格式如下: {PARAMETER_NAME}={CONTINUATION_TOKEN}.
delayRequestMillis delayRequestMillis 使用属性分页,您可以控制向源发出的请求速率。 某些源对每分钟可以发出的请求数存在限制。 例如, Zendesk 具有每分钟100个请求的限制,并定义 delayRequestMillis850 允许您将源配置为仅以大约每分钟80个请求进行调用,远低于每分钟100个请求的阈值。

以下是使用连续令牌类型分页返回的响应示例:

code language-json
{
  "results": [
    {
      "id": 5624716025745,
      "url": "https://dev.zendesk.com/api/v2/users/5624716025745.json",
      "name": "newinctest@zenaep.com",
      "email": "newinctest@zenaep.com",
      "created_at": "2022-04-22T10:27:30Z",

    }
  ],
  "facets": null,
  "meta": {
    "has_more": false,
    "after_cursor": "eyJmaWVsZCI6ImNyZWF0ZWRfYXQiLCJk",
    "before_cursor": null
  },
  "links": {
    "prev": null,
    "next": "https://dev.zendesk.com/api/v2/search/export.json?filter%5Btype%5D=user&page%5Bafter%5D=eyJmaWVsZCI6"
  }
}
页面

PAGE 分页类型允许您按从零开始的页数遍历返回数据。 使用时 PAGE 类型分页,您必须提供单个页面中给定的记录数。

code language-json
"paginationParams": {
  "type": "PAGE",
  "limitName": "pageSize",
  "limitValue": 100,
  "initialPageIndex": 1,
  "endPageIndex": "headers.x-pagecount",
  "pageParamName": "pageNumber",
  "maximumRequest": 10000
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto
属性 描述
type 用于返回数据的分页类型。
limitName 限制的名称,API可通过该名称指定页面中要提取的记录数。
limitValue 页面中要获取的记录数。
initialPageIndex (可选)初始页索引定义分页将开始的页码。 此字段可用于分页不是从0开始的源。 如果未提供,则初始页面索引将默认为0。 此字段应为整数。
endPageIndex (可选)利用结束页面索引,可建立结束条件并停止分页。 当默认结束条件不可用以停止分页时,可以使用此字段。 如果要摄取的页数或最后一个页码通过响应标头提供(在使用时很常见),也可以使用此字段 PAGE 类型分页。 结束页索引的值可以是最后一个页码,也可以是响应标头中的字符串类型表达式值。 例如,您可以使用 headers.x-pagecount 将结束页索引分配给 x-pagecount 响应标头中的值。 注意x-pagecount 是某些源的强制响应标头,它包含要提取的页面数量的值。
pageParamName 为遍历返回数据的不同页面而必须附加到查询参数的参数名称。 例如, https://abc.com?pageIndex=1 将返回API返回有效负载的第二页。
maximumRequest 源可为给定的增量运行发出的最大请求数。 当前的默认限制为10000。
None

NONE 分页类型可用于不支持任何可用分页类型的源。 使用分页类型的源 NONE 只需在发出GET请求时返回所有可检索记录。

code language-json
"paginationParams": {
  "type": "NONE"
}

自助式源的高级计划(批处理SDK)

使用高级计划配置源的增量计划和回填计划。 此 incremental 属性允许您配置计划,使源仅摄取新的或修改的记录,而 backfill 属性允许您创建计划以摄取历史数据。

通过高级计划,您可以使用特定于源的表达式和函数来配置增量计划和回填计划。 在以下示例中, Zendesk 源要求将增量计划格式化为 type:user updated > {START_TIME} updated < {END_TIME} 并回填为 type:user updated < {END_TIME}.

"scheduleParams": {
        "type": "ADVANCE",
        "paramFormat": "yyyy-MM-ddTHH:mm:ssK",
        "incremental": "type:user updated > {START_TIME} updated < {END_TIME}",
        "backfill": "type:user updated < {END_TIME}"
      }
属性
描述
scheduleParams.type
您的源将使用的计划类型。 将此值设置为 ADVANCE 以使用高级计划类型。
scheduleParams.paramFormat
计划参数的定义格式。 此值可与源的 scheduleStartParamFormatscheduleEndParamFormat 值。
scheduleParams.incremental
源的增量查询。 增量是指仅摄取新数据或修改数据的摄取方法。
scheduleParams.backfill
源的回填查询。 回填是指摄取历史数据的摄取方法。

配置高级计划后,您必须参考 scheduleParams 在URL、正文或标头参数部分中,具体取决于特定源支持的内容。 在以下示例中, {SCHEDULE_QUERY} 是一个占位符,用于指定使用增量计划和回填计划表达式的位置。 在a Zendesk 源, query 在中使用 queryParams 以指定高级计划。

"urlParams": {
        "path": "/api/v2/search/export@{if(empty(coalesce(pipeline()?.parameters?.ingestionStart,'')),'?query=type:user&filter[type]=user&','')}",
        "method": "GET",
        "queryParams": {
          "query": "{SCHEDULE_QUERY}",
          "filter[type]": "user"
        }
      }

添加自定义架构以定义源的动态属性

您可以在中包含自定义架构, sourceSpec 定义源所需的所有属性,包括可能需要的任何动态属性。 您可以通过向以下地址发出PUT请求来更新源的相应连接规范: /connectionSpecs 的端点 Flow Service API,同时在中提供您的自定义架构 sourceSpec 连接规范的部分。

以下是您可以添加到源的连接规范中的自定义架构示例:

      "schema": {
        "type": "object",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "organization_id": {
                  "type": "integer",
                  "minimum": -9007199254740992,
                  "maximum": 9007199254740991
                }
                "active": {
                  "type": "boolean"
                },
                "created_at": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "iana_time_zone": {
                  "type": "string"
                },
                "id": {
                  "type": "integer"
                },
                "locale": {
                  "type": "string"
                },
                "locale_id": {
                  "type": "integer"
                },
                "moderator": {
                  "type": "boolean"
                },
                "name": {
                  "type": "string"
                },
                "only_private_comments": {
                  "type": "boolean"
                },
                "report_csv": {
                  "type": "boolean"
                },
                "restricted_agent": {
                  "type": "boolean"
                },
                "result_type": {
                  "type": "string"
                },
                "role": {
                  "type": "integer"
                },
                "shared": {
                  "type": "boolean"
                },
                "shared_agent": {
                  "type": "boolean"
                },
                "suspended": {
                  "type": "boolean"
                },
                "ticket_restriction": {
                  "type": "string"
                },
                "time_zone": {
                  "type": "string"
                },
                "two_factor_auth_enabled": {
                  "type": "boolean"
                },
                "updated_at": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "verified": {
                  "type": "boolean"
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }

后续步骤

填充源规范后,您可以继续为要集成到Platform的源配置浏览规范。 查看文档 配置浏览规范 以了解更多信息。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089