/AmazonAdsGenerated

.NET 7 Client generated by OpenApi Generator for Amazon Advertising API

Primary LanguageC#

Amazon.Advertising.SponsoredProducts - the C# library for the Sponsored Products

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 3.0
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Amazon.Advertising.SponsoredProducts.Api;
using Amazon.Advertising.SponsoredProducts.Client;
using Amazon.Advertising.SponsoredProducts.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Amazon.Advertising.SponsoredProducts.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Amazon.Advertising.SponsoredProducts.Api;
using Amazon.Advertising.SponsoredProducts.Client;
using Amazon.Advertising.SponsoredProducts.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            var apiInstance = new AdGroupsApi(config);
            var amazonAdvertisingAPIClientId = "amazonAdvertisingAPIClientId_example";  // string | The identifier of a client associated with a \"Login with Amazon\" account.
            var amazonAdvertisingAPIScope = "amazonAdvertisingAPIScope_example";  // string | The identifier of a profile associated with the advertiser account. Use GET method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.
            var sponsoredProductsCreateSponsoredProductsAdGroupsRequestContent = new SponsoredProductsCreateSponsoredProductsAdGroupsRequestContent(); // SponsoredProductsCreateSponsoredProductsAdGroupsRequestContent | 
            var prefer = "prefer_example";  // string? | The \"Prefer\" header, as defined in [RFC7240], allows clients to request certain behavior from the service. The service ignores preference values that are either not supported or not known by the service. Either multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent Supported preferences: return=representation - return the full object when doing create/update/delete operations instead of ids (optional) 

            try
            {
                SponsoredProductsCreateSponsoredProductsAdGroupsResponseContent result = apiInstance.CreateSponsoredProductsAdGroups(amazonAdvertisingAPIClientId, amazonAdvertisingAPIScope, sponsoredProductsCreateSponsoredProductsAdGroupsRequestContent, prefer);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdGroupsApi.CreateSponsoredProductsAdGroups: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdGroupsApi CreateSponsoredProductsAdGroups POST /sp/adGroups
AdGroupsApi DeleteSponsoredProductsAdGroups POST /sp/adGroups/delete
AdGroupsApi ListSponsoredProductsAdGroups POST /sp/adGroups/list
AdGroupsApi UpdateSponsoredProductsAdGroups PUT /sp/adGroups
BudgetRecommendationNewCampaignsApi GetBudgetRecommendation POST /sp/campaigns/initialBudgetRecommendation
BudgetRecommendationsAndMissedOpportunitiesApi GetBudgetRecommendations POST /sp/campaigns/budgetRecommendations Get recommended daily budget and estimated missed opportunities for campaigns.
BudgetRulesApi CreateAssociatedBudgetRulesForSPCampaigns POST /sp/campaigns/{campaignId}/budgetRules Associates one or more budget rules to a campaign specified by identifer.
BudgetRulesApi CreateBudgetRulesForSPCampaigns POST /sp/budgetRules Creates one or more budget rules.
BudgetRulesApi DisassociateAssociatedBudgetRuleForSPCampaigns DELETE /sp/campaigns/{campaignId}/budgetRules/{budgetRuleId} Disassociates a budget rule specified by identifier from a campaign specified by identifier.
BudgetRulesApi GetBudgetRuleByRuleIdForSPCampaigns GET /sp/budgetRules/{budgetRuleId} Gets a budget rule specified by identifier.
BudgetRulesApi GetCampaignsAssociatedWithSPBudgetRule GET /sp/budgetRules/{budgetRuleId}/campaigns Gets all the campaigns associated with a budget rule
BudgetRulesApi GetRuleBasedBudgetHistoryForSPCampaigns GET /sp/campaigns/{campaignId}/budgetRules/budgetHistory Gets the budget history for a campaign specified by identifier.
BudgetRulesApi GetSPBudgetRulesForAdvertiser GET /sp/budgetRules Get all budget rules created by an advertiser
BudgetRulesApi ListAssociatedBudgetRulesForSPCampaigns GET /sp/campaigns/{campaignId}/budgetRules Gets a list of budget rules associated to a campaign specified by identifier.
BudgetRulesApi UpdateBudgetRulesForSPCampaigns PUT /sp/budgetRules Updates one or more budget rules.
BudgetRulesRecommendationApi SPGetBudgetRulesRecommendation POST /sp/campaigns/budgetRules/recommendations Gets a list of special events with suggested date range and suggested budget increase for a campaign specified by identifier.
BudgetUsageApi SpCampaignsBudgetUsage POST /sp/campaigns/budget/usage Budget usage API for SP campaigns
CampaignNegativeKeywordsApi CreateSponsoredProductsCampaignNegativeKeywords POST /sp/campaignNegativeKeywords
CampaignNegativeKeywordsApi DeleteSponsoredProductsCampaignNegativeKeywords POST /sp/campaignNegativeKeywords/delete
CampaignNegativeKeywordsApi ListSponsoredProductsCampaignNegativeKeywords POST /sp/campaignNegativeKeywords/list
CampaignNegativeKeywordsApi UpdateSponsoredProductsCampaignNegativeKeywords PUT /sp/campaignNegativeKeywords
CampaignNegativeTargetingClausesApi CreateSponsoredProductsCampaignNegativeTargetingClauses POST /sp/campaignNegativeTargets
CampaignNegativeTargetingClausesApi DeleteSponsoredProductsCampaignNegativeTargetingClauses POST /sp/campaignNegativeTargets/delete
CampaignNegativeTargetingClausesApi ListSponsoredProductsCampaignNegativeTargetingClauses POST /sp/campaignNegativeTargets/list
CampaignNegativeTargetingClausesApi UpdateSponsoredProductsCampaignNegativeTargetingClauses PUT /sp/campaignNegativeTargets
CampaignOptimizationRulesApi CreateOptimizationRule POST /sp/rules/campaignOptimization Creates a campaign optimization rule.
CampaignOptimizationRulesApi DeleteCampaignOptimizationRule DELETE /sp/rules/campaignOptimization/{campaignOptimizationId} Deletes a campaign optimization rule specified by identifier.
CampaignOptimizationRulesApi GetCampaignOptimizationRule GET /sp/rules/campaignOptimization/{campaignOptimizationId} Gets a campaign optimization rule specified by identifier.
CampaignOptimizationRulesApi GetOptimizationRuleEligibility POST /sp/rules/campaignOptimization/eligibility Gets a campaign optimization rule recommendation for SP campaigns.
CampaignOptimizationRulesApi GetRuleNotification POST /sp/rules/campaignOptimization/state Gets campaign optimization rule state. Recommended refresh frequency is once a day.
CampaignOptimizationRulesApi UpdateOptimizationRule PUT /sp/rules/campaignOptimization Updates a campaign optimization rule.
CampaignsApi CreateSponsoredProductsCampaigns POST /sp/campaigns
CampaignsApi DeleteSponsoredProductsCampaigns POST /sp/campaigns/delete
CampaignsApi ListSponsoredProductsCampaigns POST /sp/campaigns/list
CampaignsApi UpdateSponsoredProductsCampaigns PUT /sp/campaigns
ConsolidatedRecommendationsApi GetCampaignRecommendations GET /sp/campaign/recommendations
KeywordRecommendationsApi GetRankedKeywordRecommendation POST /sp/targets/keywords/recommendations Get keyword recommendations
KeywordsApi CreateSponsoredProductsKeywords POST /sp/keywords
KeywordsApi DeleteSponsoredProductsKeywords POST /sp/keywords/delete
KeywordsApi ListSponsoredProductsKeywords POST /sp/keywords/list
KeywordsApi UpdateSponsoredProductsKeywords PUT /sp/keywords
NegativeKeywordsApi CreateSponsoredProductsNegativeKeywords POST /sp/negativeKeywords
NegativeKeywordsApi DeleteSponsoredProductsNegativeKeywords POST /sp/negativeKeywords/delete
NegativeKeywordsApi ListSponsoredProductsNegativeKeywords POST /sp/negativeKeywords/list
NegativeKeywordsApi UpdateSponsoredProductsNegativeKeywords PUT /sp/negativeKeywords
NegativeTargetingClausesApi CreateSponsoredProductsNegativeTargetingClauses POST /sp/negativeTargets
NegativeTargetingClausesApi DeleteSponsoredProductsNegativeTargetingClauses POST /sp/negativeTargets/delete
NegativeTargetingClausesApi ListSponsoredProductsNegativeTargetingClauses POST /sp/negativeTargets/list
NegativeTargetingClausesApi UpdateSponsoredProductsNegativeTargetingClauses PUT /sp/negativeTargets
ProductAdsApi CreateSponsoredProductsProductAds POST /sp/productAds
ProductAdsApi DeleteSponsoredProductsProductAds POST /sp/productAds/delete
ProductAdsApi ListSponsoredProductsProductAds POST /sp/productAds/list
ProductAdsApi UpdateSponsoredProductsProductAds PUT /sp/productAds
ProductRecommendationServiceApi GetProductRecommendations POST /sp/targets/products/recommendations Suggested target ASINs for your advertised product
ProductTargetingApi GetCategoryRecommendationsForASINs POST /sp/targets/categories/recommendations Returns a list of category recommendations for the input list of ASINs.
ProductTargetingApi GetNegativeBrands GET /sp/negativeTargets/brands/recommendations Returns brands recommended for negative targeting.
ProductTargetingApi GetRefinementsForCategory GET /sp/targets/category/{categoryId}/refinements Returns refinements according to category input.
ProductTargetingApi GetTargetableASINCounts POST /sp/targets/products/count Get number of targetable asins based on refinements provided by the user.
ProductTargetingApi GetTargetableCategories GET /sp/targets/categories Returns all targetable categories.
ProductTargetingApi SearchBrands POST /sp/negativeTargets/brands/search Returns brands related to keyword input for negative targeting.
TargetingClausesApi CreateSponsoredProductsTargetingClauses POST /sp/targets
TargetingClausesApi DeleteSponsoredProductsTargetingClauses POST /sp/targets/delete
TargetingClausesApi ListSponsoredProductsTargetingClauses POST /sp/targets/list
TargetingClausesApi UpdateSponsoredProductsTargetingClauses PUT /sp/targets
ThemeBasedBidRecommendationApi GetThemeBasedBidRecommendationForAdGroupV1 POST /sp/targets/bid/recommendations This API is currently available in US, UK, DE, CA, JP, IN, ES, and FR. The API supports keyword and auto targets only. The API will return a 422 response when an unsupported marketplace or target is provided. For product targets in all marketplaces, and keyword or auto targets in other marketplaces, call /v2/sp/targets/bidRecommendations.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.