README

此项目已弃用

我们已构建了一套新的SDK，以帮助您使用我们的克里奥API。

您可以在以下位置找到新的PHP SDK仓库： https://github.com/criteo/criteo-api-marketingsolutions-php-sdk 和 https://github.com/criteo/criteo-api-retailmedia-php-sdk

信息

此PHP包由OpenAPI Generator项目自动生成

API版本：v.1.0
包版本：1.0.47
构建包：org.openapitools.codegen.languages.PhpClientCodegen

要求

PHP 7.1及更高版本

安装与使用

Composer

要使用Composer安装绑定

运行以下命令： composer require criteo/criteo-php-marketing-sdk

或添加以下内容到composer.json

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

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/CriteoMarketing/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请遵循安装过程，然后运行以下操作

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$clientId = 'YOUR_CLIENT_ID';
$clientCredentials = 'YOUR_PASSWORD';

// Automatic token refresh
$apiInstance = new Criteo\Marketing\Api\AdvertisersApi(new TokenAutoRefreshClient($clientId, $clientCredentials));

$advertiser_id = 56;
$authorization = 'Bearer VALID_JWT_TOKEN_BASE64';

try {
    $result = $apiInstance->getCampaigns($advertiser_id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdvertisersApi->getCampaigns: ', $e->getMessage(), PHP_EOL;
}

?>

您可以在此处找到完整示例。

API端点文档

所有URI均相对于 https://api.criteo.com/marketing

类	方法	HTTP请求	描述
AdvertisersApi	getCampaigns	GET /v1/advertisers/{advertiserId}/campaigns	获取所有广告主的广告系列
AdvertisersApi	getCategories	GET /v1/advertisers/{advertiserId}/categories	获取所有广告主的类别
AdvertisersApi	getCategory	GET /v1/advertisers/{advertiserId}/categories/{categoryHashCode}	获取特定广告主的类别
AudiencesApi	addRemoveUsersToAudience	PATCH /v1/audiences/userlist/{audienceId}	向/从受众添加/删除用户。
AudiencesApi	createAudience	POST /v1/audiences/userlist	创建一个新的受众。
AudiencesApi	deleteAudience	DELETE /v1/audiences/{audienceId}	删除一个受众。
AudiencesApi	getAudiences	GET /v1/audiences	获取受众列表。
AudiencesApi	removeUsersFromAudience	DELETE /v1/audiences/userlist/{audienceId}/users	从一个受众中删除所有用户。
AudiencesApi	updateAudienceMetadata	PUT /v1/audiences/{audienceId}	更新受众元数据。
AuthenticationApi	oAuth2TokenPost	POST /oauth2/token	验证提供的凭据并返回访问令牌
BudgetsApi	get	GET /v1/budgets	获取预算。
CampaignsApi	getBids	GET /v1/campaigns/bids	获取活动和它们的类别的出价。
CampaignsApi	getCampaign	GET /v1/campaigns/{campaignId}	获取特定活动。
CampaignsApi	getCampaigns	GET /v1/campaigns	获取活动。
CampaignsApi	getCategories	GET /v1/campaigns/{campaignId}/categories	获取类别。
CampaignsApi	getCategory	GET /v1/campaigns/{campaignId}/categories/{categoryHashCode}	获取特定类别。
CampaignsApi	updateBids	PUT /v1/campaigns/bids	更新活动和它们的类别的出价。
CategoriesApi	getCategories	GET /v1/categories	获取类别。
CategoriesApi	updateCategories	PUT /v1/categories	启用/禁用类别
PortfolioApi	getPortfolio	GET /v1/portfolio	获取投资组合。
PublishersApi	getStats	POST /v1/publishers/stats
SellersApi	createBudgets	POST /v1/sellers/budgets	为卖家/卖家列表创建预算。
SellersApi	get	GET /v1/sellers	获取卖家详情。
SellersApi	getCampaigns	GET /v1/sellers/campaigns	获取活动。
SellersApi	getStats	POST /v1/sellers/stats	生成统计报告
SellersApi	updateBids	PUT /v1/sellers/bids	为卖家/卖家列表设置或更新出价。
SellersApi	updateBudgets	PUT /v1/sellers/budgets	更新卖家/卖家列表的预算。
SellersV2Api	createSellerBudgets	POST /v2/crp/budgets	创建预算集合。
SellersV2Api	createSellerCampaignsBySeller	POST /v2/crp/sellers/{sellerId}/seller-campaigns	创建卖家活动。
SellersV2Api	createSellers	POST /v2/crp/advertisers/{advertiserId}/sellers	为广告商创建新的卖家。
SellersV2Api	getAdvertiser	GET /v2/crp/advertisers/{advertiserId}	获取广告商。
SellersV2Api	getAdvertiserCampaigns	GET /v2/crp/advertisers/{advertiserId}/campaigns	获取与advertiserId关联的CRP活动的集合。
SellersV2Api	getAdvertiserPreviewLimits	GET /v2/crp/advertisers/preview-limit	获取与授权用户关联的广告商预览限制的集合。
SellersV2Api	getAdvertisers	GET /v2/crp/advertisers	获取与用户关联的广告商集合。
SellersV2Api	getBudgetsByAdvertiser	GET /v2/crp/advertisers/{advertiserId}/budgets	获取特定广告商的CRP预算。
SellersV2Api	getBudgetsBySeller	GET /v2/crp/sellers/{sellerId}/budgets	获取此卖家的预算集合。
SellersV2Api	getBudgetsBySellerCampaignId	GET /v2/crp/seller-campaigns/{sellerCampaignId}/budgets	获取此卖家活动的预算集合。
SellersV2Api	getSeller	GET /v2/crp/sellers/{sellerId}	获取卖家详情。
SellersV2Api	getSellerAdDemo	GET /v2/crp/advertisers/{advertiserId}/ad-preview	获取属于提供的卖家的HTML广告预览。
SellersV2Api	getSellerBudget	GET /v2/crp/budgets/{budgetId}	获取预算详情。
SellersV2Api	getSellerBudgets	GET /v2/crp/budgets	获取预算集合。
SellersV2Api	getSellerCampaign	GET /v2/crp/seller-campaigns/{sellerCampaignId}	获取卖家活动详情。
SellersV2Api	getSellerCampaigns	GET /v2/crp/seller-campaigns	获取卖家活动集合。
SellersV2Api	getSellerCampaignsByAdvertiser	GET /v2/crp/advertisers/{advertiserId}/seller-campaigns	获取特定广告商的CRP卖家活动
SellersV2Api	getSellerCampaignsBySeller	GET /v2/crp/sellers/{sellerId}/seller-campaigns	获取该卖家的卖家活动集合。
SellersV2Api	getSellers	GET /v2/crp/sellers	获取卖家集合。
SellersV2Api	updateSellerBudget	PATCH /v2/crp/budgets/{budgetId}	修改单个预算。
SellersV2Api	updateSellerBudgets	PATCH /v2/crp/budgets	修改预算集合。
SellersV2Api	updateSellerCampaign	PATCH /v2/crp/seller-campaigns/{sellerCampaignId}	更新现有卖家活动。
SellersV2Api	updateSellerCampaigns	PATCH /v2/crp/seller-campaigns	更新卖家活动集合。
SellersV2StatsApi	campaigns	GET /v2/crp/stats/campaigns	按活动获取统计数据。
SellersV2StatsApi	sellerCampaigns	GET /v2/crp/stats/seller-campaigns	按卖家活动获取统计数据。
SellersV2StatsApi	sellers	GET /v2/crp/stats/sellers	按卖家获取统计数据。
StatisticsApi	getCampaignReport	POST /v1/statistics/report	生成统计报告
StatisticsApi	getStats	POST /v1/statistics	生成统计报告

模型文档

授权文档

为了简化此客户端库的使用，您可能希望使用TokenAutoRefreshClient，如示例中所述。

克里奥 / 克里奥PHP营销SDK

维护者

详细信息