Advertiser / Account Groups

Overview

Create account groups to categorize advertisers by regions, brands, business units, or another category that makes sense to your organization. With advertiser groups, you can save time in the following ways:

  • Filtering information for a group of advertisers
  • Targeting exchanges and deals for groups of advertisers
  • Blacklisting and whitelisting apps and sites for a group
  • Reporting on all the advertisers within a group

Endpoint

https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups

Fields

The Account Group object contains the following fields:

Name Description Type Add Update
id ID of the account group. integer N/A Required
name Name of the account group. text Required Optional
code Short name of the account group. text Required Optional
seatId Seat ID. text Required Optional

Read Account Group (Single)

To retrieve data for a specific Account Group, make a GET call with the id parameter.

GET https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups/{id}
Name Description Type Required?
id Account Group ID integer Y

The response will be the Account Group associated with the given ID.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups/1

Example Response

{
  "response": {
    "id": 1,
    "name": "North America Region",
    "code": "NAR",
    "seatId": 1
  },
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Read Account Groups (Multiple)

To retrieve a list of all Account Groups for the seat, make a GET call without any paramters.

GET https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups

The response will be the list of Account Groups belonging to the seat.

Example Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups

Example Response (Partial)

{
  "response": [
    {
      "id": 2491,
      "name": "TWO_POST_3_PUT_Change2",
      "code": "TestCng",
      "seatId": 2
    },
    {
     "id": 2492,
     "name": "Test_ADGroup2",
     "code": "TestAG2",
     "seatId": 2
    }
  ],
  "errors": null,
  "timeStamp": "2017-04-12T04:49:06Z"
}

Update Account Groups

To update an existing Account Group, make a PUT call with a payload body and id parameter. The response will be the updated Account Group.

Partial update is supported; fields that are either not passed or passed as null will be ignored during update.

PUT https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups/{id}
Name Description Type Required?
id Account Group ID integer Y

Example Request

PUT https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups/16546

Example Payload

{
  "name": "MNX_Changed",
  "code": "MNX2_PUT",
  "seatId": 2
}

Example Response

{
  "response": {
    "id": 16546,
    "name": "MNX_Changed",
    "code": "MNX2_PUT",
    "seatId": 2
  },
  "errors": null,
  "timeStamp": "2017-12-18T19:19:11Z"
}

Create Account Groups

To create a new Account Group, make a POST call with a payload body. The response will be the newly created Account Group.

Note

Code can not be more than 10 characters.

Example Request

POST https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups

Example Payload

{
  "name": "MNX",
  "code": "MNX2",
  "seatId": 2
}

Example Response

{
  "response": {
    "id": 16546,
    "name": "MNX",
    "code": "MNX2",
    "seatId": 2
  },
  "errors": null,
  "timeStamp": "2017-12-18T19:11:06Z"
}