Skip to main content

AppsFlyer S2S events API client

Project description

appsflyer-python

PyPI Maintainability Test Coverage

Documentation

The documentation for AppsFlyer's Server-to-server events API for mobile can be found here.

Installation

Install using pip:

pip install appsflyer

Alternatively, you may download the repository and run the installation directly:

git clone https://github.com/fredericojordan/appsflyer-python.git
cd appsflyer-python
python setup.py install

Getting Started

To start generating events, we need only a Client instance.

The Client needs your AppsFlyer credentials. You can pass these directly to the constructor:

from appsflyer.rest import Client

app_id = "XXXXXXXXXXXXXXXXX"
dev_key = "YYYYYYYYYYYYYYYY"

appsflyer_client = Client(app_id=app_id, dev_key=dev_key)
  • app_id: The app identifier used in the AppsFlyer dashboard. Insert it precisely as it appears on the dashboard.
  • dev_key: The authentication token in the header. To get the dev key, in the AppsFlyer dashboard go to: App Settings > Dev Key

Generating an Event

To generate an event, simply call Client.generate_event() with keyword arguments:

from appsflyer.rest import Client

app_id = "XXXXXXXXXXXXXXXXX"
dev_key = "YYYYYYYYYYYYYYYY"

appsflyer_client = Client(app_id=app_id, dev_key=dev_key)

appsflyer_client.generate_event(
    appsflyer_id="9999999999999-9999999999999999999",
    customer_user_id="example_customer_id_123",
    ip="199.0.2.1",
    app_version_name="example_version_name",
    event_time="2020-02-25 12:00.000",
    event_name="af_purchase",
    event_currency="ZAR",
    event_value={
        "af_revenue": "1006",
        "af_content_type": "wallets",
        "af_content_id": "15854",
        "af_quantity": "1",
    },
)

The parameters event_name, event_value and appsflyer_id are mandatory.

Device Identifiers

Additional data parameters (such as an IDFA or GAID identifiers) may be sent as keyword arguments:

appsflyer_client.generate_event(
    appsflyer_id="9999999999999-9999999999999999999",
    event_name="af_purchase",
    event_value={"af_revenue": "420"},
    idfa="9876F1SS-2983-3855-27RR-2R626772VFNB",
)

AppsFlyer API expects one or more of the following device identifiers:

  • idfa
  • idfv
  • advertising_id (GAID)
  • oaid
  • amazon_aid
  • imei

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

appsflyer-0.1.0.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

appsflyer-0.1.0-py3-none-any.whl (4.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page