Skip to content

criteo/criteo-api-marketingsolutions-php-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.gitignore
.gitignore
 
 
.php-cs-fixer.dist.php
.php-cs-fixer.dist.php
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
composer.lock
composer.lock
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

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.

More information on how to use Criteo API and these SDKs can be found at: https://developers.criteo.com/.

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

  • Package version: 0.0.241029
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

This project is tested with PHP 8.0. However it should work fine with PHP 7.4 too.

Installation & Usage

Composer

To install the bindings via Composer:

either run the following command: composer require criteo/criteo-api-marketingsolutions-sdk:0.0.241029

or add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/criteo/criteo-api-marketingsolutions-php-sdk.git"
    }
  ],
  "require": {
    "criteo/criteo-api-marketingsolutions-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/criteo-api-marketingsolutions-sdk/vendor/autoload.php');

Tests

To run the unit tests:

composer run-script test

Example

Please see test/ExampleApplication.php for an example on how to perform a simple call.

Documentation for API Endpoints

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

Class Method HTTP request Description
AdvertiserApi apiPortfolioGet GET /preview/advertisers/me
AdvertiserApi createAdvertiser POST /preview/advertisers
AdvertiserApi getDatasetList GET /preview/advertisers/{advertiser-id}/datasets
AdvertiserApi listIndustries GET /preview/industries
AnalyticsApi getAdsetReport POST /preview/statistics/report
AnalyticsApi getAsyncAdsetReport POST /preview/reports/async-statistics
AnalyticsApi getAsyncAudienceReport POST /preview/reports/async-audience-performance
AnalyticsApi getAsyncExportOutput GET /preview/reports/{report-id}/output
AnalyticsApi getAsyncExportStatus GET /preview/reports/{report-id}/status
AnalyticsApi getCategoriesReport POST /preview/categories/report
AnalyticsApi getCreativesReport POST /preview/reports/creatives
AnalyticsApi getPlacementsReport POST /preview/placements/report
AnalyticsApi getTopProductsReport POST /preview/reports/top-products
AnalyticsApi getTransactionsReport POST /preview/transactions/report
AnalyticsApi getTransparencyReport POST /preview/log-level/advertisers/{advertiser-id}/report
AudienceApi bulkCreateAudienceSegments POST /preview/marketing-solutions/audience-segments/create
AudienceApi bulkCreateAudiences POST /preview/marketing-solutions/audiences/create
AudienceApi bulkDeleteAudienceSegments POST /preview/marketing-solutions/audience-segments/delete
AudienceApi bulkDeleteAudiences POST /preview/marketing-solutions/audiences/delete
AudienceApi bulkUpdateAudienceSegments PATCH /preview/marketing-solutions/audience-segments
AudienceApi bulkUpdateAudiences PATCH /preview/marketing-solutions/audiences
AudienceApi computeAudienceSegmentsSizes POST /preview/marketing-solutions/audience-segments/compute-sizes
AudienceApi computeAudiencesSizes POST /preview/marketing-solutions/audiences/compute-sizes
AudienceApi estimateAudienceSegmentSize POST /preview/marketing-solutions/audience-segments/estimate-size
AudienceApi estimateAudienceSize POST /preview/marketing-solutions/audiences/estimate-size
AudienceApi getAudienceSegmentContactListStatistics GET /preview/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
AudienceApi getAudienceSegmentsInMarketBrands GET /preview/marketing-solutions/audience-segments/in-market-brands
AudienceApi getAudienceSegmentsInMarketInterests GET /preview/marketing-solutions/audience-segments/in-market-interests
AudienceApi modifyAudienceUsersWithAttributes PATCH /preview/audiences/{audience-id}/contactlist-attributes
AudienceApi previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListDelete DELETE /preview/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
AudienceApi previewMarketingSolutionsAudienceSegmentsAudienceSegmentIdContactListPatch PATCH /preview/marketing-solutions/audience-segments/{audience-segment-id}/contact-list
AudienceApi searchAudienceSegments POST /preview/marketing-solutions/audience-segments/search
AudienceApi searchAudiences POST /preview/marketing-solutions/audiences/search
CampaignApi createAdSetV24Q3 POST /preview/marketing-solutions/ad-sets
CampaignApi createCampaign POST /preview/marketing-solutions/campaigns
CampaignApi deleteAdvertiserBundleRules DELETE /preview/advertisers/{advertiserId}/targeting/bundle-rules
CampaignApi deleteAdvertiserDomainRules DELETE /preview/advertisers/{advertiserId}/targeting/domain-rules
CampaignApi deleteCampaignBundleRules DELETE /preview/campaigns/{campaignId}/targeting/bundle-rules
CampaignApi deleteCampaignDomainRules DELETE /preview/campaigns/{campaignId}/targeting/domain-rules
CampaignApi deleteOCIbrandSafetyRule DELETE /preview/brand-safety/oci
CampaignApi deleteOCItargetingRule DELETE /preview/targeting/oci
CampaignApi disableAdSetTargetingDealIds POST /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids/disable
CampaignApi disableAdSetTargetingVideoPositioning POST /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positionings/disable
CampaignApi getAdSetTargetingDealIds GET /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids
CampaignApi getAdSetTargetingVideoPositioning GET /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positioning
CampaignApi getAdSetV24Q3 GET /preview/marketing-solutions/ad-sets/{ad-set-id}
CampaignApi getAdvertiserBundleRules GET /preview/advertisers/{advertiserId}/targeting/bundle-rules
CampaignApi getAdvertiserDomainRules GET /preview/advertisers/{advertiserId}/targeting/domain-rules
CampaignApi getCampaignBundleRules GET /preview/campaigns/{campaignId}/targeting/bundle-rules
CampaignApi getCampaignDomainRules GET /preview/campaigns/{campaignId}/targeting/domain-rules
CampaignApi getCampaignV23Q1 GET /preview/marketing-solutions/campaigns/{campaign-id}
CampaignApi getCategoryBidList GET /preview/marketing-solutions/ad-sets/{ad-set-id}/category-bids
CampaignApi getDisplayMultipliers GET /preview/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers
CampaignApi getOCIbrandSafetyRule GET /preview/brand-safety/oci
CampaignApi getOCItargetingRule GET /preview/targeting/oci
CampaignApi getSupplyVendorList GET /preview/marketing-solutions/ad-sets/targeting/supply-vendors
CampaignApi patchAdSetsV24Q3 PATCH /preview/marketing-solutions/ad-sets
CampaignApi patchCampaigns PATCH /preview/marketing-solutions/campaigns
CampaignApi patchCategoryBidList PATCH /preview/marketing-solutions/ad-sets/{ad-set-id}/category-bids
CampaignApi patchDisplayMultipliers PATCH /preview/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers
CampaignApi postAdvertiserBundleRules POST /preview/advertisers/{advertiserId}/targeting/bundle-rules
CampaignApi postAdvertiserDomainRules POST /preview/advertisers/{advertiserId}/targeting/domain-rules
CampaignApi postCampaignBundleRules POST /preview/campaigns/{campaignId}/targeting/bundle-rules
CampaignApi postCampaignDomainRules POST /preview/campaigns/{campaignId}/targeting/domain-rules
CampaignApi putAdvertiserBundleRules PUT /preview/advertisers/{advertiserId}/targeting/bundle-rules
CampaignApi putAdvertiserDomainRules PUT /preview/advertisers/{advertiserId}/targeting/domain-rules
CampaignApi putCampaignBundleRules PUT /preview/campaigns/{campaignId}/targeting/bundle-rules
CampaignApi putCampaignDomainRules PUT /preview/campaigns/{campaignId}/targeting/domain-rules
CampaignApi searchAdSetsV24Q3 POST /preview/marketing-solutions/ad-sets/search
CampaignApi searchCampaignsV23Q1 POST /preview/marketing-solutions/campaigns/search
CampaignApi setAdSetTargetingDealIds PUT /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/deal-ids
CampaignApi setAdSetTargetingVideoPositioning PUT /preview/marketing-solutions/ad-sets/{ad-set-id}/targeting/video-positioning
CampaignApi startAdSets POST /preview/marketing-solutions/ad-sets/start
CampaignApi stopAdSets POST /preview/marketing-solutions/ad-sets/stop
CampaignApi updateAdSetAudience PUT /preview/marketing-solutions/ad-sets/{ad-set-id}/audience
CampaignApi upsertOCIbrandSafetyRule POST /preview/brand-safety/oci
CampaignApi upsertOCItargetingRule POST /preview/targeting/oci
CatalogApi previewCatalogProductsBatchPost POST /preview/catalog/products/batch
CatalogApi previewCatalogProductsBatchReportOperationTokenGet GET /preview/catalog/products/batch/report/{operation-token}
CatalogApi previewCatalogStatsMerchantsMerchantIdGet GET /preview/catalog/stats/merchants/{merchant-id}
CreativeApi createAdvertiserAd POST /preview/advertisers/{advertiser-id}/ads
CreativeApi createAdvertiserCoupon POST /preview/advertisers/{advertiser-id}/coupons
CreativeApi createAdvertiserCreative POST /preview/advertisers/{advertiser-id}/creatives
CreativeApi deleteAd DELETE /preview/ads/{id}
CreativeApi deleteAdvertiserCoupon DELETE /preview/advertisers/{advertiser-id}/coupons/{id}
CreativeApi deleteCreative DELETE /preview/creatives/{id}
CreativeApi editAdvertiserCoupon PUT /preview/advertisers/{advertiser-id}/coupons/{id}
CreativeApi editCreative PUT /preview/creatives/{id}
CreativeApi generateCreativePreview POST /preview/creatives/{id}/preview
CreativeApi getAd GET /preview/ads/{id}
CreativeApi getAdvertiserAds GET /preview/advertisers/{advertiser-id}/ads
CreativeApi getAdvertiserCoupon GET /preview/advertisers/{advertiser-id}/coupons/{id}
CreativeApi getAdvertiserCouponPreview GET /preview/advertisers/{advertiser-id}/coupons/{id}/preview
CreativeApi getAdvertiserCouponSupportedSizes GET /preview/advertisers/{advertiser-id}/coupons-supported-sizes
CreativeApi getAdvertiserCoupons GET /preview/advertisers/{advertiser-id}/coupons
CreativeApi getAdvertiserCreatives GET /preview/advertisers/{advertiser-id}/creatives
CreativeApi getCreative GET /preview/creatives/{id}
GatewayApi getCurrentApplication GET /preview/marketing-solutions/me
OnSiteRecommendationApi apiV1RecoPost POST /preview/recommendation/search
RecoApi createProductSet POST /preview/product-sets
RecoApi disableProductFiltering DELETE /preview/ads/{ad-id}/product-filter
RecoApi enableProductFiltering POST /preview/ads/{ad-id}/product-filter
RecoApi fetchProductFilteringConfig GET /preview/ads/{ad-id}/product-filter
RecoApi fetchProductFilteringUsages GET /preview/product-sets/{product-set-id}/product-filters
RecoApi fetchProductSet GET /preview/product-sets/{product-set-id}
RecoApi fetchProductSets GET /preview/product-sets/dataset/{dataset-id}
RecoApi removeProductSet DELETE /preview/product-sets/{product-set-id}

Documentation For Models

Documentation For Authorization

oauth

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

oauth

Author

Criteo

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.

About

Marketing Solutions SDKs

Resources

Readme
Activity
Custom properties

Stars

2 stars

Watchers

9 watching

Forks

4 forks
Report repository

Releases

162 tags

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages