GET /ad_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.

Servers

https://api.ebay.com{basePath}

Query parameters

Name	Type	Required	Description
`start_date_range`	String	No	Specifies the range of a campaign's start date in which to filter the results. The results are filtered to include only campaigns with a start date that is equal to this date or is within specified range. Valid format (UTC): `yyyy-MM-ddThh:mm:ssZ..yyyy-MM-ddThh:mm:ssZ` (starts within this range) `yyyy-MM-ddThh:mm:ssZ` (campaign starts on or after this date) `..yyyy-MM-ddThh:mm:ssZ` (campaign starts on or before this date) `2016-09-08T00:00.00.000Z..2016-09-09T00:00:00Z` (campaign starts on September 08, 2016) Note: The results might not include all the campaigns with this start date if other filters exclude them.
`campaign_status`	String	No	Include this filter and input a specific campaign status to retrieve campaigns currently in that state. Note: The results might not include all the campaigns with this status if other filters exclude them. Valid values: See CampaignStatusEnum Maximum: 1 status
`limit`	String	No	Specifies the maximum number of campaigns to return on a page in the paginated response. Default: 10 Maximum: 500
`campaign_name`	String	No	Specifies the campaign name. The results are filtered to include only the campaign by the specified name. Note: The results might be null if other filters exclude the campaign with this name. Maximum: 1 campaign name
`end_date_range`	String	No	Specifies the range of a campaign's end date. The results are filtered to include only campaigns with an end date that is within specified range. Valid format (UTC): `yyyy-MM-ddThh:mm:ssZ..yyyy-MM-ddThh:mm:ssZ` (campaign ends within this range) `yyyy-MM-ddThh:mm:ssZ..` (campaign ends on or after this date) `..yyyy-MM-ddThh:mm:ssZ` (campaign ends on or before this date) `2016-09-08T00:00.00.000Z..2016-09-09T00:00:00Z` (campaign ends on September 08, 2016) Note: The results might not include all the campaigns ending on this date if other filters exclude them.
`funding_strategy`	String	No	Specifies the funding strategy for the campaign. The results will be filtered to only include campaigns with the specified funding model. If not specified, all campaigns matching the other filter parameters will be returned. The results might not include these campaigns if other search conditions exclude them. Valid Values: `COST_PER_SALE` `COST_PER_CLICK`
`offset`	String	No	Specifies the number of campaigns 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 `0` and a limit of `10`, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is `10` and limit is `20`, the first page of the response contains items 11-30 from the complete result set. 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.