Test: implement sponsored display targeting operation

src/amazon-advertising.ts

@@ -20,6 +20,7 @@ import { SponsoredProductsSuggestedKeywordsOperation } from './operations/keywor
 import { PortfolioOperation } from './operations/portfolios/portfolio-operation'
 import { SponsoredProductsProductAdsOperation } from './operations/product-ads/sponsored-products-product-ads-operation'
 import { SponsoredBrandsProductTargetingOperation } from './operations/product-targeting/sponsored-brands-product-targeting-operation'
+import { SponsoredDisplayTargetingOperation } from './operations/product-targeting/sponsored-display-targeting-operation'
 import { SponsoredProductsProductTargetingOperation } from './operations/product-targeting/sponsored-products-product-targeting-operation'
 import { ProfileOperation } from './operations/profiles/profile-operation'
 import { SponsoredBrandsBidRecommendationsOperation } from './operations/recommendations/sponsored-brands-bid-recommendations-operation'
@@ -130,6 +131,11 @@ export class AmazonAdvertising {
     return this.operationProvider.create(SponsoredBrandsProductTargetingOperation)
   }
 
+  @LazyGetter()
+  get sponsoredDisplayTargeting() {
+    return this.operationProvider.create(SponsoredDisplayTargetingOperation)
+  }
+
   @LazyGetter()
   get sponsoredProductsProductTargeting() {
     return this.operationProvider.create(SponsoredProductsProductTargetingOperation)

src/errors.ts

@@ -76,6 +76,8 @@ export class ResourceNotFoundError extends GenericError {}
 
 export class NotAcceptableError extends GenericError {}
 
+export class ForbiddenError extends GenericError {}
+
 export function apiErrorFactory(err: ErrorObject, headers: Headers): GenericError {
   switch (err.code) {
     case 'UNAUTHORIZED':
@@ -84,6 +86,8 @@ export function apiErrorFactory(err: ErrorObject, headers: Headers): GenericErro
       return new ResourceNotFoundError(err, headers)
     case '400':
       return new BadRequestError(err, headers)
+    case '403':
+      return new ForbiddenError(err, headers)
     case '406':
       return new NotAcceptableError(err, headers)
     case '422':

src/index.ts

@@ -19,6 +19,7 @@ export * from './operations/keywords/sponsored-products-suggested-keywords-opera
 export * from './operations/portfolios/portfolio-operation'
 export * from './operations/product-ads/sponsored-products-product-ads-operation'
 export * from './operations/product-targeting/sponsored-brands-product-targeting-operation'
+export * from './operations/product-targeting/sponsored-display-targeting-operation'
 export * from './operations/product-targeting/sponsored-products-product-targeting-operation'
 export * from './operations/profiles/profile-operation'
 export * from './operations/recommendations/sponsored-brands-bid-recommendations-operation'

src/operations/product-targeting/sponsored-display-targeting-operation.ts

@@ -0,0 +1,101 @@
+import { Operation } from '../operation'
+import { Decode, DecodeArray } from '../../decorators'
+import { AmazonAdTypeURIPrefix } from '../amazon-ad-type-uri-prefix'
+
+import {
+  TargetingClauseResponse,
+  CreateSponsoredDisplayTargetingClausesParams,
+  TargetId,
+  SponsoredDisplayTargetingClause,
+  SponsoredDisplayTargetingClauseExtended,
+  UpdateSponsoredDisplayTargetingClausesParams,
+  ListTargetingClausesParams,
+} from './types'
+
+export class SponsoredDisplayTargetingOperation extends Operation {
+  protected resource = `${this.version}/${AmazonAdTypeURIPrefix.SponsoredDisplay}/targets`
+
+  /**
+   * Gets a targeting clause specified by identifier.
+   *
+   * @param targetId -
+   * @returns
+   */
+  @Decode(SponsoredDisplayTargetingClause)
+  public getTargetingClause(targetId: TargetId) {
+    return this.client.get<SponsoredDisplayTargetingClause>(`${this.resource}/${targetId}`)
+  }
+
+  /**
+   * Gets extended information for a targeting clause.
+   *
+   * @param targetId -
+   * @returns
+   */
+  @Decode(SponsoredDisplayTargetingClauseExtended)
+  public getTargetingClauseExtended(targetId: TargetId) {
+    return this.client.get<SponsoredDisplayTargetingClauseExtended>(
+      `${this.resource}/extended/${targetId}`,
+    )
+  }
+
+  /**
+   * Creates one or more targeting clauses.
+   *
+   * @param params -
+   * @returns
+   */
+  @DecodeArray(TargetingClauseResponse)
+  public createTargetingClauses(params: CreateSponsoredDisplayTargetingClausesParams[]) {
+    return this.client.post<TargetingClauseResponse[]>(this.resource, params)
+  }
+
+  /**
+   * Update one or more targeting clauses.
+   *
+   * @param params -
+   * @returns
+   */
+  @DecodeArray(TargetingClauseResponse)
+  public updateTargetingClauses(params: UpdateSponsoredDisplayTargetingClausesParams[]) {
+    return this.client.put<TargetingClauseResponse[]>(this.resource, params)
+  }
+
+  /**
+   * Gets a list of targeting clauses.
+   *
+   * @param params -
+   * @returns
+   */
+  @DecodeArray(SponsoredDisplayTargetingClause)
+  public listTargetingClauses(params?: ListTargetingClausesParams) {
+    return this.client.get<SponsoredDisplayTargetingClause[]>(
+      this.paramsFilterTransformer(this.resource, params),
+    )
+  }
+
+  /**
+   * Gets a list of targeting clause objects with extended fields.
+   *
+   * @param params -
+   * @returns
+   */
+  @DecodeArray(SponsoredDisplayTargetingClauseExtended)
+  public listTargetingClausesExtended(params?: ListTargetingClausesParams) {
+    return this.client.get<SponsoredDisplayTargetingClauseExtended[]>(
+      this.paramsFilterTransformer(`${this.resource}/extended`, params),
+    )
+  }
+
+  /**
+   * Set the status of targeting clauses to archived.
+   * Equivalent to using the updateTargetingClauses operation to set the state property of a targeting clause to archived.
+   *
+   * @param targetId -
+   * @returns
+   */
+  @Decode(TargetingClauseResponse)
+  public archiveTargetingClause(targetId: TargetId) {
+    return this.client.delete<TargetingClauseResponse>(`${this.resource}/${targetId}`)
+  }
+}

src/operations/product-targeting/types.ts

@@ -1081,3 +1081,154 @@ export const SponsoredBrandsBatchGetNegativeTargetsResponse = t.strict({
 export type SponsoredBrandsBatchGetNegativeTargetsResponse = t.TypeOf<
   typeof SponsoredBrandsBatchGetNegativeTargetsResponse
 >
+
+// Sponsored Display Types
+
+export const SponsoredDisplayTargetingPredicateType = t.union([
+  t.literal('asinSameAs'),
+  t.literal('asinCategorySameAs'),
+  t.literal('asinBrandSameAs'),
+  t.literal('asinPriceBetween'),
+  t.literal('asinPriceGreaterThan'),
+  t.literal('asinPriceLessThan'),
+  t.literal('asinReviewRatingLessThan'),
+  t.literal('asinReviewRatingGreaterThan'),
+  t.literal('asinReviewRatingBetween'),
+  t.literal('similarProduct'),
+  t.literal('exactProduct'),
+  t.literal('asinIsPrimeShippingEligible'),
+  t.literal('asinAgeRangeSameAs'),
+  t.literal('asinGenreSameAs'),
+  t.literal('lookback'),
+  t.literal('negative'),
+])
+export type SponsoredDisplayTargetingPredicateType = t.TypeOf<
+  typeof SponsoredDisplayTargetingPredicateType
+>
+
+export const SponsoredDisplayTargetingPredicate = t.strict({
+  type: SponsoredDisplayTargetingPredicateType,
+
+  /**
+   * The value to be targeted.
+   */
+  value: t.string,
+})
+export type SponsoredDisplayTargetingPredicate = t.TypeOf<typeof SponsoredDisplayTargetingPredicate>
+
+export const SponsoredDisplayTargetingPredicateLegacy = t.strict({
+  type: SponsoredDisplayTargetingPredicateType,
+
+  /**
+   * The value to be targeted.
+   */
+  value: t.string,
+
+  /**
+   * The type of event that the value applies to. Only available for similarProduct and exactProduct currently.
+   */
+  eventType: t.literal('views'),
+})
+export type SponsoredDisplayTargetingPredicateLegacy = t.TypeOf<
+  typeof SponsoredDisplayTargetingPredicateLegacy
+>
+
+export const SponsoredDisplayTargetingPredicateNested = t.strict({
+  type: t.literal('views'),
+
+  value: t.array(SponsoredDisplayTargetingPredicate),
+})
+export type SponsoredDisplayTargetingPredicateNested = t.TypeOf<
+  typeof SponsoredDisplayTargetingPredicateNested
+>
+
+export const SponsoredDisplayTargetingExpression = t.union([
+  SponsoredDisplayTargetingPredicate,
+  SponsoredDisplayTargetingPredicateLegacy,
+  SponsoredDisplayTargetingPredicateNested,
+])
+export type SponsoredDisplayTargetingExpression = t.TypeOf<
+  typeof SponsoredDisplayTargetingExpression
+>
+
+export const CreateSponsoredDisplayTargetingClausesParams = t.strict({
+  /**
+   * The ID of the ad group to which this target belongs.
+   */
+  adGroupId: AdGroupId,
+
+  /**
+   * Advertiser-specified state of the target
+   */
+  state: TargetingClauseState,
+
+  /**
+   * The type of expression.
+   * Tactic T00020 ad groups only allow manual targeting.
+   */
+  expressionType: ExpressionType,
+
+  /**
+   * The bid will override the adGroup bid if specified. Bid is not allowed in negative targeting clauses.
+   */
+  bid: t.number,
+
+  /**
+   * The targeting expression to match against.
+   */
+  expression: t.array(SponsoredDisplayTargetingExpression),
+})
+export type CreateSponsoredDisplayTargetingClausesParams = t.TypeOf<
+  typeof CreateSponsoredDisplayTargetingClausesParams
+>
+
+export const UpdateSponsoredDisplayTargetingClausesParams = t.intersection([
+  t.strict({
+    targetId: TargetId,
+  }),
+  t.partial({
+    /**
+     * The bid will override the adGroup bid if specified. Bid is not allowed in negative targeting clauses.
+     */
+    bid: t.number,
+
+    /**
+     * Advertiser-specified state of the target
+     */
+    state: TargetingClauseState,
+  }),
+])
+export type UpdateSponsoredDisplayTargetingClausesParams = t.TypeOf<
+  typeof UpdateSponsoredDisplayTargetingClausesParams
+>
+
+export const SponsoredDisplayTargetingClause = t.intersection([
+  CreateSponsoredDisplayTargetingClausesParams,
+  t.strict({
+    targetId: TargetId,
+  }),
+])
+export type SponsoredDisplayTargetingClause = t.TypeOf<typeof SponsoredDisplayTargetingClause>
+
+export const SponsoredDisplayTargetingClauseExtended = t.intersection([
+  SponsoredDisplayTargetingClause,
+  t.strict({
+    /**
+     * The date the ad group was created as epoch time in milliseconds.
+     */
+    creationDate: DateFromNumber,
+
+    /**
+     * The date the ad group was last updated as epoch time in milliseconds.
+     */
+    lastUpdatedDate: DateFromNumber,
+
+    /**
+     * The computed status, accounting for out of budget, policy violations, etc. See developer notes for more information.
+     */
+    servingStatus: TargetingClauseServingStatus,
+  }),
+])
+export type SponsoredDisplayTargetingClauseExtended = t.TypeOf<
+  typeof SponsoredDisplayTargetingClauseExtended
+>

test/__recordings__/SponsoredDisplayAdGroupOperation_3544596599/createAdGroups_767840800/should-create-an-ad-group_2863360381/recording.har

@@ -79,13 +79,13 @@
           "url": "https://advertising-api-test.amazon.com/v2/sp/adGroups"
         },
         "response": {
-          "bodySize": 47,
+          "bodySize": 48,
           "content": {
             "mimeType": "application/json",
-            "size": 47,
+            "size": 48,
             "text": [
               {
-                "adGroupId": 83691965128172,
+                "adGroupId": 257081908560802,
                 "code": "SUCCESS"
               }
             ]
@@ -98,7 +98,7 @@
             },
             {
               "name": "date",
-              "value": "Sun, 16 Aug 2020 15:31:22 GMT"
+              "value": "Sat, 22 Aug 2020 10:34:20 GMT"
             },
             {
               "name": "content-type",
@@ -114,7 +114,7 @@
             },
             {
               "name": "x-amz-request-id",
-              "value": "GGAFQ77G4ZTQPE1SZKX7"
+              "value": "R6KGFJ3BW61GJ0MS5HKX"
             },
             {
               "name": "vary",
@@ -127,16 +127,16 @@
           "status": 207,
           "statusText": "Multi-Status"
         },
-        "startedDateTime": "2020-08-16T15:31:22.703Z",
-        "time": 203,
+        "startedDateTime": "2020-08-22T10:34:20.757Z",
+        "time": 156,
         "timings": {
           "blocked": -1,
           "connect": -1,
           "dns": -1,
           "receive": 0,
           "send": 0,
           "ssl": -1,
-          "wait": 203
+          "wait": 156
         }
       }
     ],