通过

管理创意

  • 项目

在 Microsoft Store 促销 API 中使用这些方法上传你自己的自定义创意以便在促销性广告活动中使用，或获取现有创意。 如果某一创意始终代表同一应用，则其可能与一个投放渠道或各广告活动间的多个投放渠道相关。

有关创意与广告活动、投放渠道和目标市场配置文件之间关系的详细信息，请参阅使用 Microsoft Store 服务开展广告活动。

注意

使用此 API 上载自己的创意时，允许的最大创意大小为 40 KB。 如果提交的创意文件大于此值，则此 API 将不会返回错误，但不会成功创建市场活动。

先决条件

若要使用这些方法，首先需要执行以下操作：

  • 如果尚未开始操作，请先完成 Microsoft Store 促销 API 的所有先决条件。
  • 获取 Azure AD 访问令牌，以供在这些方法的请求标头中使用。 获取访问令牌后，在它到期前，你有 60 分钟的使用时间。 该令牌到期后，可以获取新的令牌。

请求

这些方法具有以下 URI。

方法类型 请求 URI 说明
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative 创建新创意。
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} 获取通过 creativeId 指定的创意。

注意

此 API 当前不支持 PUT 方法。

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。
跟踪 ID GUID 可选。 跟踪调用流的 ID。

请求正文

POST 方法需要一个 JSON 请求正文，其中包含创意对象的必填字段。

请求示例

下面的示例演示如何调用 POST 方法来创建创意。 在此示例中，为简洁起见，content 值已缩短。

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative HTTP/1.1
Authorization: Bearer <your access token>

{
  "name": "Contoso App Campaign - Creative 1",
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
  "height": 80,
  "width": 480,
  "imageAttributes":
  {
    "imageExtension": "PNG"
  }
}

下面的示例演示如何调用 GET 方法来检索创意。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851  HTTP/1.1
Authorization: Bearer <your access token>

响应

这些方法返回含有创意对象的 JSON 响应正文，创意对象包含有关已创建或已检索的创意的信息。 下面的示例展示了这些方法的响应正文。 在此示例中，为简洁起见，content 值已缩短。

{
    "Data": {
        "id": 106126,
        "name": "Contoso App Campaign - Creative 2",
        "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
        "height": 50,
        "width": 300,
        "format": "Banner",
        "imageAttributes":
        {
          "imageExtension": "PNG"
        },
        "storeProductId": "9nblggh42cfd"
    }
}

创意对象

这些方法的请求和响应正文包含以下字段。 这张表列出了 POST 方法请求正文中的哪些字段是只读字段（意味着不能在 PUT 方法中更改它们）以及哪些字段是必填字段。

字段 类型​​ 说明 只读 默认 POST 必填字段
id integer 创意的 ID。 是 否
name string 创意的名称。 否 是
内容 字符串 创意图像的内容（Base64 编码格式）。

注意：允许的最大创意大小为 40 KB。 如果提交的创意文件大于此值，则此 API 将不会返回错误，但不会成功创建市场活动。		 否 是
高度 integer 创意的高度。 否 是
width integer 创意的宽度。 否 是
landingUrl string 如果使用市场活动跟踪服务（如 AppsFlyer、Kochava、Tune 或 Vungle）测量应用的安装分析，则在调用 POST 方法时，请在此字段指定跟踪 URL（如已指定，则此值必须为有效 URL）。 如果未使用市场活动跟踪服务，则在调用 POST 方法时，请忽略此值（在此情况下，将会成功创建此 URL）。 否 是
format 字符串 广告的格式。 当前，唯一受支持的值为 Banner。 否 标题 否
imageAttributes ImageAttributes 提供创意的属性。 否 是
storeProductId string 与广告活动关联的应用的应用商店 ID。 产品应用商店 ID 示例：9nblggh42cfd。 否 否

ImageAttributes 对象

字段 类型​​ 说明 只读 默认值 POST 必填字段
imageExtension string 以下值之一：PNG 或 JPG。 否 是