GET /ad_campaign/{campaign_id}/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 can be used to retrieve all of the keywords for ad groups in PLA campaigns that use the Cost Per Click (CPC) funding model.
In the request, specify the campaign_id as a path parameter. If one or more ad_group_ids are passed in the request body, the keywords for those ad groups will be returned. If ad_group_ids are not passed in the response body, the call will return all the keywords in the campaign.
Call the getCampaigns method to retrieve a list of current campaign IDs for a 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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyword_status |
String | No |
A comma-separated list of keyword statuses. The results will be filtered to only include the given statuses of the keyword. If none are provided, all keywords are returned. |
limit |
String | No |
Specifies the maximum number of results to return on a page in the paginated response. Default: 10Maximum: 500 |
ad_group_ids |
String | No |
A comma-separated list of ad group IDs. This query parameter is used if the seller wants to retrieve keywords from one or more specific ad groups. If this query parameter is not used, all keywords that are part of the CPC campaign are returned.Note:You can call the getAdGroups method to retrieve the ad group IDs for a seller. |
offset |
String | No |
Specifies the number of results to skip in the result set before returning the first report in the paginated response. Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of Default: 0 |
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.