Create New Ad Group
Create new ad groups within a campaign for an advertiser
URL: POST/api/v1/adGroups
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| name | The name of the ad group | string | Y | Relevant string value representing the ad group |
| status | Specified status of ad group | string | Y | Status values can be:
|
| campaignId | Id of the campaign this ad group belongs to | integer | Y | Unique numeric identifier |
Headers
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM_SEC.AUTH_SIGNATURE | Auth signature as an API key. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
Sample Request
curl -X POST \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/adGroups' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '
{ "name": "AdGroup name", "status":"enabled", "campaignId": 500002 }'
Response
| Element | Description | Type |
|---|---|---|
| code | Possible values of response code:
| string |
| details | Details of the error if value of response code is failure | string |
| adGroupId | ID of the ad group | integer |
Sample Response
[ { "code": "success", "details": "", "adGroupId": 600001 } ]
Updated about 2 months ago