This project is deprecated

We've built a new set of SDKs to help you use our Criteo's API.

You can find the new Python SDKs repository here : https://github.com/criteo/criteo-api-python-sdk

Criteo Marketing Transition SDK for Python

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/python-api-client-library

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2021-04
• Package version: 1.0.3

Requirements

Python 2.7 and 3.5+

Installation & Usage

pip install

pip install criteo_marketing_transition

(you may need to run pip with root permission: sudo pip install criteo_marketing_transition)

Then import the package:

import criteo_marketing_transition 

Manual Installation using Setuptools

Download the code or clone the repository locally, then execute the following command:

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import criteo_marketing_transition

Example

Please see examples/ for full examples to get a valid token and make a call to the API.

python ./examples/portfolio.py [client_id] [client_secret]

Documentation for API Endpoints

The developers documentation is available at: https://developers.criteo.com.

All URIs are relative to https://api.criteo.com.

Class	Method	HTTP request	Description
AdvertiserApi	api_portfolio_get	GET /2021-04/advertisers/me
AdvertiserApi	get_categories	GET /legacy/marketing/v1/advertisers/{advertiserId}/categories	Gets all advertiser's categories
AdvertiserApi	get_category	GET /legacy/marketing/v1/advertisers/{advertiserId}/categories/{categoryHashCode}	Gets a specific advertiser's category
AnalyticsApi	get_adset_report	POST /2021-04/statistics/report
AnalyticsApi	get_transactions_report	POST /2021-04/transactions/report
AudienceApi	create_audience	POST /2021-04/audiences
AudienceApi	delete_identifiers	DELETE /2021-04/audiences/{audience-id}/contactlist
AudienceApi	get_audiences	GET /2021-04/audiences
AudienceApi	modify_audience	PATCH /2021-04/audiences/{audience-id}
AudienceApi	modify_audience_users	PATCH /2021-04/audiences/{audience-id}/contactlist
AudienceApi	remove_audience	DELETE /2021-04/audiences/{audience-id}
CampaignApi	get_ad_set	GET /2021-04/marketing-solutions/ad-sets/{adSetId}
CampaignApi	get_bids	GET /legacy/marketing/v1/campaigns/bids	Gets a the bids for campaigns and their categories
CampaignApi	get_categories	GET /legacy/marketing/v1/campaigns/{campaignId}/categories	Gets categories
CampaignApi	get_category	GET /legacy/marketing/v1/campaigns/{campaignId}/categories/{categoryHashCode}	Gets a specific category
CampaignApi	patch_ad_sets	PATCH /2021-04/marketing-solutions/ad-sets
CampaignApi	search_ad_sets	POST /2021-04/marketing-solutions/ad-sets/search
CampaignApi	start_ad_sets	POST /2021-04/marketing-solutions/ad-sets/start
CampaignApi	stop_ad_sets	POST /2021-04/marketing-solutions/ad-sets/stop
CampaignApi	update_bids	PUT /legacy/marketing/v1/campaigns/bids	Update bids for campaigns and their categories
CategoryApi	get_categories	GET /legacy/marketing/v1/categories	Gets categories
CategoryApi	update_categories	PUT /legacy/marketing/v1/categories	Enables/disables categories
OAuthApi	create_token	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
• ResponsesReadAdSet
• StatisticsReportQueryMessage
• TransactionsReportQueryDataMessage
• TransactionsReportQueryEntityMessage
• TransactionsReportQueryMessage
• WriteModelAdSetId
• WriteModelPatchAdSet

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.