Getting Started: Basic Usage

How to Access

1. Access A2-ADM (Advertising Manager)
   • Default path for A2 CE: http://localhost
   • Default path for A2 Cloud: http://{customer_id}.aiderx.app
2. Log in
   • A2 CE: The default admin account credentials are a2@aiderx.io / password.
   • A2 Cloud: The registered email address is the default admin account, and the password is password.
3. Agree to the privacy policy and click Confirm.

Home Screen

Creating an Account

A2-ADM accounts are categorized into types based on roles and permissions: Admin, Retailer, and Advertiser. For convenience, we will proceed using the Link Account feature from the admin account.

Creating an Advertiser Account

• From the left sidebar, click Admin > Account Management > Advertiser List.
• Click + Add Advertiser Account.
• Enter the advertiser's account information (name, email, password, initial budget).
• Click Add Account.
• If the account appears in the advertiser account list, the creation is complete.

Creating a Retailer Account

• From the left sidebar, click Admin > Account Management > Retailer List.
• Click + Add Retailer Account.
• Enter the retailer's account information (name, email, password, initial budget).
• Click Add Account.
• If the account appears in the retailer account list, the creation is complete.

Creating a Placement

Linking a Retailer Account

• From the left sidebar, click Admin > Account Management > Retailer List.
• Click Link on the right side of the created account.
• The retailer account is activated in the left sidebar.

Creating a Placement

• From the left sidebar, click Advertising > Placements > Placement List.
• Click + New Placement.
• Enter placement information and click Create & Configure.
• Enter detailed placement information and click Save.
• Click the red button next to the account name in the left sidebar to unlink the account.

Creating and Allocating Campaigns and Creatives

Linking an Advertiser Account

• From the left sidebar, click Admin > Account Management > Advertiser List.
• Click Link Account on the right side of the created account.
• The advertiser account is activated in the left sidebar.

Creating a Campaign

• From the left sidebar, click Advertising > Campaigns > Campaign List.
• Click + New Campaign.
• Click Display.
• Enter campaign information and click Create.
• You will be directed to the campaign information screen.

Creating a Creative

• Next to the creative list, click + New Creative.
• Click Banner.
• Enter basic creative information and click Create.
• Enter banner creative information and click Save.
  • For the destination URL, enter 'https://aiderx.io'.
  • Click URL, enter 'https://cdn.prod.website-files.com/668de9e1f25ab5675d87758d/6690cf1bdce95af5e3522c25_a2_logo_800_250.png', and click Fetch.
  • Enter 600 and 180 for the display size.
• Verify the banner is created in the creative list.
• Click Activate to change the creative status.

Requesting Allocation

• Click New Placement Allocation on the right side of the allocation.
• Select a placement.
• Click Select and Detailed Settings.
• Click Save.
• Click Request Publication in the allocation list.

Approving a Campaign Publication

• Link the retailer account and move to the retailer list.
• Click the first placement to go to the detail screen.
• Click the green arrow in the review column to approve.
• Confirm that the campaign status changes to "Published".
• The 'id' value in the placement information is called the tagid and is used as the ID in ad requests.

The ad serving is now ready.

Requesting Ads from A2-SSP (Supply-Side Platform)

You can now request ad creatives from the A2-SSP Endpoint and receive results.

Send a request

$> curl -X POST \
   -H "Content-type: Application/json" \
   http://{base_url}/app/v0/ad/{tagid} \
   -d '{"version": "0.1.0", "user": {"id": "test_user_id"}}'

Check the response‍

If you see output like this, it's working correctly:

{
  "version": "0.1.0",
  "ad": {
    "id": "97a5f9d2-8965-45f1-aa3d-a100508a3785",
    "display": {
      "w": 600,
      "h": 180,
      "banner": {
        "img": "https://cdn.prod.website-files.com/668de9e1f25ab5675d87758d/6690cf1bdce95af5e3522c25_a2_logo_800_250.png",
        "link": {
          "url": "https://aiderx.io",
          "ext": {}
        },
        "ext": {
          "cdn": "url"
        }
      }
    }
  },
  "ext": {
    "ad_log": "ZTk0ZWI0ZWItYjZmZC00ZmVjLWIzOWEtMGY0ZWIyODJiN2NmfDJhNGE4OGNhLTI0M2UtNDUwYy1hYjRlLTMyNjc5NmQ5Y2U0OXw5N2E1ZjlkMi04OTY1LTQ1ZjEtYWEzZC1hMTAwNTA4YTM3ODV8MTg1OWZiZTMtYzBiYy00NDU1LWIyMmItZjkwYzk1MDNhOGUxfGJkNWJmOWMyLTI2MGYtNDJjYS04NzI3LWMyZjJkN2EyNjg5MXx0ZXN0X3VzZXJfaWQ",
    "message": "success"
  }
}

For detailed methods on requesting ads, refer to the documentation For detailed API specifications, refer to A2 API Specification

Sending Adlogs to A2-Event API

Let's learn how to send user-related logs using the A2 Event API.

• The API endpoint is /app/v0/log.

A2 uses collected user logs for ad model training and campaign analysis.

sending ad logs

An ad log is an event that occurs after showing an ad to a user. You need to include the ad_log from the A2-SSP response.

A2 uses the ad_log to distinguish ad-related information.

$> curl -X POST \
   -H "Content-type: Application/json" \
   http://{base_url}/app/v0/log \
   -d '{
         "type": "ad_log",
         "action": "conv",
         "ad_log": "ZTk0ZWI0ZWItYjZmZC00ZmVjLWIzOWEtMGY0ZWIyODJiN2NmfDJhNGE4OGNhLTI0M2UtNDUwYy1hYjRlLTMyNjc5NmQ5Y2U0OXw5N2E1ZjlkMi04OTY1LTQ1ZjEtYWEzZC1hMTAwNTA4YTM3ODV8MTg1OWZiZTMtYzBiYy00NDU1LWIyMmItZjkwYzk1MDNhOGUxfGJkNWJmOWMyLTI2MGYtNDJjYS04NzI3LWMyZjJkN2EyNjg5MXx0ZXN0X3VzZXJfaWQ"
       }'

‍

sending action logs

An action log records various user behaviors such as clicks, impressions, views, purchases, cart additions, searches, etc.

$> curl -X POST \
   -H "Content-type: Application/json" \
   http://{base_url}/app/v0/log \
   -d '{
         "type": "action_log",
         "action": "purchase",
         "user_id": "test_user_u0",
         "item_id": "test_item_i1",
       }'

For detailed API specifications, refer to A2 API Specification

This concludes the A2 Getting Started guide. We hope this guide has helped you set up A2 in your local environment and understand its basic usage. If you have any further questions, please don't hesitate to contact our support team.

Next Steps

To learn more about A2, check out these resources:

1. A2 Architecture Overview - Understand the overall structure of A2 and the role of each component.
2. A2 API Specification - Find detailed specifications for all A2 APIs. Refer to this when you want to use advanced features.

‍