Download the PHP package rams007/amazon-advertising-api-php-sdk without Composer

On this page you can find all versions of the php package rams007/amazon-advertising-api-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package amazon-advertising-api-php-sdk

No Maintenance Intended

Synopsis

Official Amazon Advertising API PHP client library.

This repository has been deprecated and will no longer receive updates.

Requirements

PHP >= 5.3.0
cURL >= 7.18

Documentation

API Reference
Access Request
Getting Started

Tutorials

Register Sandbox Profile - This tutorial will show you how to register a profile in sandbox using CURL.
Generate and download a report using CURL - You will need to complete registering a profile in sandbox prior to doing this tutorial.

Sandbox self-service

If you would like to test the API in sandbox you will need to register a profile for the region in which you would like to test. The registerProfile API call can be made to do this. Make sure you instantiate the client in sandbox mode before making this call or it will fail.

The following country codes are available for testing.

US, CA, UK, DE, FR, ES, IT, IN, CN, JP

Quick Start

Instantiate the client

You can pass in accessToken if you do not have a refresh token.

Refresh access token

You can refresh your access token when it expires by using the following method. The new access token will be in the request response. This method will set it for you so it's mainly for reference if you need it.

Get a list of profiles

Set profile Id

Once you've set the profile Id you are ready to start making API calls.

Example API Calls

getProfile

Retrieves a single profile by Id.


updateProfiles

Updates one or more profiles. Advertisers are identified using their profileIds.


listCampaigns

Retrieves a list of campaigns satisfying optional criteria.


getCampaign

Retrieves a campaign by Id. Note that this call returns the minimal set of campaign fields, but is more efficient than getCampaignEx.


createCampaigns

Creates one or more campaigns. Successfully created campaigns will be assigned unique campaignIds.


updateCampaigns

Updates one or more campaigns. Campaigns are identified using their campaignIds.


archiveCampaign

Sets the campaign status to archived. This same operation can be performed via an update, but is included for completeness.


listCampaignsBrand

Retrieves a list of campaigns satisfying optional criteria. Used for Sponsored Brands.


getCampaignBrand

Retrieves a campaign by Id. Used for Sponsored Brands.


updateCampaignsBrand

Updates one or more campaigns. Campaigns are identified using their campaignIds. Used for Sponsored Brands.


archiveCampaignBrand

Sets the campaign status to archived. This same operation can be performed via an update, but is included for completeness. Used for Sponsored Brands.


listAdGroups

Retrieves a list of ad groups satisfying optional criteria.


getAdGroup

Retrieves an ad group by Id. Note that this call returns the minimal set of ad group fields, but is more efficient than getAdGroupEx.


createAdGroups

Creates one or more ad groups. Successfully created ad groups will be assigned unique adGroupIds.


updateAdGroups

Updates one or more ad groups. Ad groups are identified using their adGroupIds.


archiveAdGroup

Sets the ad group status to archived. This same operation can be performed via an update, but is included for completeness.


listBiddableKeywords

Retrieves a list of keywords satisfying optional criteria.


getBiddableKeyword

Retrieves a keyword by Id. Note that this call returns the minimal set of keyword fields, but is more efficient than getBiddableKeywordEx.


createBiddableKeywords

Creates one or more keywords. Successfully created keywords will be assigned unique keywordIds.


updateBiddableKeywords

Updates one or more keywords. Keywords are identified using their keywordIds.


archiveBiddableKeyword

Sets the keyword status to archived. This same operation can be performed via an update, but is included for completeness.


getBiddableKeywordBrand

Retrieves a keyword by Id. Note that this call returns the minimal set of keyword fields, but is more efficient than getBiddableKeywordEx. Used for Sponsored Brands.


createBiddableKeywordsBrand

Creates one or more keywords. Successfully created keywords will be assigned unique keywordIds. Used for Sponsored Brands.


updateBiddableKeywordsBrand

Updates one or more keywords. Keywords are identified using their keywordIds. Used for Sponsored Brands.


archiveBiddableKeywordBrand

Sets the keyword status to archived. This same operation can be performed via an update, but is included for completeness. Used for Sponsored Brands.


listNegativeKeywords

Retrieves a list of negative keywords satisfying optional criteria.


getNegativeKeyword

Retrieves a negative keyword by Id. Note that this call returns the minimal set of keyword fields, but is more efficient than getNegativeKeywordEx.


createNegativeKeywords

Creates one or more negative keywords. Successfully created keywords will be assigned unique keywordIds.


updateNegativeKeywords

Updates one or more negative keywords. Keywords are identified using their keywordIds.


archiveNegativeKeyword

Sets the negative keyword status to archived. This same operation can be performed via an update to the status, but is included for completeness.


listCampaignNegativeKeywords

Retrieves a list of negative campaign keywords satisfying optional criteria.


getCampaignNegativeKeyword

Retrieves a campaign negative keyword by Id. Note that this call returns the minimal set of keyword fields, but is more efficient than getCampaignNegativeKeywordEx.


createCampaignNegativeKeywords

Creates one or more campaign negative keywords. Successfully created keywords will be assigned unique keywordIds.


updateCampaignNegativeKeywords

Updates one or more campaign negative keywords. Keywords are identified using their keywordIds.

Campaign negative keywords can currently only be removed.


removeCampaignNegativeKeyword

Sets the campaign negative keyword status to deleted. This same operation can be performed via an update to the status, but is included for completeness.


listProductAds

Retrieves a list of product ads satisfying optional criteria.


getProductAd

Retrieves a product ad by Id. Note that this call returns the minimal set of product ad fields, but is more efficient than getProductAdEx.


createProductAds

Creates one or more product ads. Successfully created product ads will be assigned unique adIds.


updateProductAds

Updates one or more product ads. Product ads are identified using their adIds.


archiveProductAd

Sets the product ad status to archived. This same operation can be performed via an update, but is included for completeness.


requestSnapshot

Request a snapshot report for all entities of a single type.


requestSnapshotBrand

Request a snapshot report for all entities of a single type. Used for Sponsored Brands.


getSnapshot

Retrieve a previously requested report.


requestReport

Request a customized performance report for all entities of a single type which have performance data to report.


requestReportBrand

Request a customized performance report for all entities of a single type which have performance data to report.


requestReportSearchTerm

Search-terms report for auto-targeted campaigns generated before 11/14/2018 can be accessed from the endpoint: /v2/sp/keywords/report Search-terms report for auto-targeted campaigns generated on-and-after 11/14/2018 can be accessed from the endpoint: /v2/sp/targets/report Use query-segmentation to retrieve a search-terms report.


getReport

Retrieve a previously requested report.

Sandbox will return dummy data.


getAdGroupBidRecommendations

Request bid recommendations for specified ad group.


getKeywordBidRecommendations

Request bid recommendations for specified keyword.


bulkGetKeywordBidRecommendations

Request bid recommendations for a list of up to 100 keywords.


getAdGroupKeywordSuggestions

Request keyword suggestions for specified ad group.


getAdGroupKeywordSuggestionsEx

Request keyword suggestions for specified ad group, extended version. Adds the ability to return bid recommendation for returned keywords.


getAsinKeywordSuggestions

Request keyword suggestions for specified asin.


bulkGetAsinKeywordSuggestions

Request keyword suggestions for a list of asin.


getTargetingClause

Retrieve a targeting clause with a specific target ID.


listTargetingClauses

Retrieves a list of targeting clauses.


getTargetingClauseEx

Retrieve a targeting clause with additional attributes using a specific target ID.


listTargetingClausesEx

Retrieve a list of targeting clauses with extended properties.


createTargetingClauses

Creates one or more targeting expressions.


updateTargetingClauses

Update one or more targeting clauses.


archiveTargetingClause

Set the status of targeting clauses to archived. This same operation can also be performed via an update (PUT method), but is included for completeness. Archived entities cannot be made active again.


getTargetingCategories

Get list of targeting categories.


getBrandRecommendations

Get recommended brands for Sponsored Products. Only one parameter (keyword or categoryId) per request is allowed.


getNegativeTargetingClause

Get a specific negative targeting clause by targetId.


getNegativeTargetingClauseEx

Retrieve a negative targeting clause with additional attributes using a specific target ID.


createNegativeTargetingClauses

Create negative targeting clauses at the campaign level.


listNegativeTargetingClauses

Retrieves a list of negative targeting clauses.


listNegativeTargetingClausesEx

Retrieve a list of targeting clauses with extended properties.


archiveNegativeTargetingClause

Archive negative targeting clauses.


updateNegativeTargetingClauses

Update negative targeting clauses.

getHistoryData

Get history data.


All versions of amazon-advertising-api-php-sdk with dependencies

PHP Build Version
Package Version
Requires ext-curl Version *
php Version >=5.3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rams007/amazon-advertising-api-php-sdk contains the following files

Loading the files please wait ....