授予访问权限

为特定用户或机构授权查看统计数据。

请求格式

提交 https://api.boost.yandex.com/management/v1/application/{id}/grants

id

App ID

Request body

{
  "grant": {
    "user_login": "string",
    "perm": "string",
    "partners": [ int, int ],
    "event_labels": ["string", "string"]
  }
}

用户登录

用户被授予访问权限的Yandex邮箱地址(登录名)。

perm

访问级别。

可能的值:

  • 查看:只读。
  • 编辑:读取/编辑。
  • agency_view: 代理只读。
  • agency_edit: 代理商查看/编辑。

要了解有关访问级别的更多信息,请参见访问分析功能。

伙伴

拥有访问权限的广告合作伙伴的ID。 要获取所有合作伙伴的列表,请使用Partner list方法。

这是授予 agency_view 和 agency_edit 权限时必填的字段。

备注

如果您正在授予代理级别的访问权限,请务必指定至少一个广告合作伴 ID。

event_labels

目标事件,代理商可以查看其统计数据。

这是在授予 agency_view 和 agency_edit 权限时的额外字段。

响应格式

{
  "grant" : {
    "user_login" : "string",
    "user_uid" : int,
    "perm" : "string",
    "comment" : "string",
    "partners" : [ int, int ],
    "event_labels" : [ "string", "string" ]
  }

用户登录

被授予访问权限的用户的 Yandex 电子邮件地址(登录名)。

uid

被授权访问的用户ID。

perm

访问级别。

可能的值:

  • 查看:只读。
  • 编辑:读取/编辑。
  • 代理视图:仅允许代理查看。
  • agency_edit: 代理商查看/编辑。

要了解有关访问级别的更多信息,请查看管理应用访问。

comment

一条评论。

伙伴

拥有访问权限的广告合作伙伴的ID。 要获取所有伙伴的列表,请使用Partner list方法。

event_labels

目标事件,代理商可以查看其统计数据。

Example

curl -X POST \
  'https://api.boost.yandex.com/management/v1/application/1111/grants' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: OAuth <your_token>' \
  -d '{
  "grant": {
    "user_login": "user_login",
    "perm": "agency_view",
    "partners": [ 145375 ],
    "event_labels": ["Checkout", "Proceed to cart"]
  }
}'

where <your_token> 是一个 OAuth 令牌,可以通过 说明 获取。

POST /management/v1/application/1111/grants HTTP/1.1
Host: api.boost.yandex.com
Content-Type: application/json
Authorization: OAuth <your_token>

{
  "grant": {
    "user_login": "user_login",
    "perm": "agency_view",
    "partners": [ 145375 ],
    "event_labels": ["Checkout", "Proceed to cart"]
  }
}

where <your_token> 是一个 OAuth 令牌,可以通过 说明 获取。

如果您没有找到所需答案,可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能,请附上截图。

联系支持 建议改进文档