Skip to main content

GET/ad_campaign/{campaign_id}/keyword/{keyword_id}

Note: This is a Limited ReleaseLimited Release API service that is available only to select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program. For details about how to request access to this program, see Promoted Listings Advanced Access Requests in the Promoted Listings Playbook.
This method retrieves details on a specific keyword from an ad group within a PLA campaign that uses the Cost Per Click (CPC) funding model.

In the request, specify the campaign_id and keyword_id as path parameters.

Call the getCampaigns method to retrieve a list of current campaign IDs for a seller and call the getKeywords method to retrieve their keyword IDs.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/{campaign_id}/keyword/{keyword_id}

URI parameters

ParameterTypeDescription
campaign_idstringA 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

keyword_idstringThis path parameter is used to identify the keyword to retrieve.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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/fieldTypeDescription
adGroupIdstring

This field identifies the ad group that the keyword is associated with.

Occurrence: Always

bidAmount

The bid associated with the keyword. This container will not be returned if the keyword does not have a defined bid value.

Occurrence: Conditional

bid.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

bid.valuestring

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

keywordIdstring

The unique identifier of a keyword.

Occurrence: Always

keywordStatusKeywordStatusEnum

The status of the keyword.

Valid Values:

  • ACTIVE
  • PAUSED
  • ARCHIVED

Occurrence: Always

keywordTextstring

The text of the keyword.

Occurrence: Always

matchTypeMatchTypeEnum

A field that defines the match type for the keyword.

Note: Broad matching of keywords is currently only supported in the AU marketplace.
Valid Values:

  • BROAD
  • EXACT
  • PHRASE

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.

StatusMeaning
200Success
404Not Found
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35002API_MARKETINGAPPLICATIONInternal error. Please wait a few minutes and try the call again.
35045API_MARKETINGREQUESTNo campaign found for campaign id {campaign_id}.
36310API_MARKETINGREQUESTNo keyword found for keyword id {keyword_id}.

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 Keyword Details

This example retrieves the details for a specific keyword from an ad group within a Promoted Listings Advanced (PLA) campaign.

Input

The inputs for this sample are the campaign_id of the PLA ad campaign with which the keyword is associated, as well as the keyword_id of the keyword for which the details shall be retrieved.

GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/1********4/keyword/1********9

Output

If the call is successful, the details for the specified keyword are returned.