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 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.260713
• 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-commercegrid-sdk:0.0.260713

or add the following to composer.json:

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/criteo-api-commercegrid-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

• ApplicationSummaryModel
• ApplicationSummaryModelResource
• ApplicationSummaryModelResponse
• AudienceError
• AudienceWarning
• CgAudienceSegmentBulkCreateInputV1
• CgAudienceSegmentBulkDeleteInputV1
• CgAudienceSegmentBulkUpdateInputV1
• CgAudienceSegmentCreateEntityV1
• CgAudienceSegmentCreateEntityV1Resource
• CgAudienceSegmentDeleteEntityV1Resource
• CgAudienceSegmentEntityV1
• CgAudienceSegmentEntityV1CgAudienceSegmentSearchMetadataV1ListResponse
• CgAudienceSegmentEntityV1ListResponse
• CgAudienceSegmentEntityV1Resource
• CgAudienceSegmentIdEntityV1ListResponse
• CgAudienceSegmentIdEntityV1Resource
• CgAudienceSegmentSearchEntityV1
• CgAudienceSegmentSearchEntityV1Resource
• CgAudienceSegmentSearchInputV1
• CgAudienceSegmentSearchMetadataV1
• CgAudienceSegmentUpdateEntityV1
• CgAudienceSegmentUpdateEntityV1Resource
• CgContactListCreateV1
• CgContactListStatisticsEntityV1
• CgContactListStatisticsEntityV1Resource
• CgContactListStatisticsEntityV1Response
• CommerceGridContactlistAmendment
• CommerceGridContactlistAmendmentAttributes
• CommerceGridContactlistAmendmentRequest
• CommerceGridContactlistOperation
• CommerceGridContactlistOperationResponseAttributes
• CommerceGridContactlistOperationResponseAttributesAttributes
• CommonProblem
• NillableString

Documentation For Authorization

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

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.