ACCESSTRADE-Support

Campaign APIs

Get Affiliated Campaigns

• GET /v1/publishers/me/sites/{siteId}/campaigns/affiliated
• V1 Request Signature needed
• Request:
  • query string:
    • siteId required
    • keyword optional
    • categories optional
    • campaignTypes optional
    • campaignApplocations optional
    • customerCountries optional
    • limit `number - required
    • page `number - required
• Response:
  • 200 OK on success

    [
    　　  {
        "categories": [
            {
                "name": "Keuangan",
                "value": 1
            }
        ],
        "highestRewardSummaries" : [
            {"type" : "CPC",
             "reward" : 100,
             "rewardByPublisherCurrency":200,
             "isAllSameRewardAmount": true
            },
            {"type" : "CPA-SALES",
             "reward" : 5,
             "rewardByPublisherCurrency":null,
             "isAllSameRewardAmount": false
            },
        ],
        "id": 307,
        "name": "HSBC Platinum Cash Back",
        "imageUrl": "http://vn-live-g-03.slatic.net/build/components/logo/images/vn.png?v=c5ef782",
        "currency": "IDR",
        "url": "http://cv.profeedr.com/run_tracking.php?mcn={campaign}"
    　　  }
    ]
    

    Get Applied Campaigns

• GET /v1/publishers/me/sites/{siteId}/campaigns/applied
• Publisher API Authentication required
• Request:
  • siteId required
• Response:
  • 200 OK on success

    [
    {
        "appliedDate": "2017-02-02",
        "id": 316,
        "imageUrl": "http://vn-live-g-03.slatic.net/build/components/logo/images/vn.png?v=c5ef782",
        "url": "http://mendekor.com/",
        "name": "Mendekor Furniture",
        "affiliationStatus": "APPLYING",
        "defaultRewards": [
            {
                "type": "CPA_SALES",
                "name": "Individual purchase product",
                "reward": 3.5
            }
        ],
        "categories": [
            {
                "name": "Keuangan",
                "value": 1
            },
            {
                "name": "Kartu Kredit",
                "value": 2
            }
        ]
    }
    ]
    

    Get Rejected Campaigns

• GET /v1/publishers/me/sites/{siteId}/campaigns/rejected
• Publisher API Authentication required
• Request:
  • siteId required
• Response:
  • 200 OK on success

    [
    {
        "rejectedDate": "2017-02-02",
        "id": 316,
        "imageUrl": "http://vn-live-g-03.slatic.net/build/components/logo/images/vn.png?v=c5ef782",
        "url": "http://mendekor.com/",
        "name": "Mendekor Furniture",
        "affiliationStatus": "REJECTED",
        "defaultRewards": [
            {
                "type": "CPA_SALES",
                "name": "Individual purchase product",
                "reward": 3.5
            }
        ],
        "categories": [
            {
                "name": "Keuangan",
                "value": 1
            },
            {
                "name": "Kartu Kredit",
                "value": 2
            }
        ]
    }
    ]
    

    Get Unaffiliated Campaigns

• GET /v1/publishers/me/sites/{siteId}/campaigns/unaffiliated
• Publisher API Authentication required
• Request:
  • siteId required
• Response:
  • 200 OK on success

    {
    "content":[
        {
            "id": 13,
            "imageUrl": "http://vn-live-g-03.slatic.net/build/components/logo/images/vn.png?v=c5ef782",
            "url": "http://zalora.vn",
            "name": "zalora.vn",
            "affiliationStatus": "NEW",
            "defaultRewards": [
                {
                    "type": "CPA_SALES",
                    "reward": "5%"
                },
                {
                    "type": "CPC",
                    "reward": "$100"
                },
            ],
            "categories": [
                {
                    "name": "EC",
                    "value": 3
                },
                {
                    "name": "Hiburan",
                    "value": 18
                }
            ]
        }
    ],
    "pages":{
        "1":"/v1/publishers/me/sites/1/campaigns/unaffiliated?limit=20&page=1",
        "2":"/v1/publishers/me/sites/1/campaigns/unaffiliated?limit=20&page=2"
    }
    }
    

    Request Campaign Affiliation

• POST /v1/campaigns/affiliate
• Publisher API Authentication required
• Request:

  {
    "siteId": 12,
    "campaignIds": [
        13,
        15
    ]
  }
  

• Response:
  • 200 OK on success
  • 202 Accepted if the custom creative is created successfully, but the dynamodb update failed
  • 400 Bad Request if any of the given campaign IDs are invalid

    Get Campaign Details

• GET /v1/campaigns/{campaignId}
• Publisher API Authentication required
• Request:
  • query string:
    • siteId=1 : a publisher site ID required
• Response:
  • 200 OK on success

    {
    "id": 32,
    "name": "campaign",
    "type": "CPA",
    "url": "http://lazada.vn",
    "startDate": "2016-05-01",
    "endDate": "2017-05-01",
    "defaultRewards": [
        {
            "type":"CPA_FIXED",
            "name":"Account opening application",
            "reward":130000.0
        },
        {
            "type":"CPA_SALES",
            "name":"Individual purchase product",
            "reward":5
        },
        {
            "type":"CPC",
            "name":"Click",
            "reward":300.0
        }
    ],
    "categoryRewards": [
        {
            "id": "A",
            "name": "E-COMMERCE",
            "type":"CPA_SALES",
            "reward":5
        },
        {
            "id": "B",
            "name": "Keuangan",
            "type":"CPA_FIXED",
            "reward":130000
        }
    ],
    "categories": [
        {
            "name": "EC",
            "value": 3
        },
        {
            "name": "Hiburan",
            "value": 18
        }
    ],
    "budgetType": "SALES_COUNT",
    "budget": 10000,
    "description": "This is campaign",
    "englishDescription": "This is english campaign",
    "affiliationStatus": "APPROVED"
    }
    

• campaign types:

    CPA,
    CPC,
    CPL,
    CPS
  

• reward types:

    CPC,
    CPA_FIXED,
    CPA_SALES
  

• budgetType:

    SALES_COUNT,
    SALES_REWARD,
    CLICK_COUNT,
    CLICK_REWARD,
    DAILY_SALES_COUNT
  

Get Campaign Status

• GET /v1/publishers/me/campaigns/campaign-status
• Publisher API Authentication required
• Request:
  • query string:
    • campaignId=123 : a campaign ID required
• Response:
• 200 OK on success
• Response body possible values:

  GETTING_READY
  RUNNING
  PAUSED
  TERMINATED
  WONT_RUN
  OTHER