boxalino / criteo-api-php
PHP SDK for Criteo API 0.0.230427 version
Requires
- php: >=8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.5
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- jchook/phpunit-assert-throws: ^1.0
- mockery/mockery: ^1.3
- phpunit/phpunit: >=7.4 <10.0
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-11-09 18:59:32 UTC
README
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: https://developers.criteo.com/
This PHP package is automatically generated by the OpenAPI Generator project:
- Package version: 0.0.230427
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
Requirements
This project is tested with PHP 8.0. However it should work fine with PHP 7.x too.
Installation & Usage
Composer
To install the bindings via Composer:
either run the following command: composer require criteo/criteo-api-marketingsolutions-sdk:0.0.230427
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
Documentation For Models
- Ad
- AdListResponse
- AdResource
- AdResponse
- AdSetAudienceLinkEntityV1
- AdSetAudienceLinkEntityV1Resource
- AdSetAudienceLinkEntityV1Response
- AdSetAudienceLinkInputEntityV1
- AdSetCategoryBid
- AdSetCategoryBidListResponse
- AdSetCategoryBidResource
- AdSetDeliveryLimitations
- AdSetDeliveryLimitationsV23Q1
- AdSetDisplayMultiplier
- AdSetDisplayMultiplierListResponse
- AdSetDisplayMultiplierResource
- AdSetFrequencyCapping
- AdSetFrequencyCappingV23Q1
- AdSetGeoLocation
- AdSetGeoLocationV23Q1
- AdSetSearchFilterV23Q1
- AdSetSearchRequestV23Q1
- AdSetTargeting
- AdSetTargetingDealIds
- AdSetTargetingDealIdsDisableResultResource
- AdSetTargetingDealIdsDisableResultResponse
- AdSetTargetingDealIdsResource
- AdSetTargetingDealIdsResponse
- AdSetTargetingDealIdsSetResultResource
- AdSetTargetingDealIdsSetResultResponse
- AdSetTargetingRule
- AdSetTargetingRuleV23Q1
- AdSetTargetingV23Q1
- AdSetTargetingVideoPositioning
- AdSetTargetingVideoPositioningDisableResultResource
- AdSetTargetingVideoPositioningDisableResultResponse
- AdSetTargetingVideoPositioningResource
- AdSetTargetingVideoPositioningResponse
- AdSetTargetingVideoPositioningSetResultResource
- AdSetTargetingVideoPositioningSetResultResponse
- AdWrite
- AdWriteRequest
- AdWriteResource
- AdaptiveAttributes
- AdaptiveColors
- AdaptiveWriteAttributes
- AdvertiserCreationInput
- AdvertiserCreationRequest
- AdvertiserCreationResponse
- AdvertiserDatasetListResponse
- AlgebraNodeV1
- ApiErrorResponse
- ApiRequestOfTargetingEntity
- ApiResponseOfTargetingEntity
- ApplicationSummaryModel
- ApplicationSummaryModelResource
- ApplicationSummaryModelResponse
- Attribute
- AudienceBulkCreateInputV1
- AudienceBulkDeleteInputV1
- AudienceBulkUpdateInputV1
- AudienceComputeSizeEntityV1Resource
- AudienceComputeSizesInputV1
- AudienceCreateEntityV1
- AudienceCreateEntityV1Resource
- AudienceDeleteEntityV1Resource
- AudienceEntityV1
- AudienceEntityV1AudienceSearchMetadataV1ListResponse
- AudienceEntityV1ListResponse
- AudienceEntityV1Resource
- AudienceError
- AudienceEstimateSizeEntityV1
- AudienceEstimateSizeEntityV1Resource
- AudienceEstimateSizeInputV1
- AudienceIdEntityV1ListResponse
- AudienceIdEntityV1Resource
- AudienceNameDescription
- AudienceSearchEntityV1
- AudienceSearchEntityV1Resource
- AudienceSearchInputV1
- AudienceSearchMetadataV1
- AudienceSegmentBulkCreateInputV1
- AudienceSegmentBulkDeleteInputV1
- AudienceSegmentBulkUpdateInputV1
- AudienceSegmentComputeSizeEntityV1Resource
- AudienceSegmentComputeSizesInputV1
- AudienceSegmentCreateEntityV1
- AudienceSegmentCreateEntityV1Resource
- AudienceSegmentDeleteEntityV1Resource
- AudienceSegmentEntityV1
- AudienceSegmentEntityV1AudienceSegmentSearchMetadataV1ListResponse
- AudienceSegmentEntityV1ListResponse
- AudienceSegmentEntityV1Resource
- AudienceSegmentEstimateSizeInputV1
- AudienceSegmentIdEntityV1ListResponse
- AudienceSegmentIdEntityV1Resource
- AudienceSegmentSearchEntityV1
- AudienceSegmentSearchEntityV1Resource
- AudienceSegmentSearchInputV1
- AudienceSegmentSearchMetadataV1
- AudienceSegmentSizeEntityV1
- AudienceSegmentSizeEntityV1ListResponse
- AudienceSegmentSizeEntityV1Resource
- AudienceSegmentSizeEstimationEntityV1
- AudienceSegmentSizeEstimationEntityV1Resource
- AudienceSegmentSizeEstimationV1
- AudienceSegmentSizeEstimationV1Resource
- AudienceSegmentSizeEstimationV1Response
- AudienceSegmentUpdateEntityV1
- AudienceSegmentUpdateEntityV1Resource
- AudienceSizeEntityV1
- AudienceSizeEntityV1ListResponse
- AudienceSizeEntityV1Resource
- AudienceSizeEstimationV1
- AudienceSizeEstimationV1Resource
- AudienceSizeEstimationV1Response
- AudienceUpdateEntityV1
- AudienceUpdateEntityV1Resource
- AudienceWarning
- BasicAudienceDefinition
- BatchAcceptedResponse
- BehavioralV1
- CampaignSearchFiltersV23Q1
- CampaignSearchRequestV23Q1
- CampaignSpendLimitV23Q1
- CampaignV23Q1
- CampaignV23Q1ListResponse
- CampaignV23Q1Resource
- CampaignV23Q1Response
- CommonProblem
- ContactListStatisticsEntityV1
- ContactListStatisticsEntityV1Resource
- ContactListStatisticsEntityV1Response
- ContactListV1
- ContactlistAmendment
- ContactlistAmendmentAttributes
- ContactlistAmendmentRequest
- ContactlistOperation
- ContactlistOperationAttributes
- ContactlistWithAttributesAmendment
- ContactlistWithAttributesAmendmentAttributes
- ContactlistWithAttributesAmendmentRequest
- Coupon
- CouponListResponse
- CouponResource
- CouponResponse
- CouponSupportedSizes
- CouponSupportedSizesResource
- CouponSupportedSizesResponse
- CreateAdSet
- CreateAdSetBidding
- CreateAdSetBudget
- CreateAdSetGeoLocation
- CreateAdSetRequest
- CreateAdSetResource
- CreateAdSetSchedule
- CreateAdSetTargeting
- CreateCampaign
- CreateCampaignRequest
- CreateCampaignResource
- CreateCampaignSpendLimit
- CreateCoupon
- CreateCouponRequest
- CreateCouponResource
- CreateImageSlide
- CreateProductSetRequest
- Creative
- CreativeListResponse
- CreativeResource
- CreativeResponse
- CreativeWrite
- CreativeWriteRequest
- CreativeWriteResource
- CriteoApiError
- CriteoApiErrorV2
- CriteoApiWarning
- CriteoApiWarningV2
- CustomAttribute
- Dataset
- DealId
- DeleteAudienceContactListResponse
- DeleteUserProfileModel
- DeleteUserProfileModelListRequest
- DeleteUserProfileModelResource
- DynamicAttributes
- DynamicWriteAttributes
- EntityFilter
- EntityOfPortfolioMessage
- EntityV2OfDataset
- EntityV2OfObject
- EntityWrapperOfTargetingEntity
- ErrorCodeResponse
- ErrorDescription
- ExportColumn
- ExportMetaData
- ExportResult
- ExportResultData
- FailResponse
- GenerateAudiencePerformanceReportRequest
- GenerateAudiencePerformanceReportRequestAttributes
- GenerateAudiencePerformanceReportRequestData
- GenerateCategoriesReportRequest
- GenerateCategoriesReportRequestAttributes
- GenerateCategoriesReportRequestData
- GenerateCreativesReportRequest
- GenerateCreativesReportRequestAttributes
- GenerateCreativesReportRequestData
- GenerateStatisticsReportRequest
- GenerateStatisticsReportRequestAttributes
- GenerateStatisticsReportRequestData
- GenerateTopProductsReportRequest
- GenerateTopProductsReportRequestAttributes
- GenerateTopProductsReportRequestData
- GetPortfolioResponse
- HtmlTagAttributes
- HtmlTagWriteAttributes
- ImageAttributes
- ImageSet
- ImageSetBase64
- ImageShape
- ImageSlide
- ImageWriteAttributes
- InMarketAudienceSegmentBrandEntityV1
- InMarketAudienceSegmentBrandEntityV1ListResponse
- InMarketAudienceSegmentBrandEntityV1Resource
- InMarketAudienceSegmentInterestEntityV1
- InMarketAudienceSegmentInterestEntityV1ListResponse
- InMarketAudienceSegmentInterestEntityV1Resource
- InMarketCreateV1
- InMarketSizeEstimationV1
- InMarketUpdateV1
- InMarketV1
- Installment
- JsonReportRows
- ListAvailableIndustriesResponse
- LocationCreateV1
- LocationSizeEstimationV1
- LocationUpdateV1
- LocationV1
- LookalikeCreateV1
- LookalikeUpdateV1
- LookalikeV1
- LoyaltyPoints
- MarketingSolutionsReportStatus
- MarketingSolutionsReportStatusResource
- MarketingSolutionsReportStatusResponse
- ModifyAudienceResponse
- NillableAdSetTargetingRule
- NillableAdSetTargetingRuleV23Q1
- NillableAdSetTargetingRuleValue
- NillableDateTime
- NillableDecimal
- NillableGenderV1
- NillableString
- OciBrandSafetyResponse
- OciBrandSafetyResponseData
- OciBrandSafetyRule
- OciBrandSafetySegment
- OciTargetingNode
- OciTargetingResponse
- OciTargetingResponseData
- OciTargetingRule
- OkResponse
- OnSiteRecoRequest
- OnSiteRecoResponse
- Outcome
- PatchAdSet
- PatchAdSetBidding
- PatchAdSetBudget
- PatchAdSetCategoryBid
- PatchAdSetCategoryBidListRequest
- PatchAdSetCategoryBidResource
- PatchAdSetCategoryBidResultListResponse
- PatchAdSetCategoryBidResultResource
- PatchAdSetDisplayMultiplier
- PatchAdSetDisplayMultiplierListRequest
- PatchAdSetDisplayMultiplierResource
- PatchAdSetDisplayMultiplierResultListResponse
- PatchAdSetDisplayMultiplierResultResource
- PatchAdSetScheduling
- PatchCampaign
- PatchCampaignListRequest
- PatchCampaignSpendLimit
- PatchCampaignWriteResource
- PatchResultCampaignListResponse
- PatchResultCampaignReadResource
- PlacementsReportQueryDataMessage
- PlacementsReportQueryEntityMessage
- PlacementsReportQueryMessage
- PointOfInterestV1
- PortfolioMessage
- PreviewError
- PreviewFailResponse
- PreviewWarning
- Price
- ProblemDetails
- ProblemsDetails
- Product
- ProductImporterError
- ProductImporterWarning
- ProductSet
- ProductSetPreview
- ProductSetRule
- ProductSetStatistics
- ProductSetStatisticsQuery
- ProductShipping
- ProductShippingDimension
- ProductShippingWeight
- ProductTax
- ProductUnitPricingBaseMeasure
- ProductUnitPricingMeasure
- ProductsCustomBatchRequest
- ProductsCustomBatchRequestEntry
- ReadAdSet
- ReadAdSetBidding
- ReadAdSetBiddingV23Q1
- ReadAdSetBudget
- ReadAdSetBudgetV23Q1
- ReadAdSetSchedule
- ReadAdSetScheduleV23Q1
- ReadAdSetV23Q1
- ReadModelAdSetId
- ReadModelReadAdSet
- ReadModelReadAdSetV23Q1
- RecommendedProduct
- ReportDataMessage
- ReportDetailError
- ReportDetailErrors
- ReportEntityMessage
- ReportOkResponse
- RequestsAdSetId
- RequestsPatchAdSet
- ResourceCollectionOutcomeOfProductSet
- ResourceOfProductSet
- ResourceOutcomeOfProductSet
- ResponseAdSetId
- ResponseReadAdSet
- ResponseReadAdSetV23Q1
- ResponsesAdSetId
- ResponsesReadAdSetV23Q1
- RetargetingCreateV1
- RetargetingUpdateV1
- RetargetingV1
- Rules
- SetAdSetTargetingDealIds
- SetAdSetTargetingDealIdsRequest
- SetAdSetTargetingDealIdsResource
- SetAdSetTargetingVideoPositioning
- SetAdSetTargetingVideoPositioningRequest
- SetAdSetTargetingVideoPositioningResource
- SetUserProfileModel
- SetUserProfileModelListRequest
- SetUserProfileModelResource
- Size
- StatisticsOkResponse
- StatisticsRecord
- StatisticsRecordList
- StatisticsReportQueryMessage
- SupplyVendor
- SupplyVendorListResponse
- SupplyVendorResource
- Tag
- Target
- TargetType
- TargetingEntity
- TargetingErrorModel
- TargetingOperator
- TransactionsReportQueryDataMessage
- TransactionsReportQueryEntityMessage
- TransactionsReportQueryMessage
- TransparencyQueryMessage
- TransparencyReportAttributes
- TransparencyReportDataMessage
- TransparencyReportEntityMessage
- TransparencyReportFile
- UnauthorizedResponseV2
- UpdateCoupon
- UpdateCouponRequest
- UpdateCouponResource
- UserDef
- UserEvent
- UserProfileAttributeModel
- UserProfileIdentifierModel
- ValueResourceInputOfCreateProductSetRequest
- ValueResourceOfCreateProductSetRequest
- VideoDetail
- WriteModelAdSetId
- WriteModelPatchAdSet
Documentation For Authorization
In order to ease usage of this client library, you might want to use the TokenAutoRefreshClient as explained in the example.
oauth
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
oauth
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://api.criteo.com/oauth2
- Scopes: N/A
Author
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.