Catalog PyPI
Back to packageRELEASE DETAILS

0.0.9

PyPI

adobe-aam

Adobe Audience Manager API Python Extension

Published15 Jul 2021
Direct dependencies4
Transitive dependenciesNot calculated

README

Version 0.0.9 documentation

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

EndpointActionCoverage
TraitsCreatex
TraitsGetx
TraitsUpdatex
TraitsDeletex
SegmentsCreatex
SegmentsGetx
SegmentsUpdatex
SegmentsDeletex
Trait FolderGetx
Segment FolderGetx
DestinationsCreate-
DestinationsGet-
DestinationsUpdate-
DestinationsDelete-
Derived SignalsCreate-
Derived SignalsGet-
Derived SignalsUpdate-
Derived SignalsDelete-
DatasourcesCreate-
DatasourcesGet-
DatasourcesUpdate-
DatasourcesDelete-

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])

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 4

Native requirements
4 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
PyJWT
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "",
  "evaluation": "NOT_EVALUATED"
}
PyJWT (>=2.0.1)runtime
cryptography
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "",
  "evaluation": "NOT_EVALUATED"
}
cryptography (>=3.4.4)runtime
requests
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "",
  "evaluation": "NOT_EVALUATED"
}
requests (>=2)runtime
pandas
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": "",
  "evaluation": "NOT_EVALUATED"
}
pandas (>=1.1.5)runtime

Distribution files

2 collected
adobe_aam-0.0.9-py3-none-any.whl

bdist_wheel · 16.91 KB · Python py3

Source file
adobe_aam-0.0.9.tar.gz

sdist · 11.85 KB · Python source

Source file

Repository

PENDING
trevormccormick/adobe_aam_python

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:44 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:0070f8e59b98693203dfbeed3064cbd502a0d20ff6dffb014e51ccc709b7effd

Other collected versions

View all collected versions →