SDK Events (Python)

Last update: July 17, 2023

CREATED FOR:

  • Developer

Description

When initializing the SDK, the options["events"] dict is an optional object with event name keys and callback function values. It can be used to subscribe to various events that occur within the SDK. For instance, the client_ready event may be used with a callback function that will be invoked when the SDK is ready for method calls.

When the callback function is called, an event object is passed in. Each event has a type corresponding to the event name, and some events include additional properties with pertinent information.

Events

Event Name (type)DescriptionAdditional Event Properties
client_readyEmitted when the artifact has downloaded and the SDK is ready for get_offers calls. Recommended when usingon-device decisioning method.
artifact_download_succeededEmitted each time a new artifact is downloaded.artifact_payload, artifact_location
artifact_download_failedEmitted each time an artifact fails to download.artifact_location, error

Example

Python

def client_ready_callback():
    # make get_offers requests

def artifact_download_succeeded(event):
    print("The artifact was successfully downloaded from {}".format(event.artifact_location))
    # optionally do something with event.artifact_payload, like persist it

def artifact_download_failed(event):
    print("The artifact failed to download from {} with the following error: {}"
          .format(event.artifact_location, str(event.error)))

client_options = {
    "client": "acmeclient",
    "organization_id": "1234567890@AdobeOrg",
    "events": {
        "client_ready": client_ready_callback,
        "artifact_download_succeeded": artifact_download_succeeded,
        "artifact_download_failed": artifact_download_failed
    }
}
target_client = target_client.create(client_options)
Previous pageSend Notifications (Python)
Next pageAsynchronous Requests (Python)

Target