cedricziel/amznprofilesapiphp

An API client for Amazon Advertising profiles

v1.1.3 2024-08-06 16:03 UTC

Requires

• php: ^8.3
• jane-php/open-api-runtime: ^7.8

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.59
• jane-php/open-api-3: ^7.8
• symfony/yaml: ^7.1

MIT

• cedricziel

README

PHP Client for the Amazon Advertising Profiles API

composer require cedricziel/amznprofilesapiphp

Docs

General

Instantiate a client, configure your secrets and continue to use:

use CedricZiel\AmznAdvertisingProfilesApi\AdvertisingProfilesClient;
use CedricZiel\AmznAdvertisingProfilesApi\Endpoint;
use CedricZiel\AmznAdvertisingProfilesApi\Header;

// You need to obtain a token via the Amazon LwA workflow
$token = '..';

$client = AdvertisingProfilesClient::createFor(
    Endpoint::Europe,
    $token,
);

// execute the endpoint of choice, see below ...
$client->listProfiles([], [Header::AmazonAdvertisingApiClientId->value => $clientId]);

listProfiles - get /v2/profiles

Gets a list of profiles.

Note that this operation does not return a response unless the current account has created at least one campaign using the advertising console.

use CedricZiel\AmznAdvertisingProfilesApi\AdvertisingProfilesClient;
use CedricZiel\AmznAdvertisingProfilesApi\Endpoint;
use CedricZiel\AmznAdvertisingProfilesApi\Header;
// see above how to create a client
$accessToken = '...';
$clientId = '...';
$client = AdvertisingProfilesClient::createFor(Endpoint::Europe, $accessToken);
$client->listProfiles([], [Header::AmazonAdvertisingApiClientId->value => $clientId]);

updateProfiles - put /v2/profiles

Update the daily budget for one or more profiles.

Note that this operation is only used for Sellers using Sponsored Products. This operation is not enabled for vendor type accounts.

use CedricZiel\AmznAdvertisingProfilesApi\AdvertisingProfilesClient;
use CedricZiel\AmznAdvertisingProfilesApi\Endpoint;
use CedricZiel\AmznAdvertisingProfilesApi\Header;
// see above how to create a client
$accessToken = '...';
$clientId = '...';
$client = AdvertisingProfilesClient::createFor(Endpoint::Europe, $accessToken);
$client->updateProfiles([], [Header::AmazonAdvertisingApiClientId->value => $clientId]);

getProfileById - get /v2/profiles/{profileId}

Gets a profile specified by identifier.

This operation does not return a response unless the current account has created at least one campaign using the advertising console.

use CedricZiel\AmznAdvertisingProfilesApi\AdvertisingProfilesClient;
use CedricZiel\AmznAdvertisingProfilesApi\Endpoint;
use CedricZiel\AmznAdvertisingProfilesApi\Header;
// see above how to create a client
$accessToken = '...';
$clientId = '...';
$client = AdvertisingProfilesClient::createFor(Endpoint::Europe, $accessToken);
$client->getProfileById([], [Header::AmazonAdvertisingApiClientId->value => $clientId]);

License

Apache 2.0