Compliance

The various methods for Compliance are listed below:

Trigger campaign compliance check

Triggers a compliance check for specified ad groups within a retail campaign. Returns a raw JSON string from the compliance service. Requires MediaPlan_View permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/campaignCompliance
Copy

Parameters

Field	Data Type	Requirement	Description
adGroupIds	array of string	Mandatory	List of ad group IDs to run the compliance check on.
adUnitId	integer	Mandatory	The ad unit ID to check.
retailerId	integer	Optional	Retailer ID associated with the campaign.
retailer	string	Optional	Retailer identifier string.
inventoryType	string	Mandatory	Inventory type of the campaign (e.g. `sponsored_products`).

Request Body

JSON
    
 
{  "adGroupIds": ["ag-001", "ag-002"],  "adUnitId": 55,  "retailerId": 101,  "retailer": "amazon",  "inventoryType": "sponsored_products"}
Copy

Response

Returns a raw JSON string from the compliance service.

Request Body

JSON
    
 
{  "status": "success",  "results": [    {      "adGroupId": "ag-001",      "compliant": true,      "issues": []    },    {      "adGroupId": "ag-002",      "compliant": false,      "issues": ["Missing required headline asset"]    }  ]}
Copy

Fetch Compliance Data

Returns configured retailers, compliant retailers, and the latest brand data for the account. Used to populate the compliance setup UI. Requires Ads_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/fetchComplianceData
Copy

Response

Returns a JSON object with three arrays built from publisher site settings, retailer data, and the account's stored brand data.

Field	Data Type	Description
configuredRetailers	array	Retailer objects configured for the publisher. Logo URLs are prefixed with the compliance CDN base URL.
configuredRetailers[].id	integer	Retailer ID.
configuredRetailers[].name	string	Retailer name.
configuredRetailers[].logoURL	string	Absolute URL of the retailer logo.
compliantRetailers	array	Retailers that have standard creative compliance guidelines configured.
compliantRetailers[].retailer	string	Retailer identifier name.
compliantRetailers[].guidelines	object	Compliance guidelines object for the retailer.
brandData	array	Latest brand data record for the advertiser (sorted by `updatedAt` desc, max 1 entry).
brandData[].advertiserId	integer	Advertiser ID.
brandData[].data	object	Stored brand data payload.
brandData[].updatedAt	string	ISO timestamp of the last update.

Request Body

JSON
    
 
{  "configuredRetailers": [    {      "id": 101,      "name": "amazon",      "logoURL": "https://cdn.jivox.com/compliance/logos/amazon.png"    }  ],  "compliantRetailers": [    {      "retailer": "amazon",      "guidelines": {        "maxHeadlineLength": 50,        "requiredAssets": ["headline", "logo", "productImage"]      }    }  ],  "brandData": [    {      "advertiserId": 16696,      "data": {        "brandName": "BrandA",        "primaryColor": "#FF5733"      },      "updatedAt": "2024-05-10T09:30:00Z"    }  ]}
Copy

Last updated on

Was this page helpful?