管理廣告素材

  • 發行項

在 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 方法。

標題 類型 描述
授權 string 必要。 持有人<權杖>形式的Azure AD 存取權杖。
追蹤 ID GUID 選擇性。 追蹤呼叫流程的識別碼。

要求本文

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"
    }
}

創意內容物件

這些方法的要求和回應本文包含下欄欄位。 下表顯示哪些欄位是唯讀的 (表示無法在 PUT 方法中變更欄位)，以及 POST 方法的要求本文中需要哪些欄位。

欄位 類型 描述 唯讀 預設 POST 的必要項目
識別碼 整數 創意內容的識別碼。 是 No
NAME 字串 創意內容的名稱。 No Yes
content string 以 Base64 編碼為格式的創意影像內容。

注意：您的創意內容允許的大小上限為 40 KB。 如果您提交大於此的創意內容檔案，此 API 將不會傳回錯誤，但無法成功建立行銷活動。		 No Yes
高度 整數 創意內容的高度。 No Yes
width 整數 創意內容的寬度。 No Yes
landingUrl string 如果您使用如 AppsFlyer、Kochava、Tune 或 Vungle 等行銷活動追蹤服務來測量應用程式的安裝分析，請在呼叫 POST 方法時，在此欄位中指派您的追蹤 URL (如果指定，此值必須是有效的 URI)。 如果您未使用行銷活動追蹤服務，請在呼叫 POST 方法時省略此值 (在此情況下，系統會自動建立此 URL)。 No Yes
format string 廣告格式。 目前唯一支援的值是 Banner。 No 橫幅 No
imageAttributes ImageAttributes 提供創意內容的屬性。 No Yes
storeProductId string 與此廣告行銷活動相關聯的應用程式 Store 識別碼。 產品的 Store ID 範例為 9nblggh42cfd。 No No

ImageAttributes 物件

欄位 類型 描述 唯讀 預設值 POST 的必要項目
imageExtension string 下列其中一個值：PNG 或 JPG。 No Yes