Git Product home page Git Product logo

criteo-python-marketing-sdk's Introduction

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 SDK for Python

Build Status

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

  • API version: v.1.0
  • Package version: 1.0.171

Requirements.

Python 2.7 and 3.5+

Installation & Usage

pip install

pip install criteo_marketing

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

Then import the package:

import criteo_marketing

Setuptools

Install via Setuptools.

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

Example

Please see examples/ 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/marketing

Class Method HTTP request Description
AdvertisersApi get_campaigns GET /v1/advertisers/{advertiserId}/campaigns Gets all advertiser's campaigns
AdvertisersApi get_categories GET /v1/advertisers/{advertiserId}/categories Gets all advertiser's categories
AdvertisersApi get_category GET /v1/advertisers/{advertiserId}/categories/{categoryHashCode} Gets a specific advertiser's category
AudiencesApi add_remove_users_to_audience PATCH /v1/audiences/userlist/{audienceId} Add/Remove users to an Audience.
AudiencesApi create_audience POST /v1/audiences/userlist Create a new Audience.
AudiencesApi delete_audience DELETE /v1/audiences/{audienceId} Delete an Audience.
AudiencesApi get_audiences GET /v1/audiences Get the list of Audiences.
AudiencesApi remove_users_from_audience DELETE /v1/audiences/userlist/{audienceId}/users Remove all users from an Audience.
AudiencesApi update_audience_metadata PUT /v1/audiences/{audienceId} Update an Audience metadata.
AuthenticationApi o_auth2_token_post POST /oauth2/token Authenticates provided credentials and returns an access token
BudgetsApi get GET /v1/budgets Gets budgets
CampaignsApi get_bids GET /v1/campaigns/bids Gets a the bids for campaigns and their categories
CampaignsApi get_campaign GET /v1/campaigns/{campaignId} Gets a specific campaign
CampaignsApi get_campaigns GET /v1/campaigns Gets campaigns
CampaignsApi get_categories GET /v1/campaigns/{campaignId}/categories Gets categories
CampaignsApi get_category GET /v1/campaigns/{campaignId}/categories/{categoryHashCode} Gets a specific category
CampaignsApi update_bids PUT /v1/campaigns/bids Update bids for campaigns and their categories
CategoriesApi get_categories GET /v1/categories Gets categories
CategoriesApi update_categories PUT /v1/categories Enables/disables categories
PortfolioApi get_portfolio GET /v1/portfolio Gets portfolio
PublishersApi get_stats POST /v1/publishers/stats
SellersApi create_budgets POST /v1/sellers/budgets Creates a budget for a seller/list of sellers.
SellersApi get GET /v1/sellers Gets sellers details.
SellersApi get_campaigns GET /v1/sellers/campaigns Gets campaigns
SellersApi get_stats POST /v1/sellers/stats Generates a statistics report
SellersApi update_bids PUT /v1/sellers/bids Set or update a bid for a seller/list of sellers.
SellersApi update_budgets PUT /v1/sellers/budgets Updates a budget for a seller/list of sellers.
SellersV2Api create_seller_budgets POST /v2/crp/budgets Create a collection of budgets.
SellersV2Api create_seller_campaigns_by_seller POST /v2/crp/sellers/{sellerId}/seller-campaigns Create a SellerCampaign
SellersV2Api create_sellers POST /v2/crp/advertisers/{advertiserId}/sellers Create new sellers for an advertiser
SellersV2Api get_advertiser GET /v2/crp/advertisers/{advertiserId} Get an advertiser.
SellersV2Api get_advertiser_campaigns GET /v2/crp/advertisers/{advertiserId}/campaigns Get the collection of CRP campaigns associated with the advertiserId.
SellersV2Api get_advertiser_preview_limits GET /v2/crp/advertisers/preview-limit Get the collection of advertisers preview limits associated with the authorized user.
SellersV2Api get_advertisers GET /v2/crp/advertisers Get the collection of advertisers associated with the user.
SellersV2Api get_budgets_by_advertiser GET /v2/crp/advertisers/{advertiserId}/budgets Get CRP budgets for a specific advertiser
SellersV2Api get_budgets_by_seller GET /v2/crp/sellers/{sellerId}/budgets Get a collection of budgets for this seller.
SellersV2Api get_budgets_by_seller_campaign_id GET /v2/crp/seller-campaigns/{sellerCampaignId}/budgets Get a collection of budgets for this seller campaign.
SellersV2Api get_seller GET /v2/crp/sellers/{sellerId} Get details for a seller.
SellersV2Api get_seller_ad_demo GET /v2/crp/advertisers/{advertiserId}/ad-preview Get a preview of an HTML ad with products belonging to the provided seller
SellersV2Api get_seller_budget GET /v2/crp/budgets/{budgetId} Get details for a budget.
SellersV2Api get_seller_budgets GET /v2/crp/budgets Get a collection of budgets.
SellersV2Api get_seller_campaign GET /v2/crp/seller-campaigns/{sellerCampaignId} Get details for a seller campaign.
SellersV2Api get_seller_campaigns GET /v2/crp/seller-campaigns Get a collection of seller campaigns.
SellersV2Api get_seller_campaigns_by_advertiser GET /v2/crp/advertisers/{advertiserId}/seller-campaigns Get CRP seller-campaigns for a specific advertiser
SellersV2Api get_seller_campaigns_by_seller GET /v2/crp/sellers/{sellerId}/seller-campaigns Get a collection of seller campaigns for this seller.
SellersV2Api get_sellers GET /v2/crp/sellers Get a collection of sellers.
SellersV2Api update_seller_budget PATCH /v2/crp/budgets/{budgetId} Modify a single budget.
SellersV2Api update_seller_budgets PATCH /v2/crp/budgets Modify a collection of budgets.
SellersV2Api update_seller_campaign PATCH /v2/crp/seller-campaigns/{sellerCampaignId} Update an existing seller campaign.
SellersV2Api update_seller_campaigns PATCH /v2/crp/seller-campaigns Update a collection of seller campaigns.
SellersV2StatsApi campaigns GET /v2/crp/stats/campaigns Get stats by campaign.
SellersV2StatsApi seller_campaigns GET /v2/crp/stats/seller-campaigns Get stats by seller-campaign.
SellersV2StatsApi sellers GET /v2/crp/stats/sellers Get stats by seller.
StatisticsApi get_campaign_report POST /v1/statistics/report Generates a statistics report
StatisticsApi get_stats POST /v1/statistics Generates a statistics report

Documentation For Models

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.

criteo-python-marketing-sdk's People

Contributors

kamaradclimber avatar ouvreboite avatar rmadisonhaynie avatar tpeyrard avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.