评论
评论是读者对博客文章的回应。注释按相反的时间顺序显示在文章页面上,通常在文章正文之后。正如博客可以包含任意数量的文章一样,文章可以包含任意数量的评论。
文章评论是垃圾邮件发送者的目标,因此Shopify博客使用垃圾邮件检测系统来识别可能是垃圾邮件的评论。店主还可以将评论标记为垃圾邮件或非垃圾邮件。标记为垃圾邮件的评论将从Shopify管理员中删除,并且不会出现在博客中。
您可以用评论做什么
Shopify API使您可以使用Comment资源执行以下操作。这些常规操作的更详细的版本可能可用:
- GET /admin/api/2021-01/comments.json?article_id=134645308&blog_id=241253187检索评论列表
- GET /admin/api/2021-01/comments/count.json?article_id=134645308&blog_id=241253187检索评论数
- GET /admin/api/2021-01/comments/{comment_id}.json通过ID检索单个评论
- POST /admin/api/2021-01/comments.json为文章创建评论
- PUT /admin/api/2021-01/comments/{comment_id}.json更新文章评论
- POST /admin/api/2021-01/comments/{comment_id}/spam.json将评论标记为垃圾邮件
- POST /admin/api/2021-01/comments/{comment_id}/not_spam.json将评论标记为不是垃圾邮件
- POST /admin/api/2021-01/comments/{comment_id}/approve.json批准评论
- POST /admin/api/2021-01/comments/{comment_id}/remove.json删除评论
- POST /admin/api/2021-01/comments/{comment_id}/restore.json恢复先前删除的评论
评论属性
article_id | plain "article_id": 134645308 评论所属文章的唯一数字标识符。 |
---|---|
作者 | plain "author": "Soleone" 评论作者的姓名。 |
blog_id | plain "blog_id": 241253187 包含评论所属文章的博客的唯一数字标识符。 |
身体 | plain "body": "This is a _great_ article." 注释的基本纺织品标记)。 |
body_html | plain "body_html": "<p>This is a <em>great</em> article.</p>" 注释文本,带有HTML标记。 |
created_at 只读 | plain "created_at": "2012-08-24T14:01:46-04:00" 创建注释的日期和时间(ISO 8601格式)。 |
电子邮件 | plain "email": "sole@one.de" 评论作者的电子邮件地址。 |
ID 只读 | plain "id": 653537639 注释的唯一数字标识符。 |
ip | plain "ip": "127.0.0.1" 发布评论的IP地址。 |
已发布 | plain "published_at": "2012-08-24T14:02:00-04:00" 发布评论的日期和时间(ISO 8601格式)。 |
状态 只读 | plain "status": "unapproved" 评论的状态。有效值:+ 未决:评论已创建,但正在等待垃圾邮件检测。根据不同的垃圾邮件检测和店主的评论喜好的结果,此属性将被转换到要么 spam ,unapproved 或approved 。+ 未批准(默认):评论正在等待商店所有者的批准。博客的读者看不到它。 + 已发布:评论已被批准(如果博客要求评论必须得到批准),并且博客的读者可以看到。 + 垃圾邮件:该评论已被标记为垃圾邮件,并已从Shopify管理员中删除。博客的读者看不到它。 + 已删除:商店所有者已删除评论。博客的读者看不到它。 |
Updated_at 只读 | plain "updated_at": "2012-08-24T14:02:00-04:00" 上次修改注释的日期和时间(ISO 8601格式)。创建注释后,它与的值匹配created_at 。如果博客要求批准评论,则此值将更新为批准评论的日期和时间。 |
用户代理 | plain "user_agent": "Mozilla/5.0" 用于创建注释的软件(通常是浏览器)提供的用户代理字符串。 |
终点
得到/admin/api/2021-01/comments.json?article_id=134645308&blog_id=241253187 检索评论列表。注意:从2019-10版本开始,此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>
参数将返回错误。要了解更多信息,请参阅向分页的REST Admin API端点发出请求。
限制 | 要检索的最大结果数。 (默认值: 50 最大: 250 ) |
---|---|
since_id | 将结果限制为指定的ID之后。 |
created_at_min | 显示在日期之后创建的评论(格式:2014-04-25T16:15:47-04:00)。 |
created_at_max | 显示在日期之前创建的评论(格式:2014-04-25T16:15:47-04:00)。 |
Updated_at_min | 显示评论最后更新日期(格式:2014-04-25T16:15:47-04:00)。 |
Updated_at_max | 显示评论的最后更新时间为日期(格式:2014-04-25T16:15:47-04:00)。 |
Published_at_min | 显示日期后发布的评论(格式:2014-04-25T16:15:47-04:00)。 |
published_at_max | 显示日期之前发布的评论(格式:2014-04-25T16:15:47-04:00)。 |
领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
已发布状态 | 按发布状态过滤结果。 (默认值: any ) + 已发布:仅显示已发布的评论。 + 未发布:仅显示未发布的评论。 + 任何:显示任何已发布状态的评论。 |
状态 | 按状态过滤结果。 + 未决:仅显示未决评论。 + 已发布:仅显示已发布的评论。 + 未批准:仅显示未批准的评论。 |
检索博客某篇文章的所有评论
GET /admin/api/2021-01/comments.json?article_id=134645308&blog_id=241253187
检索博客所有文章的所有评论
GET /admin/api/2021-01/comments.json?blog_id=241253187
检索该商店的所有评论
GET /admin/api/2021-01/comments.json
在指定ID后检索该商店的所有评论
GET /admin/api/2021-01/comments.json?since_id=118373535
得到/admin/api/2021-01/comments/count.json?article_id=134645308&blog_id=241253187 检索评论数created_at_min | 计算日期之后创建的评论(格式:2014-04-25T16:15:47-04:00)。 |
---|---|
created_at_max | 计算在日期之前创建的评论(格式:2014-04-25T16:15:47-04:00)。 |
Updated_at_min | 计数评论的最后更新日期(格式:2014-04-25T16:15:47-04:00)。 |
Updated_at_max | 计算在日期之前最后更新的评论(格式:2014-04-25T16:15:47-04:00)。 |
Published_at_min | 计算日期后发布的评论(格式:2014-04-25T16:15:47-04:00)。 |
published_at_max | 计算在日期之前发布的评论(格式:2014-04-25T16:15:47-04:00)。 |
已发布状态 | 检索具有给定发布状态的评论数。 (默认值: any ) + 已发布:仅统计已发布的评论。 + 未发布:仅计算未发布的评论。 + 任何:计算任何已发布状态的评论。 |
状态 | 检索具有给定状态的评论数。 + 未决:计算未决评论。 + 已发布:计算已发布的评论。 + 未批准:计算未批准的评论。 |
计算博客某篇文章的所有评论
GET /admin/api/2021-01/comments/count.json?article_id=134645308&blog_id=241253187
计算博客所有文章的所有评论
GET /admin/api/2021-01/comments/count.json?blog_id=241253187
计算此商店的所有评论
GET /admin/api/2021-01/comments/count.json
得到/admin/api/2021-01/comments/{comment_id}.json 通过ID检索单个评论领域 | 仅显示某些字段,这些字段由逗号分隔的字段名称列表指定。 |
---|---|
检索单个评论
GET /admin/api/2021-01/comments/118373535.json
邮政/admin/api/2021-01/comments.json 为文章创建评论使用基本的Textile标记为博客文章创建评论
POST /admin/api/2021-01/comments.json
{
“评论” : {
“ body” :“我喜欢评论\ n并且我喜欢* RESTfully *发表。”,
“作者” :“您的名字”,
“电子邮件” :“ your@email.com”,
“ ip” :“ 107.20.160.121”,
“ blog_id” :241253187,
“ article_id” :134645308
}
}
创建没有正文,作者和电子邮件的评论失败并返回错误
POST /admin/api/2021-01/comments.json
{
“评论” : {
“ article_id” :134645308
}
}
放/admin/api/2021-01/comments/{comment_id}.json 更新文章评论更新现有评论的正文
PUT /admin/api/2021-01/comments/118373535.json
{
“评论” : {
“ id” :118373535,
“ body” :“甚至可以通过Web服务进行更新。”,
“作者” :“您的新名字”,
“电子邮件” :“ your@updated-email.com”,
“ published_at” :“ 2021-02-06T04:12:18.371Z”
}
}
邮政/admin/api/2021-01/comments/{comment_id}/spam.json 将评论标记为垃圾邮件将评论标记为垃圾邮件
POST /admin/api/2021-01/comments/653537639/spam.json
{
}
邮政/admin/api/2021-01/comments/{comment_id}/not_spam.json 将评论标记为不是垃圾邮件将评论标记为不是垃圾评论,将其恢复为未批准或已发布状态
POST /admin/api/2021-01/comments/653537639/not_spam.json
{
}
邮政/admin/api/2021-01/comments/{comment_id}/approve.json 批准评论批准评论并将其发布到博客
POST /admin/api/2021-01/comments/653537639/approve.json
{
}
邮政/admin/api/2021-01/comments/{comment_id}/remove.json 删除评论删除评论
POST /admin/api/2021-01/comments/653537639/remove.json
{
}
邮政/admin/api/2021-01/comments/{comment_id}/restore.json 恢复先前删除的评论恢复删除的评论
POST /admin/api/2021-01/comments/653537639/restore.json
{
}