Yükleme oluşturma veya üzerine yazma
Bu yöntem bir yükleme oluşturur veya üzerine yazar.
İstek
Yöntem | İstek URI'si | HTTP sürümü |
---|---|---|
PUT | https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01 |
HTTP/1.1 |
İstek üst bilgileri
Aşağıdaki tabloda gerekli ve isteğe bağlı istek üst bilgileri açıklanmaktadır.
İstek üst bilgisi | Açıklama |
---|---|
İçerik Türü | uygulama/json |
Yetkilendirme | Service Bus ile Paylaşılan Erişim İmzası Kimlik Doğrulaması'nda belirtildiği gibi oluşturulan SAS belirteci. |
x-ms-version | 2015-01 |
İstek gövdesi
Aşağıdaki tabloda yüklemeler için JSON istek gövdesinin özellikleri açıklanmaktadır:
Ad | Tür | Gerekli | Salt okunur | Açıklama |
---|---|---|---|---|
ınstallationıd | Dize | Yes | Hayır | Genel olarak benzersiz tanımlayıcı dizesi |
userID | Dize | Hayır | Hayır | Alfasayısal karakterlerin ve -_@#.:=birleşimini içeren özel dize. UserID ile Yükleme Kimliği arasında bir-çok ilişki vardır (bir Kullanıcı Kimliği birden çok yüklemeyle ilişkilendirilebilir) |
lastActiveOn | Dize | Hayır | Yes | Yüklemenin PNS tarafından devre dışı bırakıldığı tarih. |
expirationTime | Dize | Hayır | Yes | Kayıt süresinin dolacağı W3C DTF, YYYY-AA-GGThh:mmTZD (örneğin, 1997-07-16T19:20+01:00) içindeki tarih ve saati içeren dize. Değer oluşturma veya güncelleştirme sırasında hub düzeyinde ayarlanabilir ve varsayılan olarak süresi hiçbir zaman dolmaz (9999-12-31T23:59:59). |
Lastupdate | Dize | Güncelleştirme sırasında yoksayılır. Okurken döndürülür. | Yes | Bu yüklemenin son güncelleştirmesinin W3C biçimindeki tarihi. |
platform | Dize | Yes | Hayır | {APNS, WNS, MPNS, ADM, GCM} olabilir. |
pushChannel | Dize | Yes | Hayır | Bu yükleme için PNS tanıtıcısı (WNS ve ApplicationTile ChannelUri kullanıyorsanız). |
expiredPushChannel | Boole | Güncelleştirme sırasında yoksayılır. Okurken döndürülür. | Yes | Bu parametre, true PNS'nin kanalın süresinin dolup dolmadığını gösterir. |
etiketler | Dize dizisi | Hayır | Hayır | Bir etiket dizisi. Etiketler, hub belirtimlerinde tanımlandığı gibi dizelerdir. |
templates | JSON nesnesi | Hayır | Hayır | Şablon açıklamasına templateNames sözlüğü temsil eden bir JSON nesnesi. |
Şablon. {name} | Dize | Hayır | Hayır | Şablonu temsil eden JSON nesnesi. |
Şablon. {name}.body | Dize | Evet, şablon varsa | Hayır | Bildirim yükünün gövdesi için şablon. |
Şablon. {name}.headers | JSON nesnesi | Hayır. Yalnızca platform WNS veya MPNS ise mevcut olabilir. | Hayır | Her özelliğin bir üst bilgi adı, değerin ise şablon ifadesi olduğu JSON nesnesi. |
Şablon. {name}.expiry | Dize | Hayır. Yalnızca platform apns ise mevcut olabilir | Hayır | W3D tarih biçiminde değerlendirilen şablon ifadesi. |
Şablon. {name}.tags | Dize dizisi | Hayır | Hayır | Bu şablon için etiket dizisi. |
secondaryTiles | JSON nesnesi | Hayır. Yalnızca platform wns ise mevcut olabilir. | Hayır | tileId ve secondaryTiles nesnelerinin sözlüğünü içeren JSON nesnesi. |
secondaryTile. {tileId} | JSON nesnesi | Hayır | Hayır | İkincil kutucuklar için gönderme özelliklerine sahip JSON nesnesi. |
secondaryTile. {tileId}.pushChannel | Dize | Evet, tileId varsa | Hayır | İkincil kutucuk için ChannelUri. |
secondaryTile. {tileId}.tags | Dize dizisi | Hayır | Hayır | İkincil kutucuğa yerel bildirimler için etiketler. |
secondaryTile. {tileId}.templates | JSON nesnesi | Hayır | Hayır | Şablonlar özelliğiyle aynıdır, ancak her ikincil kutucuk için. |
Aşağıdaki noktalara dikkat edin:
- JSON'da öğelerin sırası önemli değildir.
- Şablon gövdesi APNS, GCM, ADM için JSON olmalıdır.
- Şablon gövdesi WNS ve MPNS için XML olmalıdır (ham olması dışında).
- WNS şablonları X-WNS-Type üst bilgisi içermelidir.
- MPNS şablonları, Windows Phone 8 için anında iletme bildirimleri gönderme bölümünde açıklandığı gibi uyumlu üst bilgiler içermelidir.
Bazı JSON örnekleri aşağıda verilmiştir.
APNS'ye kaydolma örneği:
{
"installationId": "12234",
"userID": "MyAmazingUser",
"tags": ["foo", "bar"],
"platform": "apns",
"pushChannel": "ABCDEF-123456-…"
}
Not
Tags öğesi isteğe bağlıdır.
Şablon dahil ve etiket olmadan WNS'ye yerel olarak kaydolma örneği:
{
"installationId": "12234",
"userID": "MyAmazingUser",
"platform": "wns",
"pushChannel": "https://db3...",
"templates": {
"myTemplate" : {
body : '<toast><visual lang="en-US"><binding template="ToastTest01"><text id="1">$myTextProp1</text></binding></visual></tile>',
headers: { "X-WNS-Type": "wns/toast" },
"tags": ["foo", "bar"]
}
}
}
Birçok olası öğeden oluşan bir iskelet listesi
{
installationId: "",
userID: "",
expirationTime: "",
tags: ["foo", "bar"],
lastUpdate: "",
user: "",
advertisingId: "",
appId: ""
platform: "",
pushChannel: "",
templates: {
"templateName1" : {
body: "",
headers: { "X-WNS-Type": "wns/tile" },
expiration: "",
tags: ["foo", "bar"]
}
}
secondaryTiles: {
"tileId1": {
pushChannel: "",
tags: ["foo", "bar"],
templates: {
"otherTemplate": {
bodyTemplate: "",
headers: { ... },
tags: ["foo"]
}
}
}
}
}
Yanıt
Yanıt bir HTTP durum kodu ve yanıt üst bilgileri kümesi içerir.
Yanıt kodları
Kod | Description |
---|---|
200 | Yükleme başarıyla kuyruğa alındı ve arka planda işlenir. |
400 | İstek yanlış biçimlendirilmiş olduğundan yükleme oluşturulamadı/üzerine yazılamadı. |
401 | Yetkilendirme hatası. Erişim anahtarı yanlıştı. |
403 | Bu ad alanında çok fazla yükleme var - Yüklemeler oluşturulmamış. |
Durum kodları hakkında bilgi için bkz. Durum ve Hata Kodları.
Yanıt üst bilgileri
Yanıt üst bilgisi | Açıklama |
---|---|
İçerik türü | uygulama/json |
İçerik Konumu | Yüklemenin biçimindeki konumu: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId> |
Yanıt gövdesi
Yok.
Ayrıca Bkz.
Yüklemeyi okuma
Yükleme kimliğini kullanarak yüklemeyi güncelleştirme
Yüklemeyi silme