Audience and Segmentation
Segments
Examples can be found in the segments documentation here.
- class urbanairship.devices.segment.Segment
- create(airship: urbanairship.core.Airship) requests.models.Response
Create a Segment object and return it.
- classmethod from_id(airship: urbanairship.core.Airship, seg_id: str)
Retrieve a segment based on the provided ID.
- update(airship: urbanairship.core.Airship) requests.models.Response
Updates the segment associated with data in the current object.
Segment Listing
Segment lists are fetched by instantiating an iterator object
using SegmentList.
- class urbanairship.devices.segment.SegmentList(airship: urbanairship.core.Airship, limit: Optional[int] = None)
Retrieves a list of segments
- Parameters
limit – Number of segments to fetch
Named User
A Named User is a proprietary identifier that maps customer-chosen IDs, e.g., CRM data, to Channels. It is useful to think of a Named User as an individual consumer who might have more than one mobile device registered with your app.
Examples can be found in the named users documentation here.
- class urbanairship.devices.named_users.NamedUser(airship: urbanairship.core.Airship, named_user_id: Optional[str] = None)
Perform various operations on a named user object
- Parameters
airship – Required. An instance of urbanairship.Airship.
- associate(channel_id: str, device_type: Optional[str] = None) requests.models.Response
Associate a channel_id with a named user ID. Either channel_id and device_type OR email_address must be included.
- Parameters
channel_id – Required. The ID of the channel you would like to associate with the named user
device_type – The device type of the channel, do not include for web notify channel_ids
- Returns
- email_associate(email_address: str) requests.models.Response
Associate an email_address with a named user id. This call is for a literal email address.
- Parameters
email_address – Required. The email address to associate.
- Returns
- disassociate(channel_id: str, device_type: Optional[str] = None) requests.models.Response
Disassociate a channel with a named user ID
- Parameters
channel_id – The ID of the channel you would like to disassociate
device_type – The device type of the channel. Do not include for web notify channels.
- Returns
- email_disassociate(email_address: str) requests.models.Response
Disassociate an email_address with a named user ID
- Parameters
channel_id – The email_address you would like to disassociate
- Returns
- lookup() Union[Dict, str]
Lookup a single named user
- Returns
The named user payload for the named user ID
- tag(group: str, add: Optional[List] = None, remove: Optional[List] = None, set: Optional[List] = None) Dict
Add, remove, or set tags on a named user.
- Parameters
add – A list of tags to add
remove – A list of tags to remove
set – A list of tags to set
group – The Tag group for the add, remove, and set operations
- update(associate: Optional[List] = None, disassociate: Optional[List] = None, tags: Optional[Dict] = None, attributes: Optional[List] = None) requests.models.Response
Create or update a named user by associating/disassociating channels and adding/removing tags and attributes in a single request.
If a channel has an assigned named user and you make an additional call to associate that same channel with a new named user, the original named user association will be removed and the new named user and associated data will take its place. Additionally, all tags associated to the original named user cannot be used to address this channel unless they are also associated with the new named user.
Please see https://docs.airship.com/api/ua/#operation-api-named_users-named_user_id-post
- Parameters
assocaite – Optional. List of objects to associate with the named user
disassociate – Optional. List of objects to disassociate from the named user
tags – Optional. Dictionary of set, add, remove objects to apply to named user
attributes – Optional. List of attributes to apply to named user.
- Returns
- attributes(attributes: Optional[List]) requests.models.Response
Set or remove attributes on a named user. A single request body may contain a set or remove field, or both, or a single set field. If both set and remove fields are present and the intersection of the attributes in these fields is not empty, then a 400 will be returned. If an attribute request is partially valid, i.e. at least one attribute exists, Airship returns a 200 with a warning in containing a list of attributes that failed to update. Please see https://docs.airship.com/api/ua/#operation-api-named_users-named_user_id-attributes-post for more about using Airship attributes.
- Params attributes
Required. A list of attribute objects to set or remove on the named user.
- classmethod uninstall(airship: urbanairship.core.Airship, named_users: List[str]) requests.models.Response
Disassociate and delete all channels associated with the named_user_id(s) and also delete the named_user_id(s). This call removes all channels associated with a named user from Airship systems in compliance with data privacy laws. Uninstalling channels also removes accompanying analytic data (including Performance Analytics) from the system. Channel uninstallation, like channel creation, is an asynchronous operation, and may take some time to complete.
- Parameters
airship – Required. An urbanairship.Airship instance.
named_users – Required a list of named_user_ids to completely uninstall
- Returns
- classmethod from_payload(payload: Dict)
Create NamedUser object based on results from a NamedUserList iterator.
- Parameters
payload – Payload used to create the NamedUser object
Named User List
- class urbanairship.devices.named_users.NamedUserList(airship: urbanairship.core.Airship)
Retrieves a list of NamedUsers
Attributes
Define and manage attributes.
Examples can be found in the attributes documentation here.
- class urbanairship.devices.attributes.Attribute(action: str, key: str, value: Optional[Union[str, int]] = None, timestamp: Optional[datetime.datetime] = None)
Creates an attribute object for use with the ModifyAttributes class to set or remove attributes from channel_ids and named_user_ids.
- Parameters
action – [required] The action that will be taken with the supplied attributes. Must be one of ‘set’ or ‘remove’.
key – [required] The attribute key to be set.
value – [required] a string or int. If action is ‘set’, the value to set on the key.
timestamp – [optional] a datetime.datetime object representing the time the attribute was modified. If not included, the time of modification call will be used.
- class urbanairship.devices.attributes.ModifyAttributes(airship: urbanairship.core.Airship, attributes: List[urbanairship.devices.attributes.Attribute], channel: Optional[str] = None, named_user: Optional[str] = None)
Set or remove attributes on a channel. Aside from Airship’s default attributes, you must define attributes in the Airship dashboard before you can set them on channels. A single channel_id or named_user must be included.
- Parameters
airship – required. An Airship object.
attributes – required. A list of one or more Attributes objects.
channel – optional. An existing UUID formatted channel_id
named_user – optional. An existing named_user_id
- send() urbanairship.devices.attributes.AttributeResponse
Makes the call to Airship APIs to modify the channel_id or named_user passed on init.
- Returns
AttributeResponse object
Lists
Create and manage audience lists.
Attribute Lists
Examples can be found in the attributes documentation here.
- class urbanairship.devices.attributes.AttributeList(airship: urbanairship.core.Airship, list_name: str, description: str, extra: Optional[Dict[str, str]] = None)
Define and manage attribute lists; upload corresponding attribute data in CSV format.
- Parameters
airship – Required. An unbanairship.Airship instance.
list_name – Required. The name of your list. Must be prefixed with
ua_attributes_description – Required. A description of your list.
extra – Optional. An optional dict of up to 100 key-value (string-to-string) pairs associated with the list.
- create() requests.models.Response
Create the Attribute List
- upload(file_path: str) requests.models.Response
Upload a CSV that will set attribute values on the specified channels or named users. Please see the documentation at https://docs.airship.com/api/ua/#operation-api-attribute-lists-list_name-csv-put for details about list formatting, size limits, and error responses.
- Parameters
file_path – Required. Local path to the csv file to be uploaded.
- get_errors() requests.models.Response
Returns csv of attribute list processing errors. During processing, after a list is uploaded, errors can occur. Depending on the type of list processing, an error file may be created, showing a user exactly what went wrong.
- classmethod list(airship: urbanairship.core.Airship) requests.models.Response
Lists existing attribute lists.
- Parameters
airship – An urbanairship.Airship instance.
Subscription Lists
Examples can be found in the subscription lists documentation here.
- class urbanairship.devices.subscription_lists.SubscriptionList(airship: urbanairship.core.Airship, list_id: str)
Subscribe or unsubscribe channels to/from Subscription lists. These lists must be created in the Airship web dashboard prior to making these calls. The value for list_id can be found after creating these lists.
- Parameters
airship – Required. An urbanairship.Airship instance.
list_id – Required. The list_id from the Airship web dashboard.
- unsubscribe(audience: Dict) requests.models.Response
Unsubscribe an audience from a subscription list.
- Parameters
audience – Required. A single audience selector (ex: urbanairship.ios_channel) to unsubscribe.
- subscribe(audience: Dict) requests.models.Response
Subscribe an audience from a subscription list.
- Parameters
list_id – Required. The list_id from the Airship web dashboard.
audience – Required. A single audience selector (ex: urbanairship.ios_channel) to subscribe.
Static Lists
Examples can be found in the static lists documentation here.
- class urbanairship.devices.static_lists.StaticList(airship: urbanairship.core.Airship, name: str)
- create() Dict
Create a Static List
- upload(csv_file: _io.TextIOWrapper) Dict
Upload a CSV file to a static list
- Parameters
csv_file – open file descriptor with two column format: identifier_type, identifier
- Returns
http response
- update() Dict
Update the metadata in a static list
- Returns
http response
- classmethod download(airship: urbanairship.core.Airship, list_name: str) requests.models.Response
Allows you to download the contents of a static list. Alias and named_user values are resolved to channels.
- Parameters
airship – Required. An urbanairship.Airship instance.
list_name – Required. Name of an existing list to download.
- Returns
csv list data
- lookup()
Get Information about the static list
- Returns
urbanairship.StaticList objects
- delete() requests.models.Response
Delete the static list
- class urbanairship.devices.static_lists.StaticLists(airship)
Gets an iterable listing of existing static lists