GET api/facebookads/ads

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
AgentId	integer	None.
InputId	string	None.
GeoLocations	string	None.
Price	decimal number	None.
Duration	integer	None.
InsertedDate	date	None.
AdCreatedDate	date	None.
Error	string	None.
Status	integer	None.
Charge_Id	string	None.
CampaignName	string	None.
CampaignId	integer	None.
CreativeId	integer	None.
DateLastActionTaken	date	None.
AdSetId	integer	None.
AdId	integer	None.
Type	AdType	None.
CreativeMessage	string	None.
CreativeDescription	string	None.
CreativeName	string	None.
PageId	string	None.
ProductSetId	integer	None.
IsActive	boolean	None.
CatalogId	integer	None.
AdCategoryId	integer	None.
LeadFormId	integer	None.
EndDate	date	None.
PagePromotionIneligible	boolean	None.
CreativeImageUrl	string	None.
CreativeUrl	string	None.
Title	string	None.
RibbonText	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "AgentId": 2,
  "InputId": "sample string 3",
  "GeoLocations": "sample string 4",
  "Price": 5.0,
  "Duration": 6,
  "InsertedDate": "2024-12-21T15:47:38.5046361+00:00",
  "AdCreatedDate": "2024-12-21T15:47:38.5046361+00:00",
  "Error": "sample string 7",
  "Status": 8,
  "Charge_Id": "sample string 9",
  "CampaignName": "sample string 10",
  "CampaignId": 1,
  "CreativeId": 1,
  "DateLastActionTaken": "2024-12-21T15:47:38.5046361+00:00",
  "AdSetId": 1,
  "AdId": 1,
  "Type": 1,
  "CreativeMessage": "sample string 11",
  "CreativeDescription": "sample string 12",
  "CreativeName": "sample string 13",
  "PageId": "sample string 14",
  "ProductSetId": 1,
  "IsActive": true,
  "CatalogId": 1,
  "AdCategoryId": 1,
  "LeadFormId": 1,
  "EndDate": "2024-12-21T15:47:38.5046361+00:00",
  "PagePromotionIneligible": true,
  "CreativeImageUrl": "sample string 15",
  "CreativeUrl": "sample string 16",
  "Title": "sample string 17",
  "RibbonText": "sample string 18"
}

text/html

Sample:

{"Id":1,"AgentId":2,"InputId":"sample string 3","GeoLocations":"sample string 4","Price":5.0,"Duration":6,"InsertedDate":"2024-12-21T15:47:38.5046361+00:00","AdCreatedDate":"2024-12-21T15:47:38.5046361+00:00","Error":"sample string 7","Status":8,"Charge_Id":"sample string 9","CampaignName":"sample string 10","CampaignId":1,"CreativeId":1,"DateLastActionTaken":"2024-12-21T15:47:38.5046361+00:00","AdSetId":1,"AdId":1,"Type":1,"CreativeMessage":"sample string 11","CreativeDescription":"sample string 12","CreativeName":"sample string 13","PageId":"sample string 14","ProductSetId":1,"IsActive":true,"CatalogId":1,"AdCategoryId":1,"LeadFormId":1,"EndDate":"2024-12-21T15:47:38.5046361+00:00","PagePromotionIneligible":true,"CreativeImageUrl":"sample string 15","CreativeUrl":"sample string 16","Title":"sample string 17","RibbonText":"sample string 18"}

application/xml, text/xml

Sample:

<AgentFacebookAds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
  <AdCategoryId>1</AdCategoryId>
  <AdCreatedDate>2024-12-21T15:47:38.5046361+00:00</AdCreatedDate>
  <AdId>1</AdId>
  <AdSetId>1</AdSetId>
  <AgentId>2</AgentId>
  <CampaignId>1</CampaignId>
  <CampaignName>sample string 10</CampaignName>
  <CatalogId>1</CatalogId>
  <Charge_Id>sample string 9</Charge_Id>
  <CreativeDescription>sample string 12</CreativeDescription>
  <CreativeId>1</CreativeId>
  <CreativeImageUrl>sample string 15</CreativeImageUrl>
  <CreativeMessage>sample string 11</CreativeMessage>
  <CreativeName>sample string 13</CreativeName>
  <CreativeUrl>sample string 16</CreativeUrl>
  <DateLastActionTaken>2024-12-21T15:47:38.5046361+00:00</DateLastActionTaken>
  <Duration>6</Duration>
  <EndDate>2024-12-21T15:47:38.5046361+00:00</EndDate>
  <Error>sample string 7</Error>
  <GeoLocations>sample string 4</GeoLocations>
  <Id>1</Id>
  <InputId>sample string 3</InputId>
  <InsertedDate>2024-12-21T15:47:38.5046361+00:00</InsertedDate>
  <IsActive>true</IsActive>
  <LeadFormId>1</LeadFormId>
  <PageId>sample string 14</PageId>
  <PagePromotionIneligible>true</PagePromotionIneligible>
  <Price>5</Price>
  <ProductSetId>1</ProductSetId>
  <RibbonText>sample string 18</RibbonText>
  <Status>8</Status>
  <Title>sample string 17</Title>
  <Type>Post</Type>
</AgentFacebookAds>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AgentFacebookAds'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.