Helper Endpoints
Updated
Endpoint: POST /paid/resource/user/accounts
Request Body:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
destinationType | Enum | The type of destination associated with the ad or request. |
adObjective | Enum | The objective of the advertisement campaign. |
start | Long | The starting index for pagination. |
limit | Long | The maximum number of results to retrieve. |
userAction | Enum | The action performed by the user. [PUBLISH] |
keyword | String | The keyword used for filtering or searching. |
permissions | Set | The set of permissions associated with the user. |
Connection Objects
Endpoint: POST /paid/resource/connectionObjects
Request Body:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
boardId | String | The board identifier for pinterest. |
connectionObjectType | Enum | The type of connection object. |
socialPageAccountUserId | String | The social page account user ID. |
activeOnly | Boolean | Whether to filter only active objects. |
Audience Metadata
Endpoint: POST /paid/resource/audience/metadata
Request Body:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
adObjective | Enum | The advertising objective. |
destinationType | String | The destination type of adset |
adCategories | List | Categories related to PI. |
adCategoriesCountries | List | Countries associated with ad categories. |
isPulseCampaign | Boolean | Whether the campaign is Pulse-based. |
buyingType | String | The type of ad buying process. |
additionalFields | Map<String, String> | Additional metadata fields. |
Audience Target Field Search
Endpoint: POST /paid/resource/audience/values
Request Body:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
keyword | String | Search keyword for audience targeting. |
type | Enum | The targeting field type. |
list | Boolean | Whether to return a list. |
excluded | Boolean | Whether to exclude results. |
limit | Integer | The maximum number of results to return. |
offset | Integer | The offset for pagination. |
targeting | TargetingRequest | Targeting criteria. |
forSegmentAssetCustomization | Boolean | Whether the search is for segment asset customization. |
alwaysEnableOptions | Boolean | Whether to always enable options. |
exclusionMode | Boolean | Whether to enable exclusion mode. |
extraParams | Map<String, String> | Additional parameters. |
Default Ad Placements
Endpoint: POST /paid/resource/default/placements
Request Body:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
adObjective | Enum | The advertising objective. |
adBuyingType | Enum | The type of ad buying process (default: AUCTION). |
destinationType | Enum | The destination type. |
optimizationGoal | Enum | The optimization goal. |
Funding Instruments
Endpoint: GET /paid/resource/fundingInstruments
Query Parameters:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
fetchExpiredToo | Boolean | Whether to include expired instruments. |
Product Catalogs
Endpoint: GET /paid/resource/productCatalogForAdAccount?accountUserId=<>&start=<>&limit=<>&keyword=<>
Query Parameters:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
start | Integer | The starting index for pagination (default: 0). |
limit | Integer | The maximum number of results to retrieve (default: 20). |
keyword | String | Keyword filter for searching catalogs. |
Product Sets
Endpoint: GET /paid/resource/productSets/{catalogChannelId}
Path Parameters:
Field Name | Field Type | Description |
catalogChannelId | String | The catalog channel identifier. |
Instagram Accounts
Endpoint: POST /paid/resource/instagram/accounts
Request Body:
Field Name | Field Type | Description |
accountUserId | String | Ad account Account account User Id |
pageId | String | Page Account accountUserId |
Conversion Pixels
Endpoint: POST /paid/resource/pixelsByFilter
Request Body:
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the accountUserId. |
pixelTypes | Set | The types of pixels requested. |
start | Long | The starting index for pagination. |
rows | Long | The number of rows to retrieve. |
searchStr | String | The search string for filtering. |
includeArchived | Boolean | Whether to include archived pixels. |
additional | Map<String, String> | Additional parameters. |
POST /paid/resource/customEventTypes
Description: Retrieves custom event types for pixels.
Request Body
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
pixelId | String | The unique identifier of the pixel.Chanel Id of Pixel |
adObjective | Enum | The objective of the advertisement campaign. |
destinationType | Enum | The type of destination associated with the ad |
smartPromotionType | Enum | The type of smart promotion used. |
GET /paid/resource/supportedStoreTypes
Description: Retrieves supported store types based on ad objective and channel type.
Query Parameters
Field Name | Field Type | Description |
adObjective | Enum | The objective of the advertisement campaign. |
channelType | Enum | The type of channel |
POST /paid/resource/appInfos/{accountId}
Description: Retrieves app information for a given account.
Request Body
Field Name | Field Type | Description |
accountUserId | String | The unique identifier of the account user. |
adObjective | Enum | The objective of the advertisement campaign. |
channelType | Enum | The type of channel . |
adBuyingType | Enum | The type of ad buying strategy (default: AUCTION). |
storeType | String | The type of app store |
isIOS14Campaign | Boolean | Indicates if the campaign is targeted for iOS 14. |
POST /paid/resource/supported/cta
Description: Retrieves supported call-to-action (CTA) options.
Request Body
Field Name | Field Type | Description |
accountUserId | String | accountUserId of Ad Account |
channelType | Enum | The type of channel used. |
objective | Enum | The objective of the advertisement campaign. |
postTypes | List | The types of posts applicable. |
creativeType | Enum | The type of creative used in the ad. |
adPlacementDetail | Enum | Placement details of the advertisement. |
dynamicAdVoiceType | Enum | The type of voice used in dynamic ads. |
destinationType | Enum | The type of destination associated with the ad. |
optimizationType | Enum | The type of optimization applied. |
buyingType | Enum | The type of ad buying strategy. |
Dimension Call
POST /lookup/byDimensions
Description: Performs a generic lookup based on specified dimensions and filters.
Code Ref : com.spr.api2_0.rest.LookupApi#lookupForDimensions
Request Body (DimensionsLookupDTO)
Field Name | Field Type | Description |
filters | List<ExternalFilter> | Optional filters to narrow down lookup results. |
dimensionLookups | List<DimensionLookupDTO> | List of dimension lookup queries with pagination and additional parameters. |
ExternalFilter
Field Name | Field Type | Description |
dimensionName | String | Name of the dimension to filter. |
filterType | String (ENUM) | Type of filter (e.g., IN, EQUALS, CONTAINS). |
values | List<Object> | Values used in the filter. |
details | Map<String, Object> | Extra metadata related to the filter. |
DimensionLookupDTO
Field Name | Field Type | Description |
lookupType | String | Type of dimension lookup (e.g., user, campaign). |
query | String | Search query string. |
page | Page | Pagination information (start index, size). |
additional | Map<String, String> | Extra parameters to customize the lookup. |
Page
Field Name | Field Type | Description |
start | Integer | Starting index for pagination. |
size | Integer | Number of results to fetch. |
Payload
{"dimensionLookups":[{"lookupType":"COUNTRY","query":""}]}