批量操作-BulkOperation 对象

异步长时间运行的操作,用于批量获取数据。

使用该bulkOperationRunQuery突变创建批量操作。创建它们之后,客户端应轮询该status字段以获取更新。如果为COMPLETED,则该url字段包含指向JSONL格式的数据的链接。

有关更多详细信息,请参见批量操作指南


在本页面


字段

  • completedAt[DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)
    批量操作成功完成时。
  • createdAt[DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)
    创建批量操作时。
  • errorCode[BulkOperationErrorCode](https://shopify.dev/docs/admin-api/graphql/reference/bulk-operations/bulkoperationerrorcode)
    操作失败的错误代码。
  • fileSize[UnsignedInt64](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)
    url字段中文件的文件大小(以字节为单位)。
  • id[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)
    全局唯一标识符。
  • objectCount[UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)
    所有已处理对象的运行计数。例如,在获取所有产品及其变体时,此字段同时计算产品和变体。该字段可用于跟踪操作进度。
  • partialDataUrl[URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)
    失败操作返回的部分/不完整响应数据(JSONL格式)的URL 。操作失败一周后到期。null没有可用数据时返回。
  • query[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)
    在中指定的GraphQL查询文档bulkOperationRunQuery
  • rootObjectCount[UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)
    在查询根目录中处理的所有对象的运行计数。例如,在获取所有产品及其变体时,此字段仅计算产品。该字段可用于跟踪操作进度。
  • status[BulkOperationStatus!](https://shopify.dev/docs/admin-api/graphql/reference/bulk-operations/bulkoperationstatus)
    批量操作的状态。
  • url[URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)
    JSONL格式的响应数据的URL 。操作完成后一周内到期。

返回BulkOperation的类型

  • [QueryRoot.currentBulkOperation](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#currentbulkoperation-2021-01)

批量操作突变


派生关系

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)