advertiser/group
The group resource allows an advertiser to pull group information, create a new group, update a specific group, and delete a specific group.
GET | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | The id, or comma-separated list of ids, of the group(s) you want to retrieve. If one id is provided, the resource object will be returned. If a comma-separated list of ids are provided, a list of objects will be returned. | * 987 OR 123,456,789 | N/A | No |
name | The name, or comma-separated list of names, to filter group(s) by | * Any generic string | N/A | No |
Response Fields | ||||
Field | Description | Notes | ||
id | Advertiser's group id | |||
name | Advertiser's group name | |||
assigned_publishers | Assigned publishers in advertiser's group |
POST | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
N/A | ||||
Post Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
name | The name given to the group being created | * Any generic string | N/A | Yes |
Response Fields | ||||
Field | Description | Notes | ||
N/A |
PUT | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | The id of the group being updated | * 123 | N/A | Yes |
Put Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
name | The name given to the group being updated | * Any generic string | N/A | Yes |
Response Fields | ||||
Field | Description | Notes | ||
N/A |
DELETE | ||||
---|---|---|---|---|
Request Parameters | ||||
Parameter | Description | Possible Values | Default | Required? |
id | The id of the group being deleted | * 123 | N/A | Yes |
Response Fields | ||||
Field | Description | Notes | ||
N/A |
* Values shown are placeholder values. Please replace with actual data.