This method adds multiple listings that are managed with the Inventory API to an existing Promoted Listings campaign.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) model, bulk ads may be directly created for the listing.

For each listing specified in the request, this method:

• Creates an ad for the listing.
• Sets the bid percentage (also known as the ad rate) for the ads created.
• Associates the ads created with the specified campaign.

This method adds multiple listings to an existing Promoted Listings campaign using listingId values generated by the Trading API or Inventory API, or using values generated by an ad group ID.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, bulk ads may be directly created for the listing.

For each listing ID specified in the request, this method:

• Creates an ad for the listing.
• Sets the bid percentage (also known as the ad rate) for the ad.
• Associates the ad with the specified campaign.

To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API.

You can specify a maximum of 500 listings per call and each campaign can have ads for a maximum of 50,000 items. Be aware when using this call that each variation in a multiple-variation listing creates an individual ad.

For Promoted Listings Advanced (PLA) campaigns using the Cost Per Click (CPC) funding model, an ad group must be created first. If no ad group has been created for the campaign, ads cannot be created.

For the ad group specified in the request, this method associates the ad with the specified ad group.

To create an ad for an ad group, specify the name of the ad group plus the defaultBid for the ad in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Ad groups are generated using the createAdGroup method.

You can specify one or more ad groups per campaign.

Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.

This method works with listings created with the Inventory API.

The method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified campaign. Inventory reference IDs are seller-defined IDs that are used with the Inventory API.

Pass the campaign_id as a path parameter and populate the payload with a list of inventoryReferenceId and inventoryReferenceType pairs that you want to delete.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.

This method works with listing IDs created with either the Trading API or the Inventory API.

The method deletes a set of ads, as specified by a list of listingID values from a Promoted Listings campaign. A listing ID value is generated by eBay when a seller creates a listing with either the Trading API and Inventory API.

Pass the campaign_id as a path parameter and populate the payload with the set of listing IDs that you want to delete.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.

When using the CPC funding model, use the bulkUpdateAdsStatusByListingId method to change the status of ads to ARCHIVED.

This method works with listings created with either the Trading API or the Inventory API.

The method updates the bidPercentage values for a set of ads associated with the specified campaign.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.

This method works with listings created with either the Trading API or the Inventory API.

The method updates the bidPercentage values for a set of ads associated with the specified campaign.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.

Note: This is a Limited 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 works with listings created with either the Trading API or the Inventory API.

This method updates the status of ads in bulk.

Specify the campaign_id you want to update as a URI parameter, and configure the adGroupStatus in the request payload.

Note: This is a Limited 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 works with listings created with either the Trading API or the Inventory API.

The method updates the status of ads in bulk, based on listing ID values.

Specify the campaign_id as a path parameter and supply a set of listing IDs with their updated adStatus values in the request body. An eBay listing ID is generated when a listing is created with the Trading API.

Get the campaign IDs for a seller by calling getCampaigns and call getAds to retrieve a list of seller inventory reference IDs.

This method retrieves Promoted Listings ads that are associated with listings created with either the Trading API or the Inventory API.

The method retrieves ads related to the specified campaign. Specify the Promoted Listings campaign to target with the campaign_id path parameter.

Because of the large number of possible results, you can use query parameters to paginate the result set by specifying a limit, which dictates how many ads to return on each page of the response. You can also specify how many ads to skip in the result set before returning the first result using the offset path parameter.

Call getCampaigns to retrieve the current campaign IDs for the seller.

This method adds a listing to an existing Promoted Listings campaign using a listingId value generated by the Trading API or Inventory API, or using a value generated by an ad group ID.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing.

For the listing ID specified in the request, this method:

• Creates an ad for the listing.
• Sets the bid percentage (also known as the ad rate) for the ad.
• Associates the ad with the specified campaign.

To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ad with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API.

For Promoted Listings Advanced (PLA) campaigns using the Cost Per Click (CPC) funding model, an ad group must be created first. If no ad group has been created for the campaign, an ad cannot be created.

For the ad group specified in the request, this method associates the ad with the specified ad group.

To create an ad for an ad group, specify the name of the ad group in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Ad groups are generated using the createAdGroup method.

You can specify one or more ad groups per campaign.

Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.

This call has no response payload. If the ad is successfully created, a 201 Created HTTP status code and the getAd URI of the ad are returned in the location header.

This method adds a listing that is managed with the Inventory API to an existing Promoted Listings campaign.

For Promoted Listings Standard (PLS) campaigns using the Cost Per Sale (CPS) funding model, an ad may be directly created for the listing.

For each listing specified in the request, this method:

• Creates an ad for the listing.
• Sets the bid percentage (also known as the ad rate) for the ads created.
• Associates the created ad with the specified campaign.

This method retrieves the specified ad from the specified campaign.

In the request, supply the campaign_id and ad_id as path parameters.

Call getCampaigns to retrieve a list of the seller's current campaign IDs and call getAds to retrieve their current ad IDs.

This method removes the specified ad from the specified campaign.

Pass the ID of the ad to delete with the ID of the campaign associated with the ad as path parameters to the call.

Call getCampaigns to get the current list of the seller's campaign IDs.

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.

When using the CPC funding model, use the bulkUpdateAdsStatusByListingId method to change the status of ads to ARCHIVED.

This method works with listings that are managed with the Inventory API.

The method deletes ads using a list of seller-defined inventory reference IDs, used with the Inventory API, that are associated with the specified campaign ID.

Specify the campaign ID (as a path parameter) and a list of inventoryReferenceId and inventoryReferenceType pairs to be deleted.

Call getCampaigns to get a list of the seller's current campaign IDs.

This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API from the specified campaign.

Supply the campaign_id as a path parameter and use query parameters to specify the inventory_reference_id and inventory_reference_type pairs.

In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for an inventory item group, which is an entity that's used in the Inventory API to create a multiple-variation listing). To indicate a listing managed by the Inventory API, you must always specify both an inventory_reference_id and the associated inventory_reference_type.

Call getCampaigns to retrieve all of the seller's the current campaign IDs.

Note: This method only applies to the Cost Per Sale (CPS) funding model; it does not apply to the Cost Per Click (CPC) funding model. See Funding Models in the Promoted Listings Playbook for more information.

This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign.

In the request, supply the campaign_id and ad_id as path parameters, and supply the new bidPercentage value in the payload of the call.

Call getCampaigns to retrieve a seller's current campaign IDs and call getAds to get their ad IDs.

Note: This is a Limited 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 ad groups for the specified campaigns.

Each campaign can only have one ad group.

In the request, supply the campaign_ids as path parameters.

Call getCampaigns to retrieve a list of the current campaign IDs for a seller.

Note: This is a Limited 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 adds an ad group to an existing PLA campaign that uses the Cost Per Click (CPC) funding model.

To create an ad group for a campaign, specify the defaultBid for the ad group in the payload of the request. Then specify the campaign to which the ad group should be associated using the campaign_id path parameter.

Each campaign can have one or more associated ad groups.

Note: This is a Limited 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 the details of a specified ad group, such as the ad group’s default bid and status.

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

Call getCampaigns to retrieve a list of the current campaign IDs for a seller and call getAdGroups for the ad group ID of the ad group you wish to retrieve.

Note: This is a Limited 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 updates the ad group associated with a campaign.

With this method, you can modify the default bid for the ad group, change the state of the ad group, or change the name of the ad group. Pass the ad_group_id you want to update as a URI parameter, and configure the adGroupStatus and defaultBid in the request payload.

Call getAdGroup to retrieve the current default bid and status of the ad group that you would like to update.

Note: This is a Limited 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 allows sellers to retrieve the suggested bids for input keywords and match type.

Note: This is a Limited 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 allows sellers to retrieve a list of keyword ideas to be targeted for Promoted Listings campaigns.

This method clones (makes a copy of) the specified campaign's campaign criterion. The campaign criterion is a container for the fields that define the criteria for a rule-based campaign.

To clone a campaign, supply the campaign_id as a path parameter in your call. There is no request payload.

The ID of the newly-cloned campaign is returned in the Location response header.

Call getCampaigns to retrieve a seller's current campaign IDs.

Requirement: In order to clone a campaign, the campaignStatus must be ENDED and the campaign must define a set of selection rules (it must be a rules-based campaign).

This method retrieves the details for all of the seller's defined campaigns. Request parameters can be used to retrieve a specific campaign, such as the campaign's name, the start and end date, the status, and the funding model (Cost Per Sale (CPS) or Cost Per Click (CPC).

You can filter the result set by a campaign name, end date range, start date range, or campaign status. You can also paginate the records returned from the result set using the limit query parameter, and control which records to return using the offset parameter.

This method creates a Promoted Listings ad campaign.

A Promoted Listings campaign is the structure into which you place the ads or ad group for the listings you want to promote.

Identify the items you want to place into a campaign either by "key" or by "rule" as follows:

• Rules-based campaigns – A rules-based campaign adds items to the campaign according to the criteria you specify in your call to createCampaign. You can set the autoSelectFutureInventory request field to true so that after your campaign launches, eBay will regularly assess your new, revised, or newly-eligible listings to determine whether any should be added or removed from your campaign according to the rules you set. If there are, eBay will add or remove them automatically on a daily basis.
• Key-based campaigns – Add items to an existing campaign using either listing ID values or Inventory Reference values:
  • Add listingId values to an existing campaign by calling either createAdByListingID or bulkCreateAdsByListingId.
  • Add inventoryReference values to an existing campaign by calling either createAdByInventoryReference or bulkCreateAdsByInventoryReference.
  • Add an ad group to an existing campaign by calling createAdGroup.

  Note: No matter how you add items to a Promoted Listings campaign, each campaign can contain ads for a maximum of 50,000 items.
  
  If a rules-based campaign identifies more than 50,000 items, ads are created for only the first 50,000 items identified by the specified criteria, and ads are not created for the remaining items.

  Creating a campaign

  To create a basic campaign, supply:

  • The user-defined campaign name
  • The start date (and optionally the end date) of the campaign
  • The eBay marketplace on which the campaign is hosted
  • Details on the campaign funding model

  The campaign funding model specifies how the Promoted Listings fee is calculated. Currently, the supported funding models are COST_PER_SALE and COST_PER_CLICK. For complete information on how the fee is calculated and when it applies, see Promoted Listings fees.

  If you populate the campaignCriterion object in your createCampaign request, campaign "ads" are created by "rule" for the listings that meet the criteria you specify, and these ads are associated with the newly created campaign.

  For details on creating Promoted Listings campaigns and how to select the items to be included in your campaigns, see Promoted Listings campaign creation.

  For recommendations on which listings are prime for a Promoted Listings ad campaign and to get guidance on how to set the bidPercentage field, see Using the Recommendation API to help configure campaigns.

  Tip: See Promoted Listings requirements and restrictions for the details on the marketplaces that support Promoted Listings via the API. See Promoted Listings restrictions for details about campaign limitations and restrictions.

This method retrieves the details of a single campaign, as specified with the campaign_id query parameter.

This method returns all the details of a campaign (including the campaign's the selection rules), except the for the listing IDs or inventory reference IDs included in the campaign. These IDs are returned by getAds.

Call getCampaigns to retrieve a list of the seller's campaign IDs.