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.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| campaign_id | string | A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created. Note: You can retrieve the campaign IDs for a specified seller using the getCampaigns method. Occurrence: Required |
| ad_group_ids | string | 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. Occurrence: Optional |
| keyword_status | string | 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. Occurrence: Optional |
| limit | string | Specifies the maximum number of results to return on a page in the paginated response. Default: 10Maximum: 500 Occurrence: Optional |
| offset | string | 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 Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.marketing.readonly
https://api.ebay.com/oauth/api_scope/sell.marketing
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| href | string | The URI of the current page of results from the result set. Occurrence: Always |
| keywords | array of Keyword | This array contains all of the keywords that match the request criteria. Keywords will be sorted by adGroupId, regardless of whether you searched for keywords across the entire campaign, or if you searched for keywords within one or specific ad groups. Occurrence: Always |
| keywords.adGroupId | string | This field identifies the ad group that the keyword is associated with. Occurrence: Always |
| keywords.bid | Amount | The bid associated with the keyword. This container will not be returned if the keyword does not have a defined bid value. Occurrence: Conditional |
| keywords.bid.currency | CurrencyCodeEnum | The base currency applied to the value field to establish a monetary amount. Occurrence: Conditional |
| keywords.bid.value | string | The monetary amount in the specified currency. Occurrence: Conditional |
| keywords.keywordId | string | The unique identifier of a keyword. Occurrence: Always |
| keywords.keywordStatus | KeywordStatusEnum | The status of the keyword.
Occurrence: Always |
| keywords.keywordText | string | The text of the keyword. Occurrence: Always |
| keywords.matchType | MatchTypeEnum | A field that defines the match type for the keyword.
Occurrence: Always |
| limit | integer | The number of keywords returned on a single page from the result set. This value can be set in the request with the limit query parameter. Occurrence: Always |
| next | string | The call URI that can be used to retrieve the next page in the result set. This value is returned only if there is an additional page of results to display from the result set. Occurrence: Conditional |
| offset | integer | The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of Occurrence: Always |
| prev | string | The call URI that can be used to retrieve the previous page in the result set. Basically, all of the request parameters will remain the same except the offset value, which will be decreased to retrieve the previous page of results. Occurrence: Conditional |
| total | integer | The total number of keywords retrieved in the result set. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 404 | Not Found |
| 409 | Business error |
| 500 | Internal Server error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 35001 | API_MARKETING | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
| 35002 | API_MARKETING | APPLICATION | Internal error. Please wait a few minutes and try the call again. |
| 35029 | API_MARKETING | REQUEST | The 'limit' has to be greater than zero and less than {maxLimitValue}. |
| 35030 | API_MARKETING | REQUEST | The 'offset' cannot be less than zero. |
| 35045 | API_MARKETING | REQUEST | No campaign found for campaign id {campaign_id}. |
| 36314 | API_MARKETING | REQUEST | Ad Group Ids should be delimited by {adGroupIdsDelimiter} |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieve Details for Multiple Keywords
This example retrieves the details for all keywords associated with the specified Promoted Listings Advanced (PLA) campaign.
Input
The input for this sample is the campaign_id of the PLA ad campaign with which the keywords are associated.
GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/keyword
Output
If the call is successful, details for the keywords associated with the specified PLA ad campaign are returned.