JarCastingCriteo API Transition SDK for Java
Introduction
API Client Libraries can facilitate your use of the Criteo API allowing you to build unique and customized solutions to serve your businesses and clients. These libraries can reduce the amount of code you need to write in order to start accessing Criteo programmatically. They also can help expedite troubleshooting, should you encounter any issues. This Transition SDK will help you migrate from MAPI to Criteo API. We will support it until end of 2021 when we will decommission the /legacy endpoints. After that date we will only support our official versioned Client Libraries available in Q3 2021.
More information: https://developers.criteo.com/marketing-solutions/docs/java-api-client-library
Criteo API Transition Swagger
- API version: 2021-04
Automatically generated by the OpenAPI Generator
Requirements
Building the API client library requires:
- Java 1.8+
- Maven/Gradle
Installation
To install the API client library to your local Maven repository, simply execute:
mvn clean install
or
gradle install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
Maven users
Add this dependency to your project's POM:
<dependency>
<groupId>com.criteo</groupId>
<artifactId>api-transition.java-client</artifactId>
<version>2021-04.0</version>
<scope>compile</scope>
</dependency>
Gradle users
Add this dependency to your project's build file:
compile "com.criteo:api-transition.java-client:2021-04.0"
Others
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/api-transition.java-client-2021-04.0.jartarget/lib/*.jar
Example
Please see src/examples/java/com/criteo/marketing/ for full examples to get a valid token and make a call to the API.
Documentation for API Endpoints
All URIs are relative to https://api.criteo.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AdvertiserApi | apiPortfolioGet | GET /2021-04/advertisers/me | |
| AdvertiserApi | getCategories | GET /legacy/marketing/v1/advertisers/{advertiserId}/categories | Gets all advertiser's categories |
| AdvertiserApi | getCategory | GET /legacy/marketing/v1/advertisers/{advertiserId}/categories/{categoryHashCode} | Gets a specific advertiser's category |
| AnalyticsApi | getAdsetReport | POST /2021-04/statistics/report | |
| AnalyticsApi | getTransactionsReport | POST /2021-04/transactions/report | |
| AudienceApi | createAudience | POST /2021-04/audiences | |
| AudienceApi | deleteIdentifiers | DELETE /2021-04/audiences/{audience-id}/contactlist | |
| AudienceApi | getAudiences | GET /2021-04/audiences | |
| AudienceApi | modifyAudience | PATCH /2021-04/audiences/{audience-id} | |
| AudienceApi | modifyAudienceUsers | PATCH /2021-04/audiences/{audience-id}/contactlist | |
| AudienceApi | removeAudience | DELETE /2021-04/audiences/{audience-id} | |
| CampaignApi | getAdSet | GET /2021-04/marketing-solutions/ad-sets/{adSetId} | |
| CampaignApi | getBids | GET /legacy/marketing/v1/campaigns/bids | Gets a the bids for campaigns and their categories |
| CampaignApi | getCategories | GET /legacy/marketing/v1/campaigns/{campaignId}/categories | Gets categories |
| CampaignApi | getCategory | GET /legacy/marketing/v1/campaigns/{campaignId}/categories/{categoryHashCode} | Gets a specific category |
| CampaignApi | patchAdSets | PATCH /2021-04/marketing-solutions/ad-sets | |
| CampaignApi | searchAdSets | POST /2021-04/marketing-solutions/ad-sets/search | |
| CampaignApi | startAdSets | POST /2021-04/marketing-solutions/ad-sets/start | |
| CampaignApi | stopAdSets | POST /2021-04/marketing-solutions/ad-sets/stop | |
| CampaignApi | updateBids | PUT /legacy/marketing/v1/campaigns/bids | Update bids for campaigns and their categories |
| CategoryApi | getCategories | GET /legacy/marketing/v1/categories | Gets categories |
| CategoryApi | updateCategories | PUT /legacy/marketing/v1/categories | Enables/disables categories |
| OAuthApi | createToken | POST /oauth2/token |
Documentation for Models
- AdSetDeliveryLimitations
- AdSetFrequencyCapping
- AdSetGeoLocation
- AdSetSearchFilter
- AdSetTargeting
- AdSetTargetingRule
- Audience
- AudienceAttributes
- AudienceError
- AudienceNameDescription
- AudienceWarning
- BasicAudienceDefinition
- BidMessage
- CampaignBidChangeRequest
- CampaignBidChangeResponse
- CampaignBidChangeResponseMessageWithDetails
- CampaignBidMessage
- CampaignMessage
- CategoryBidChangeRequest
- CategoryBidMessage
- CategoryMessage
- CategoryUpdateError
- CategoryUpdateInput
- CategoryUpdatesPerCatalog
- CategoryUpdatesPerCatalogError
- CategoryUpdatesPerCatalogErrorMessageWithDetails
- ContactlistAmendment
- ContactlistAmendmentAttributes
- ContactlistAmendmentRequest
- ContactlistOperation
- ContactlistOperationAttributes
- CriteoApiDataOfPortfolioMessage
- CriteoApiError
- CriteoApiWarning
- DeleteAudienceContactListResponse
- DeleteAudienceResponse
- ErrorCodeResponse
- ErrorMessage
- GetAudiencesResponse
- GetPortfolioResponse
- InlineObject
- JwtModel
- ModifyAudienceResponse
- NewAudience
- NewAudienceAttributes
- NewAudienceRequest
- NewAudienceResponse
- NillableAdSetTargetingRule
- NillableDateTime
- NillableDecimal
- OAuth2Error
- PatchAdSet
- PatchAdSetBidding
- PatchAdSetBudget
- PatchAdSetScheduling
- PortfolioMessage
- ProblemDetails
- ReadAdSet
- ReadAdSetBidding
- ReadAdSetBudget
- ReadAdSetSchedule
- ReadModelAdSetId
- ReadModelReadAdSet
- ReplaceAudience
- ReplaceAudienceRequest
- ReplaceAudienceResponse
- RequestAdSetSearch
- RequestsAdSetId
- RequestsPatchAdSet
- ResponseAdSetId
- ResponseReadAdSet
- ResponsesAdSetId
- StatisticsReportQueryMessage
- TransactionsReportQueryDataMessage
- TransactionsReportQueryEntityMessage
- TransactionsReportQueryMessage
- WriteModelAdSetId
- WriteModelPatchAdSet
Recommendation
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.
Disclaimer
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
