POST /ad_campaign/{campaign_id}/bulk_create_keyword
Note: This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For information about how to request access to this program, refer to Promoted Listings Advanced Access Requests in the Promoted Listings Playbook. To determine if a seller qualifies for PLA, use the getAdvertisingEligibility method in Account API.
This method adds keywords, in bulk, to an existing PLA ad group in a campaign that uses the Cost Per Click (CPC) funding model.
This method also sets the CPC rate for each keyword.
In the request, supply the campaign_id as a path parameter.
Call the getCampaigns method to retrieve a list of current campaign IDs for a specified seller.
Servers
- https://api.ebay.com{basePath}
Path parameters
Name | Type | Required | Description |
---|---|---|---|
campaign_id |
String | Yes |
A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
requests[] |
Array | No |
This array is used to pass in multiple keywords for one or more ad groups that belong to a campaign that uses the Cost Per Click (CPC) funding model. Up to {max value} keywords can be created with one call. |
requests[].keywordText |
String | No |
Input the keyword into this field. |
requests[].bid |
Object | No |
A complex type that describes the value of a monetary amount as represented by a global currency. |
requests[].bid.value |
String | No |
The monetary amount in the specified currency. |
requests[].bid.currency |
String | No |
The base currency applied to the value field to establish a monetary amount. |
requests[].adGroupId |
String | No |
This adGroupId is created when an ad group is first created and associated with a campaign. This is the ad group that the corresponding keyword will be added to. This ad group must be a part of the campaign that is specified in the call URI. |
requests[].matchType |
String | No |
A field that defines the match type for the keyword.
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.