- 2 Minutes to read
Account Groups
- 2 Minutes to read
This article describes services you can use to view, create, and update account groups.
Overview
Use account groups to categorize advertisers by regions, brands, business units, or another category that makes sense to your organization.
Account groups save you time in the following ways:
Filtering information for groups of advertisers.
Targeting exchanges and deals for groups of advertisers.
Allow or deny apps and sites for a group.
Reporting on all the advertisers within a group.
Hierarchy
An Account Group
is a seat-level object.
Endpoint
/traffic/accountgroups
Use the following HTTP methods:
Use the
GET
method to view an existing account group.Use the
POST
method to create a new account group.Use the
PUT
method to update an existing account group.
Resources
The Account Group
object contains the following fields:
Field | Description | Data Type | Create | Update |
---|---|---|---|---|
| Specifies the account group ID. |
| N/A | Required |
| Specifies the name of the account group. |
| Required | Optional |
| Specifies the shortname of the account group. Note: The |
| Required | Optional |
| Specifies the seat ID of the account group. Note: Once you assign an account group to a seat, you cannot transfer it to another seat. |
| Required | N/A |
Read Account Group
Get data about an account group.
GET /traffic/accountgroups/{id}
Parameters
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the account group ID. |
| Y |
Sample Request URL
Sample Response
{
"response": {
"id": 1,
"name": "North America Region",
"code": "NAR",
"seatId": 1
},
"errors": null,
"timeStamp": "2017-04-12T04:49:06Z"
}
Read Account Groups
Get a filtered list of account groups belonging to the specified seat.
Parameters
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| query | Specifies the search term. Use URL encoding conventions (i.e. replace spaces with a + or %20). |
| N |
| query | Specifies the column to sort by. |
| N |
| query | Specifies the sort direction. Allowed values:
|
| N |
Sample Request URL
Sample Response
{
"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 Group
Update an existing account group.
PUT /traffic/accountgroups/{id}
Partial updates are supported; values of supported fields that are not in the payload remain unchanged.
Parameters
The Account Group id is specified in the url path. All other fields are specified in the body of the application/json
payload.
Sample Request URL
PUT https://dspapi.admanagerplus.yahoo.com/traffic/accountgroups/16546
Sample Request Body
{
"name": "MNX_Changed",
"code": "MNX2_PUT"
}
Sample Response
{
"response": {
"id": 16546,
"name": "MNX_Changed",
"code": "MNX2_PUT",
"seatId": 2
},
"errors": null,
"timeStamp": "2017-12-18T19:19:11Z"
}
Create Account Group
Create a new account group.
POST /traffic/accountgroups
Parameters
All fields are specified in the body of the application/json
payload.
Sample Request URL
Sample Request Body
{
"name": "MNX",
"code": "MNX2",
"seatId": 2
}
Sample Response
{
"response": {
"id": 16546,
"name": "MNX",
"code": "MNX2",
"seatId": 2
},
"errors": null,
"timeStamp": "2017-12-18T19:11:06Z"
}
Delete Account Group
The DSP Traffic API does not support the deletion of account groups.