ตัวระบุ API ที่สำคัญ

โพสต์นี้จะแสดงรายการตัวระบุที่สำคัญที่ใช้ในคำขอ Pushwoosh API ตัวระบุเหล่านี้จำเป็นสำหรับการยืนยันตัวตน, การสร้างข้อความ, การกำหนดเป้าหมาย, การแบ่งกลุ่ม, การติดตาม และการจัดการผู้ใช้ในแอปพลิเคชันของคุณ

ตัวระบุที่ไม่ซ้ำกันซึ่งกำหนดให้กับแต่ละแอปพลิเคชันในบัญชี Pushwoosh ของคุณ จำเป็นต้องใช้ในการเรียก API ส่วนใหญ่เพื่อระบุแอปเป้าหมาย

ตำแหน่งที่หาได้

Pushwoosh Control Panel → ใต้ชื่อแอปพลิเคชัน

โทเค็นที่ไม่ซ้ำกันซึ่งกำหนดให้กับบัญชี Pushwoosh ใช้เพื่อยืนยันคำขอ API ช่วยให้สามารถเข้าถึงเพื่อจัดการโปรเจกต์, ส่งข้อความ, แก้ไขการตั้งค่า และดึงข้อมูลได้ แต่ละบัญชีจะมีโทเค็นอย่างน้อยหนึ่งรายการที่สร้างขึ้นโดยค่าเริ่มต้น เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → API Access

ตัวระบุที่ไม่ซ้ำกันซึ่งกำหนดให้กับอุปกรณ์โดย Pushwoosh SDK SDK จะตั้งค่าโดยอัตโนมัติหรือส่งผ่านระหว่างการลงทะเบียนอุปกรณ์ เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

• ในบันทึกของอุปกรณ์ เรียนรู้เพิ่มเติม

• ใน User Explorer เมื่อค้นหาด้วย User ID

• ในไฟล์ CSV ที่ดาวน์โหลดจาก รายการเซกเมนต์

โทเค็นที่ออกโดยผู้ให้บริการแพลตฟอร์มซึ่งระบุคู่แอป-อุปกรณ์สำหรับการส่ง push notifications SDK จะรวบรวมโดยอัตโนมัติเมื่อมีการให้สิทธิ์ในการพุช เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

• ในบันทึกของอุปกรณ์ เรียนรู้เพิ่มเติม

• ใน User Explorer ให้ป้อน HWID ในช่องค้นหาเพื่อค้นหาอุปกรณ์ที่เกี่ยวข้อง จากนั้นเปิดรายละเอียดอุปกรณ์เพื่อดู push token

ระบุแพลตฟอร์มของอุปกรณ์เป้าหมายโดยใช้รหัสตัวเลข SDK จะตั้งค่าโดยอัตโนมัติ

ค่าที่รองรับ:

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
13 – Internet Explorer
14 – Email
16 – Baidu Android
17 – Huawei
18 – SMS
20 – Web
21 – WhatsApp
22 – Line
23 – Kakao Talk
24 – Telegram
25 – Apple Wallet
26 – Google Wallet
27 – Viber

ตัวระบุที่กำหนดเองซึ่งกำหนดให้กับผู้ใช้ ทำให้สามารถกำหนดเป้าหมายข้ามอุปกรณ์และแบบส่วนบุคคลได้ เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Audience → User Explorer

ตัวระบุที่ไม่ซ้ำกันซึ่งกำหนดให้กับแต่ละข้อความเมื่อสร้างขึ้น มีรูปแบบเฉพาะ: XXXX-XXXXXXXX-XXXXXXXX

รหัสนี้จำเป็นสำหรับ:

• การติดตามสถานะและการส่งมอบของข้อความที่ระบุ
• การยกเลิก (หรือลบ) ข้อความที่ส่งไปก่อนหน้านี้
• การรับสถิติข้อความ

ตำแหน่งที่หาได้

• Pushwoosh Control Panel: ไปที่ Campaigns → One-time messages จากนั้นเปิด properties ของข้อความที่ต้องการ รหัสข้อความจะแสดงอยู่ที่นั่น
• การตอบกลับจาก API /createMessage: เมื่อสร้างข้อความใหม่ผ่าน API รหัสข้อความจะรวมอยู่ในการตอบกลับ

เชื่อมโยงข้อความกับคำขอ HTTP ที่สร้างขึ้น ทำให้คุณสามารถติดตามการส่งเดียวตั้งแต่ต้นจนจบ — ตั้งแต่การเรียก HTTP ผ่านชั้นการกำหนดเส้นทางของ Pushwoosh ไปจนถึงข้อความผลลัพธ์

มีอยู่ในข้อความใดๆ ที่สร้างขึ้นโดยการเรียก HTTP ไปยัง /createMessage หรือ Messaging API v2 รวมถึงข้อความที่ส่งจาก Control Panel ข้อความที่สร้างโดย Journeys, การส่งแบบ cron หรือทริกเกอร์ภายในอื่นๆ ที่ไม่ใช่ HTTP จะไม่มี Request ID

การตั้งค่าค่าของคุณเอง

ส่งส่วนหัว X-Request-ID พร้อมกับคำขอ หากค่ามีความยาว 8–128 ตัวอักษรและมีเฉพาะตัวอักษรละติน, ตัวเลข, จุด, ขีดล่าง และขีดกลาง Pushwoosh จะใช้ค่าซ้ำ มิฉะนั้น — หรือหากละเว้นส่วนหัว — Pushwoosh จะสร้างให้คุณ ค่าที่ไม่ถูกต้องจะถูกแทนที่โดยไม่มีการแจ้งเตือน ดังนั้นคำขอจะไม่ล้มเหลวเพราะเหตุนี้ ไม่มีการบังคับให้ค่าไม่ซ้ำกัน ดังนั้นให้ใช้ค่าที่ไม่ซ้ำกันจริงๆ ต่อคำขอหากคุณต้องใช้ในการติดตาม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → เปิดข้อความ → Message Details → Show all properties → Message settings → Request ID (พร้อมปุ่มคัดลอก)

ตัวอย่าง: a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d

รหัสที่ไม่ซ้ำกันซึ่งระบุแคมเปญ in-app แบบทันที ตำแหน่งที่หาได้

Pushwoosh Control Panel → Campaigns → Instant in-apps ในรายการ รหัสจะแสดงอยู่ใต้ชื่อแคมเปญ

ตัวอย่าง: AAAAA-BBBBB

ตัวระบุสำหรับพรีเซ็ตข้อความที่บันทึกไว้ (เช่น push หรือ SMS) เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Content → Presets

คุณสามารถหารหัสพรีเซ็ตได้จากสองที่:

• ในมุมมองรายการ จะแสดงอยู่ใต้ชื่อพรีเซ็ต

• ใน URL เมื่อแก้ไขหรือสร้างพรีเซ็ต (เป็นส่วนสุดท้ายของ URL)

ตัวอย่าง:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

รหัสพรีเซ็ต: AAAAA-BBBBB

ตัวระบุสำหรับเทมเพลตข้อความในแอป เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Content → Rich media

ตัวอย่าง: URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics รหัสริชมีเดีย: AAAAA-BBBBB

รหัสเนื้อหาอีเมลเป็นตัวระบุที่ไม่ซ้ำกันสำหรับเนื้อหาอีเมลที่บันทึกไว้ เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Content → Email content

รหัสคือส่วนสุดท้ายของ URL

ตัวอย่าง:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB รหัสเนื้อหาอีเมล: AAAAA-BBBBB

ตัวระบุที่ไม่ซ้ำกันที่ใช้เพื่ออ้างอิงแคมเปญที่ระบุสำหรับการติดตามและวิเคราะห์

ตำแหน่งที่หาได้

รหัสแคมเปญจะปรากฏใน URL เมื่อดูสถิติที่เกี่ยวข้องกับแคมเปญใน Pushwoosh Control Panel หากต้องการค้นหา ให้ไปที่ Statistics → Aggregated statistics คลิกที่แคมเปญที่ต้องการ และคัดลอกรหัสที่อยู่ท้าย URL

ตัวอย่าง:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY

รหัสแคมเปญ: YYYYY-YYYYY

ตัวระบุที่ไม่ซ้ำกันที่ใช้เพื่อเชื่อมโยงข้อความกับแคมเปญการตลาดที่ระบุสำหรับการติดตามและวิเคราะห์ประสิทธิภาพ

ตำแหน่งที่หาได้

• ใน URL ของ campaign canvas ใน Pushwoosh Control Panel
• เลือกจุดบน canvas แล้วกด Ctrl+I (Cmd+I) — จะคัดลอก <journey UUID>/<point UUID> ไปยังคลิปบอร์ด Journey ID คือส่วนที่อยู่ก่อนเครื่องหมายทับ

ตัวอย่าง: URL: https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Journey ID: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

ชื่อของเซกเมนต์ผู้ใช้ที่กำหนดไว้ล่วงหน้าซึ่งสร้างขึ้นใน Pushwoosh สำหรับการกำหนดเป้าหมายผู้ชม เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Segments

รหัสที่ไม่ซ้ำกันในรูปแบบ XXXXX-XXXXX ที่ระบุเซกเมนต์ (หรือเรียกว่าฟิลเตอร์) ใน Pushwoosh รหัสนี้ใช้ในการเรียก API, ตรรกะอัตโนมัติ และกฎการแบ่งกลุ่มแบบไดนามิก

ตำแหน่งที่หาได้

• ผ่านเมธอด API /listFilters

• ในแถบที่อยู่เมื่อดูเซกเมนต์ใน Pushwoosh Control Panel:

ตัวอย่าง:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail รหัสเซกเมนต์: XXXE9-XXX49

แอตทริบิวต์ที่กำหนดเองซึ่งกำหนดให้กับผู้ใช้หรืออุปกรณ์ ใช้สำหรับการแบ่งกลุ่มแบบไดนามิกและการปรับแต่งส่วนบุคคล เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Tags หรือผ่าน API /getTags

ชื่อของอีเวนต์ที่ติดตาม (เช่น purchase, login, subscription) ใช้เพื่อทริกเกอร์เวิร์กโฟลว์อัตโนมัติหรือเพื่อการวิเคราะห์ เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Audience → Events

ระบุพื้นที่ที่มีขอบเขตทางภูมิศาสตร์ที่ใช้เพื่อทริกเกอร์การแจ้งเตือนตามตำแหน่ง เรียนรู้เพิ่มเติม

ตำแหน่งที่หาได้

Pushwoosh Control Panel → Geozones