Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 7.43 KB

NotificationTarget.md

File metadata and controls

36 lines (28 loc) · 7.43 KB

NotificationTarget

Properties

Name Type Description Notes
includedSegments List<String> The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: [&quot;Active Users&quot;, &quot;Inactive Users&quot;] [optional]
excludedSegments List<String> Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: [&quot;Active Users&quot;, &quot;Inactive Users&quot;] [optional]
lastSession String relation = &quot;>&quot; or &quot;<&quot; hours_ago = number of hours before or after the users last session. Example: &quot;1.1&quot; [optional]
firstSession String relation = &quot;>&quot; or &quot;<&quot; hours_ago = number of hours before or after the users first session. Example: &quot;1.1&quot; [optional]
sessionCount String relation = &quot;>&quot;, &quot;<&quot;, &quot;=&quot; or &quot;!=&quot; value = number sessions. Example: &quot;1&quot; [optional]
sessionTime String relation = &quot;>&quot;, &quot;<&quot;, &quot;=&quot; or &quot;!=&quot; value = Time in seconds the user has been in your app. Example: &quot;3600&quot; [optional]
amountSpent String relation = &quot;>&quot;, &quot;<&quot;, or &quot;=&quot; value = Amount in USD a user has spent on IAP (In App Purchases). Example: &quot;0.99&quot; [optional]
boughtSku String relation = &quot;>&quot;, &quot;<&quot; or &quot;=&quot; key = SKU purchased in your app as an IAP (In App Purchases). Example: &quot;com.domain.100coinpack&quot; value = value of SKU to compare to. Example: &quot;0.99&quot; [optional]
tag String relation = &quot;>&quot;, &quot;<&quot;, &quot;=&quot;, &quot;!=&quot;, &quot;exists&quot;, &quot;not_exists&quot;, &quot;time_elapsed_gt&quot; (paid plan only) or &quot;time_elapsed_lt&quot; (paid plan only) See Time Operators key = Tag key to compare. value = Tag value to compare. Not required for &quot;exists&quot; or &quot;not_exists&quot;. Example: See Formatting Filters [optional]
language String relation = &quot;=&quot; or &quot;!=&quot; value = 2 character language code. Example: &quot;en&quot;. For a list of all language codes see Language & Localization. [optional]
appVersion String relation = &quot;>&quot;, &quot;<&quot;, &quot;=&quot; or &quot;!=&quot; value = app version. Example: &quot;1.0.0&quot; [optional]
location String radius = in meters lat = latitude long = longitude [optional]
email String value = email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter [optional]
country String relation = &quot;=&quot; value = 2-digit Country code Example: &quot;field&quot;: &quot;country&quot;, &quot;relation&quot;: &quot;=&quot;, &quot;value&quot;, &quot;US&quot; [optional]
includePlayerIds List<String> Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: [&quot;1dd608f2-c6a1-11e3-851d-000c2940e62c&quot;] Limit of 2,000 entries per REST API call [optional]
includeExternalUserIds List<String> Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: [&quot;custom-id-assigned-by-api&quot;] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms. [optional]
includeEmailTokens List<String> Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: [email protected] Limit of 2,000 entries per REST API call [optional]
includePhoneNumbers List<String> Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call [optional]
includeIosTokens List<String> Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203... Limit of 2,000 entries per REST API call [optional]
includeWpWnsUris List<String> Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: http://s.notify.live.net/u/1/bn1/HmQAAACPaLDr-... Limit of 2,000 entries per REST API call [optional]
includeAmazonRegIds List<String> Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV... Limit of 2,000 entries per REST API call [optional]
includeChromeRegIds List<String> Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call [optional]
includeChromeWebRegIds List<String> Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call [optional]
includeAndroidRegIds List<String> Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_... Limit of 2,000 entries per REST API call [optional]