实体快照

警告

目前，广告 API 不支持品牌推广视频广告活动的快照或使用版本 4 接口创建的广告活动的快照。快照包括版本 3的记录，仅限非视频广告活动。

用于批量检索您的广告活动和关键词的记录。此接口用于异步下载批量账户快照文件。

方式	URL	使用案例
POST	/v2/hsa/{recordType}/snapshot	请求账户中满足筛选条件的所有指定类型的实体的基于文件的快照。
GET	/v2/hsa/snapshots/{snapshotId}	检索先前请求的快照的状态、元数据和位置。

操作

requestSnapshot

POST /v2/hsa/{recordType}/snapshot    

{                                
  "stateFilter":{stateFilter}     
}

为商品推广或品牌推广的单一记录类型的所有实体请求快照报告。

参数

参数名称	类型	指定位置	描述
recordType	String	URL	应为其生成快照的实体类型。必须是以下值之一：campaigns 或 keywords。
stateFilter	String	POST 体	将结果限制为指定逗号分隔列表中包含状态的实体。必须是以下值之一：enabled、paused、archived。默认行为包括已启用 (enabled) 和已暂停 (paused)。

响应

状态代码	响应对象
202 - success	SnapshotResponse
401 - unauthorized	Error

The SnapshotResponse 将包含快照状态。其他元数据 将在快照完成后填充且位置 标头将指定生成报告的位置。

资源表现

SnapshotResponse

{
    "title": "SnapshotResponse",
    "type": "object",
    "properties": {   
      "snapshotId": {
           "description": "The ID of the snapshot that was requested.",
           "type": "string"
       },
      "recordType": {
           "description": "The record type of the report.",
           "type": "string",
           "oneOf": ["campaigns","keywords"]
       },
       "status": {
           "description": "The status of the generation of the snapshot.",
           "type": "string",
           "oneOf":["IN_PROGRESS","SUCCESS","FAILURE"]
       },
       "statusDetails": {
           "description": "Description of the status.",
           "type": "string"
       },
       "location": {
           "description": "The URI for the snapshot.It's only available if status is SUCCESS.",
           "type": "string"
       },
       "fileSize": {
           "description": "The size of the snapshot file in bytes.It's only available if status is SUCCESS.",
           "type": "number"
       },
       "expiration": {
           "description": "The epoch time for expiration of the snapshot file.It's only available if status is SUCCESS.",
           "type": "number"
       }
    }
}

错误

请参阅开发人员说明中的错误响应对象。