亞馬遜廣告擴充套件 API v2 easy-Amazon-advertising 文件

mystudytime發表於2020-02-22

作者：studytime(有問題可以到作者部落格下留言)
原文連結：https://www.studytime.xin

概述

easy-amazon-advertising

easy-amazon-advertising 是一個開源的非官方的亞馬遜廣告業務sdk。

環境需求

easy-amazon-advertising 的安裝非常簡單，因為它是一個標準的 Composer 包，這意味著任何滿足下列安裝條件的 PHP 專案支援 Composer 都可以使用它。

php: >=7.2.0
guzzlehttp/guzzle: 6.4.*
pimple/pimple: ~3.0

安裝

使用composer安裝

composer require mystudytime/easy-amazon-advertising

說明

亞馬遜廣告業務目前的劃分為三種：

Sponsored Display 推廣展示廣告
Sponsored Products 商品推廣廣告
Sponsored Brands 品牌推廣廣告

亞馬遜廣告的api文件也大體是如此，針對此種情況本sdk也將模組做了類似的劃分。

下面是sdk廣告業務模組的劃分：

SponsoredProducts
SponsoredDisplay
SponsoredBrands
BaseService

特殊的 BaseService 模組包含了亞馬遜廣告api中未做劃分的部分，包括AccessToken、Portfolios、Profiles等。

BaseService

入門

use easyAmazonAdv\Factory;

$config = [
    'clientId'      => 'amzn1.application-oa2-client.xxx',
    'clientSecret'  => '3b758af8d13ee02355764e4e864fxxxx',
    'refreshToken'   => 'Atzr|IwEBIL5GyUh_H2fdRJnFOk7mmpluKnm7WWUW0kf0tBxAXFMG5VHyiZuIhrspq6hZRHzPM03RMX7v64KrhXaO9xCtylMUQPcN0LolQhH8PNff76Ve5pS6PO9jtNG9kW1K9YtV1WcJDN3KnGpHjk0dUBtbbrn5uh8EGDDVUR_gpqaHXqqdvZ7vuUXTNzstH-tybiAzspzIPxPf7Ans-uyqPNyNTIIM61vA66fvPkH3-c33iLCzrgRtg_jhzWrZuH4K6INBfR8CjKHcK5oNun4DRTiOnCinvUdbHQPwAeI9m581FzUk2Hp4g5KaXO60A6-4me5EMuGSagWfUvTs1MkB1DgPAs_Do3v0TKKN1L6Vab4YgDu6k-bb5pgor_H_LQ24kbfc2Jdyq9BJkSVAAIP5Hh4y3i1qAh18g94Qq_yLWQOxu8ySawTUSDWOkM3_AH5qFS_Yaegfpc96nZE6_eDnycnnheFnXj14-ghaNsROG4LO2RE4n4xnpj9vx9o5aOFVGhf148Cz_VZjiZCg2t_V0Mru7uYRkwz1OUOxxxxxxxxxxx',
    'region'       => 'NA',
];

$app    = Factory::BaseService($config);

$app 在所有相關BaseService的文件都是指 Factory::BaseService 得到的例項，就不在每個頁面單獨寫了。

RefreshToken

您可以使用RefreshToken方法在訪問令牌到期時重新整理訪問令牌。新的訪問令牌將在請求的響應中。

use easyAmazonAdv\Factory;

$config = [
    'clientId'      => 'amzn1.application-oa2-client.xxx',
    'clientSecret'  => '3b758af8d13ee02355764e4e864fxxxx',
    'refreshToken'   => 'Atzr|IwEBIL5GyUh_H2fdRJnFOk7mmpluKnm7WWUW0kf0tBxAXFMG5VHyiZuIhrspq6hZRHzPM03RMX7v64KrhXaO9xCtylMUQPcN0LolQhH8PNff76Ve5pS6PO9jtNG9kW1K9YtV1WcJDN3KnGpHjk0dUBtbbrn5uh8EGDDVUR_gpqaHXqqdvZ7vuUXTNzstH-tybiAzspzIPxPf7Ans-uyqPNyNTIIM61vA66fvPkH3-c33iLCzrgRtg_jhzWrZuH4K6INBfR8CjKHcK5oNun4DRTiOnCinvUdbHQPwAeI9m581FzUk2Hp4g5KaXO60A6-4me5EMuGSagWfUvTs1MkB1DgPAs_Do3v0TKKN1L6Vab4YgDu6k-bb5pgor_H_LQ24kbfc2Jdyq9BJkSVAAIP5Hh4y3i1qAh18g94Qq_yLWQOxu8ySawTUSDWOkM3_AH5qFS_Yaegfpc96nZE6_eDnycnnheFnXj14-ghaNsROG4LO2RE4n4xnpj9vx9o5aOFVGhf148Cz_VZjiZCg2t_V0Mru7uYRkwz1OUOxxxxxxxxxxx',
    'region'       => 'NA',
];

$app    = Factory::BaseService($config);
$result = $app->access_token->RefreshToken();

Profiles

Marketplaces 市場通過位置為各個商戶分配了特定的配置屬性資訊。包含countryCode, currencyCode, timezone等。profileID在呼叫api介面時在header（Amazon-Advertising-API-Scope）中傳入。

listProfiles

$app->profiles->listProfiles();

[[
  "profileId":1234567890,
  "countryCode":"US",
  "currencyCode":"USD",
  "dailyBudget":10.00,
  "timezone":"America/Los_Angeles",
  "accountInfo":{
  "marketplaceStringId":"ABC123",
  "sellerStringId":"DEF456"
]]

設定profileId

$app->client->profileId = 1234567890;

Portfolios 廣告組合

listPortfolios 廣告組合列表

$app->portfolios->listPortfolios(['portfolioId'=>12,'portfolioState'=>'enable']);

[
    [
        "portfolioId": 1234567890,
        "name": "My Portfolio One",
        "budget": [
            "amount": 100.0,
            "currencyCode": "USD",
            "policy": "dateRange"
            "startDate": "20181001",
            "endDate": "20181229"
        ],
        "inBudget": true,
        "state": "enabled",
    ],
    [
        "portfolioId": 0123456789,
        "name": "My Portfolio Two",
        "budget": [
            "amount": 50.0,
            "currencyCode": "USD",
            "policy": "dateRange",
            "startDate": "20181001",
            "endDate": "20181229"
        ],
        "inBudget": true,
        "state": "enabled",
    ]
]

listPortfoliosEx 廣告組合列表擴充套件欄位

$app->portfolios->listPortfoliosEx(['portfolioId'=>12,'portfolioState'=>'enable']);

[
    [
        "portfolioId": 1234567890,
        "name": "My Portfolio One",
        "budget": [
            "amount": 100.0,
            "currencyCode": "USD",
            "policy": "dateRange"
            "startDate": "20181001",
            "endDate": "20181229"
        ],
        "inBudget": true,
        "state": "enabled",
        "creationDate": 1526510030,
        "lastUpdatedDate": 1526510030,
        "servingStatus": "PENDING_START_DATE"
    ],
    [
        "portfolioId": 0123456789,
        "name": "My Portfolio Two",
        "budget": [
            "amount": 50.0,
            "currencyCode": "USD",
            "policy": "dateRange",
            "startDate": "20181001",
            "endDate": "20181229"
        ],
        "inBudget": true,
        "state": "enabled",
        "creationDate": 1526510030,
        "lastUpdatedDate": 1526510030,
        "servingStatus": "PENDING_START_DATE"
    ]
]

getPortfolio 廣告組合詳情

$app->portfolios->getPortfolio(1234567890);

{
    "portfolioId": 1234567890,
    "name": "My Portfolio One",
    "budget": [
        "amount": 100.0,
        "currencyCode": "USD",
        "policy": "dateRange"
        "startDate": "20181231"
        "endDate": "null"
    ],
    "inBudget": true,
    "state": "enabled"
]

getPortfolioEx 廣告組合擴充套件欄位

$app->portfolios->getPortfolioEx(1234567890);

[
    "portfolioId": 1234567890,
    "name": "My Portfolio One",
    "budget": [
        "amount": 100.0,
        "policy": "dateRange"
        "startDate": "20190131"
        "endDate": "20190331"
    ],
    "inBudget": true,
    "state": "enabled",
    "creationDate": 1526510030,
    "lastUpdatedDate": 1526510030,
    "servingStatus": "PENDING_START_DATE"
]

createPortfolios 建立廣告組合（批量）

$params = [
    [
        'name' =>  'My Portfolios name',
    ],
    [
        'name' =>  'My Portfolios two',
        'budget'=>[
            'amount'    =>  1.0,
            'policy'    =>  'dateRange',
            'startDate' =>  '20191220',
            'endDate' =>  '20191221',
        ],
        'state'=>'enable'
    ],
    [
        'name' =>  'My Portfolios three',
        'budget'=>[
            'amount'    =>  1.0,
            'policy'    =>  'monthlyRecurring',
            'endDate' =>  '20191221',
        ],
        'state'=>'enable'
    ],
];
$result = $app->portfolios->createPortfolios($params);

[
    [
        "code": "SUCCESS",
        "portfolioId": 1234567890
    ],
    [
        "code": "SUCCESS",
        "portfolioId": 0123456789
    ],
    [
        "code": "SUCCESS",
        "portfolioId": 1234567891
    ]
]

updatePortfolios 更新廣告組合（批量）

$params = [
    [
        'portfolioId'=>1234567890,
        'name' =>  'My Portfolios name',
    ],
    [
        'portfolioId'=>0123456789,
        'name' =>  'My Portfolios two',
        'budget'=>[
            'amount'    =>  1.0,
            'policy'    =>  'dateRange',
            'startDate' =>  '20191220',
            'endDate' =>  '20191221',
        ],
        'state'=>'enable'
    ],
    [
        'portfolioId'=>1234567891,
        'name' =>  'My Portfolios three',
        'budget'=>[
            'amount'    =>  1.0,
            'policy'    =>  'monthlyRecurring',
            'endDate' =>  '20191221',
        ],
        'state'=>'enable'
    ],
];
$result = $app->portfolios->updatePortfolios($params);

[
    [
        "code": "SUCCESS",
        "portfolioId": 1234567890
    ],
    [
        "code": "SUCCESS",
        "portfolioId": 0123456789
    ],
    [
        "code": "SUCCESS",
        "portfolioId": 1234567891
    ]
]

SponsoredDisplay

入門

use easyAmazonAdv\Factory;

$config = [
    'clientId'      => 'amzn1.application-oa2-client.xxx',
    'clientSecret'  => '3b758af8d13ee02355764e4e864fxxxx',
    'refreshToken'   => 'Atzr|IwEBIL5GyUh_H2fdRJnFOk7mmpluKnm7WWUW0kf0tBxAXFMG5VHyiZuIhrspq6hZRHzPM03RMX7v64KrhXaO9xCtylMUQPcN0LolQhH8PNff76Ve5pS6PO9jtNG9kW1K9YtV1WcJDN3KnGpHjk0dUBtbbrn5uh8EGDDVUR_gpqaHXqqdvZ7vuUXTNzstH-tybiAzspzIPxPf7Ans-uyqPNyNTIIM61vA66fvPkH3-c33iLCzrgRtg_jhzWrZuH4K6INBfR8CjKHcK5oNun4DRTiOnCinvUdbHQPwAeI9m581FzUk2Hp4g5KaXO60A6-4me5EMuGSagWfUvTs1MkB1DgPAs_Do3v0TKKN1L6Vab4YgDu6k-bb5pgor_H_LQ24kbfc2Jdyq9BJkSVAAIP5Hh4y3i1qAh18g94Qq_yLWQOxu8ySawTUSDWOkM3_AH5qFS_Yaegfpc96nZE6_eDnycnnheFnXj14-ghaNsROG4LO2RE4n4xnpj9vx9o5aOFVGhf148Cz_VZjiZCg2t_V0Mru7uYRkwz1OUOxxxxxxxxxxx',
    'region'       => 'NA',
];

$app    = Factory::SponsoredDisplay($config);

設定profileId

$app->client->profileId = 1234567890;

Campaigns 廣告活動

getCampaign 廣告活動詳情

$result = $app->campaigns->listCampaigns(1234567890);

[
  "campaignId": 1234567890,
  "name": "CampaignOne",
  "tactic": "remarketing",
  "budgetType": "daily",
  "budget": "3.00",
  "startDate": "20190101",
  "endDate": null,
  "state": "enabled"
]

getCampaignEx 廣告活動詳情（支援擴充套件欄位展示）

$result = $app->campaigns->listCampaigns(1234567890);

[
  "campaignId": 1234567890,
  "name": "CampaignOne",
  "tactic": "remarketing",
  "budgetType": "daily",
  "budget": 0,
  "startDate": "20190101",
  "endDate": "20190102",
  "state": "enabled",
  "servingStatus": "ADVERTISER_STATUS_ENABLED",
  "creationDate": 0,
  "lastUpdatedDate": 0
]

createCampaigns 建立廣告活動

$params = [
    [
        "name" => "My Campaign One",
        "tactic" => "remarketing",
        "budgetType": "daily",
        "budget": 3.00,
        "startDate": "20190101",
        "endDate": null,
        "state": "enabled"
    ]
];

$result = $app->campaigns->createCampaigns(params);

[
  [
    "code": "SUCCESS",
    "campaignId": 173284463890123
  ]
]

updateCampaigns

$params = [
    [
        "campaignId" => 173284463890123,
        "name" => "Update Campaign One",
        "state" => "enabled",
        "budget" => 10.99
    ]
];

$result = $app->campaigns->updateCampaigns(params);

[
  [
    "code": "SUCCESS",
    "campaignId": 173284463890123
  ]
]

archiveCampaign 歸檔廣告活動

$result = $app->campaigns->archiveCampaign(173284463890123);

[
  "code": "SUCCESS",
  "campaignId": 1234567890
]

listCampaigns

$result = = $app->campaigns->listCampaigns(["stateFilter" => "enabled"]);

[
  [
    "campaignId": 1234567890,
    "name": "Campaign one",
    "tactic": "remarketing",
    "budgetType": "daily",
    "budget": "3.00",
    "startDate": "20190101",
    "endDate": null,
    "state": "enabled"
  ]
]

listCampaignsEx

$result = = $app->campaigns->listCampaignsEx(["stateFilter" => "enabled"]);

[
  [
    "campaignId": 1234567890,
    "name": "Campaign one",
    "tactic": "remarketing",
    "budgetType": "daily",
    "budget": 0,
    "startDate": "20190101",
    "endDate": "20190102",
    "state": "enabled",
    "servingStatus": "ADVERTISER_STATUS_ENABLED",
    "creationDate": 0,
    "lastUpdatedDate": 0
  ]
]

本作品採用《CC 協議》，轉載必須註明作者和本文連結

案例研究：亞馬遜廣告使用 PyTorch 和 Amazon Inferentia 擴充套件廣告處理模型
2022-03-22
亞馬遜PyTorch套件模型
C 擴充套件庫 – mysql API
2019-05-13
套件MySqlAPI
[外掛擴充套件]廣告外掛2.0
2020-04-04
套件
[擴充套件分享] 多多客 API SDK
2018-09-28
套件API
【擴充套件分享】多多客 API SDK
2018-09-28
套件API
如何擴充套件Kubernetes API？
2022-07-01
套件API
Airflow 中文文件：用Dask擴充套件
2018-11-29
AI套件
從零寫一個自動生成API文件的laravel擴充套件包
2020-10-11
APILaravel套件
在 easywechat 包上擴充套件 API 介面
2020-04-13
套件API
kotlin 擴充套件（擴充套件函式和擴充套件屬性）
2019-02-26
Kotlin套件函式
Atitit.一個cms有多少少擴充套件點，多少api wordpress cms有多少api。。擴充套件點...
2017-05-27
套件API
[外掛擴充套件]廣告圖片漂浮外掛
2019-05-11
套件
HTML5新增API之DOM 擴充套件
2019-03-22
HTMLAPI套件
WCF擴充套件：行為擴充套件Behavior Extension
2010-10-27
套件
(16) SpringCloud-Eureka的REST API及API擴充套件
2022-10-24
SpringGCCloudRESTAPI套件
【Kotlin】擴充套件屬性、擴充套件函式
2024-04-08
Kotlin套件函式
在亞馬遜AWS上擴充套件微服務架構(英文PPT)
2014-07-26
亞馬遜套件微服務架構
重構 - 設計API的擴充套件機制
2018-05-07
API套件
Chrome瀏覽器擴充套件開發系列之十七：擴充套件中可用的chrome.events API
2015-10-14
Chrome瀏覽器套件API
Sanic 擴充套件
2019-04-21
套件
ORACLE 擴充套件
2021-02-26
Oracle套件
擴充套件工具
2020-11-21
套件
擴充套件歐幾里得
2020-09-28
套件
DOM擴充套件
2017-03-02
套件
擴充套件ACL
2017-11-28
套件
Lua擴充套件
2016-08-16
套件
照片擴充套件
2015-05-28
套件
擴充套件篇
2015-05-22
套件
disable or 擴充套件
2011-08-01
套件
擴充套件表
2011-03-31
套件
Mybatis擴充套件
2024-08-14
MyBatis套件
使用aggregation API擴充套件你的kubernetes API
2022-06-22
API套件
JMeter 擴充套件開發：擴充套件 TCP 取樣器
2022-12-01
JMeter套件TCP
Chrome瀏覽器擴充套件開發系列之十六：擴充套件中可用的Chrome瀏覽器API
2015-10-12
Chrome瀏覽器套件API
BurpSuite 擴充套件開發[1]-API與HelloWold
2020-08-19
UI套件API
iOS13 Safari 廣告為何增多？蘋果將淘汰廣告攔截擴充套件
2019-09-24
iOS蘋果套件
?用Chrome擴充套件管理器, 管理你的擴充套件
2019-03-18
Chrome套件
ASP.NET Core擴充套件庫之Http通用擴充套件
2021-04-19
ASP.NET套件HTTP

亞馬遜廣告擴充套件 API v2 easy-Amazon-advertising 文件

概述

easy-amazon-advertising

環境需求

安裝

說明

BaseService

入門

RefreshToken

Profiles

listProfiles

設定profileId

Portfolios 廣告組合

listPortfolios 廣告組合列表

listPortfoliosEx 廣告組合列表擴充套件欄位

getPortfolio 廣告組合詳情

getPortfolioEx 廣告組合擴充套件欄位

createPortfolios 建立廣告組合（批量）

updatePortfolios 更新廣告組合（批量）

SponsoredDisplay

入門

設定profileId

Campaigns 廣告活動

getCampaign 廣告活動詳情

getCampaignEx 廣告活動詳情（支援擴充套件欄位展示）

createCampaigns 建立廣告活動

updateCampaigns

archiveCampaign 歸檔廣告活動

listCampaigns

listCampaignsEx

相關文章