Skip to main content

Adobe Audience Manager API Python Extension

Project description

Adobe Audience Manager - Python Extension

This is a Python wrapper for the Adobe Audience Manager API.

To get started Generate a JWT Authentication using Adobe IO

This package requires you to create a .json document with the following credential details: client ID, client secret, tech account ID, and organization ID. In a separate file, you also need generate a public/private key pair.

credentials.json:

{
    "client_id":"...",
    "client_secret": "...",
    "tech_acct_id": "...",
    "org_id": "..."
}

Once you have these documents, you can get install the package and login:

Terminal:

pip install adobe_aam

Python:

import adobe_aam as aam
aam.Login('path/to/credentials.json', 'path/to/private.key')

Your authentication token should be tied to a Product Profile, which controls the actions you can execute and the objects on which you can act. If you are unable to perform an action supported by this package, the error is likely due to a permissions issue within the credentials setup.

Here are some examples:

Python:

# Get traits by folder and sort
aam.Traits.get_many(folderId=12345, sortBy='createTime', descending=True)

# Get trait by sid
aam.Traits.get_one(sid=12345)

# Get traits by integration code and simplify resulting dataframe
aam.Traits.get_many(ic='code', condense=True)

# Get trait limits of account
aam.Traits.get_limits()

# Create traits from csv
aam.Traits.create_from_csv('path/to/traits_to_create.csv')

If you're new to Python and want to output the results of an AAM API call, you can try something like the following:

Python:

import pandas as pd
output = aam.Traits.get_one(sid=12345)
output.to_csv('path/to/your_aam_output.csv')

Coverage:

Every standard API call for AAM can be found on Swagger

Endpoint Action Coverage
Traits Create x
Traits Get x
Traits Update x
Traits Delete x
Segments Create -
Segments Get -
Segments Update -
Segments Delete -
Destinations Create -
Destinations Get -
Destinations Update -
Destinations Delete -
Derived Signals Create -
Derived Signals Get -
Derived Signals Update -
Derived Signals Delete -
Datasources Create -
Datasources Get -
Datasources Update -
Datasources Delete -
Trait Folder Create -
Trait Folder Get -
Trait Folder Update -
Trait Folder Delete -
Segment Folder Create -
Segment Folder Get -
Segment Folder Update -
Segment Folder Delete -

Custom reporting will be added according to roadmap. Examples:

# Get traits trends for all SIDs in a folder
aam.Reports.traits_trend(startDate="2021-02-21",
                         endDate="2021-02-23",
                         folderId=12345)

# Get traits trends for one SID
aam.Reports.traits_trend(startDate="2021-02-21",
                         endDate="2021-02-23",
                         sid=[12345])

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

adobe_aam-0.0.6.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adobe_aam-0.0.6-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file adobe_aam-0.0.6.tar.gz.

File metadata

  • Download URL: adobe_aam-0.0.6.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.2

File hashes

Hashes for adobe_aam-0.0.6.tar.gz
Algorithm Hash digest
SHA256 809fdd25443a9bd7aa402771278af85273c5b5ae8ac0f37a28789551c06b7338
MD5 fca735da1ad47107cb82ec2d56dd57c2
BLAKE2b-256 4f96e41b67ea668edb12cfdd455ad85406a56a2b776b737d501fe57e14ba83f8

See more details on using hashes here.

File details

Details for the file adobe_aam-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: adobe_aam-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.2

File hashes

Hashes for adobe_aam-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 090d4723cfecc65d617a5127fe8c086966a8951c6f461fc91de3d08fb4ca977c
MD5 7fce0d850e7c6a39e8faa8a466a8a694
BLAKE2b-256 87b81ebc5828e2c9f748bab3f2a015d0d39d0f0620664d57e6a2741839219dec

See more details on using hashes here.

Supported by

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