Purpose of Feature

This function is designed to deliver Airbridge’s two types of raw logs to client company via AWS S3.

  1. Web Event: Events generated from Web SDK
  2. App Event: Events generated from App SDK
  3. Tracking Link Event: Impression or Click Events generated from Ad Channels

Once transmitted, this data will be directly processed by client company into meaningful forms through batch analysis.

How to Integrate AWS S3

Step 1 - Sign-in and create a bucket (S3)

  1. Sign in AWS S3
  2. Click ‘+create bucket’ and make a new button
  3. There is no additional values to be added for properties and permissions

STEP 2 - Create Policy (IAM)

  1. On AWS IAM, click ‘Policy’ from bulletin board on the left.
  2. Click ‘Create Policy’, and using the bucket name you created, enter the following template to JSON item.
  3. Select ‘Review Policy’ and complete creating policy.
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::test-airbridge" // modify test-airbridge part as the name of created bucket in STEP 1
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:DeleteObject"
            ],
            "Resource": [
                "arn:aws:s3:::test-airbridge/*" // modify test-airbridge part as the name of created bucket in STEP 1
            ]
        }
    ]
}

Step 3 - Add User and Link with Policy Created (IAM)

  1. On AWS IAM, click ‘User’ from bulletin board on the left.
  2. Select ‘Add User’, check ‘Programming Method Access’ from ‘Select AWS Access Type’, and click ‘Next: Permission’.
  3. Click ‘Directly Link to Previous Policy’, select created policy from Step 2, and click ‘Next: Review’.
  4. Bring ‘Access Key ID’ and ‘Secret Access Key’ as you complete to add User (Secret Access Key can be only viewed when ‘Show’ is enabled).
Access Key Type Description Example
AWS_ACCESS_KEY_ID AWS Access Key ID offered to Airbridge CVAGZUZYPUTPHGXSXJGW
AWS_SECRET_ACCESS_KEY AWS Secret Key offered to Airbridge XWzquDaznQDZieXPNnjimjNzhxnCVp

STEP 4 - Add to Airbridge Dashboard

  1. On Airbridge Dashboard, go to ‘Third-Party Integration - AWS S3’
  2. Submit the information received thus far: < (1) Access Key ID, (2) Secret Key, (3) Region, (4) Bucket Name >

Region information must be equally mapped to what was assigned when bucket was created. The Mapping Information can be checked from AWS Docs.

Name Description Example
REGION AWS Region for use ap-northeast-1
BUCKET_NAME Bucket name for use your-bucket-name

When you complete the integration settings, raw data will be dumped to the locations below and the file format would be .csv.gz.

  1. Web Event: ${YOUR-BUCKET-NAME}/${YOUR-APP-NAME}/web/${VERSION}/date=${year}-${month}-${day}/
  2. App Event: ${YOUR-BUCKET-NAME}/${YOUR-APP-NAME}/app/${VERSION}/date=${year}-${month}-${day}/
  3. Tracking Link Event: ${YOUR-BUCKET-NAME}/${YOUR-APP-NAME}/tracking-link/${VERSION}/date=${year}-${month}-${day}/

Data Spec

Data Spec for each event sources are shown on this link. Column Name column would be used as a csv header.