Class SponsoredBrandsProductTargetingOperation

Hierarchy

  • Operation
    • SponsoredBrandsProductTargetingOperation

Constructors

constructor

Methods

archiveTarget batchGetTargets createTargets getTarget listTargets updateTargets create

Constructors

constructor

Methods

archiveTarget

  • Archives a target specified by identifier. Note that archiving is permanent, and once a target has been archived it can't be made active again.

    Returns

    Parameters

    • targetId: number

    Returns Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }>

batchGetTargets

  • Gets one or more product targets specified by identifiers.

    Returns

    Parameters

    • params: { targetIds: number[] }
      • targetIds: number[]

    Returns Promise<{ batchGetTargetErrorResults: ({ code: string; details: string; targetId: number; targetRequestIndex: number; })[]; batchGetTargetSuccessResults: ({ targetingClause: { targetId: number; adGroupId: number; campaignId: number; expressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; resolvedExpressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; state: "paused" | "pending" | "enabled" | "archived" | "draft"; bid: number; }; targetRequestIndex: number; })[] }>

createTargets

  • Create one or more new targets.

    Returns

    Parameters

    • params: { targets: ({ adGroupId: number; campaignId: number; expressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; bid: number; })[] }
      • targets: ({ adGroupId: number; campaignId: number; expressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; bid: number; })[]

    Returns Promise<{ createTargetErrorResults: ({ code: string; details: string; targetId: number; targetRequestIndex: number; })[]; createTargetSuccessResults: ({ targetRequestIndex: number; targetId: number; })[] }>

getTarget

  • Gets a target specified by identifier.

    Returns

    Parameters

    • targetId: number

    Returns Promise<{ adGroupId: number; bid: number; campaignId: number; expressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; resolvedExpressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; state: "paused" | "pending" | "enabled" | "archived" | "draft"; targetId: number }>

listTargets

  • Gets a list of product targets associated with the client identifier passed in the authorization header, filtered by specified criteria.

    Returns

    Parameters

    • params: { filters: ({ filterType: "STATE" | "CAMPAIGN_ID" | "AD_GROUP_ID"; values: (number | "ENABLED" | "PAUSED" | "PENDING" | "ARCHIVED" | "DRAFT")[]; })[]; maxResults: number; nextToken: string }
      • filters: ({ filterType: "STATE" | "CAMPAIGN_ID" | "AD_GROUP_ID"; values: (number | "ENABLED" | "PAUSED" | "PENDING" | "ARCHIVED" | "DRAFT")[]; })[]

        Restricts results to targets with the specified filters. Filters are inclusive. Filters are joined using 'and' logic. Specify one type of each filter. Specifying multiples of the same type of filter results in an error.

      • maxResults: number

        Sets a limit on the number of results returned by an operation.

      • nextToken: string

        Operations that return paginated results include a pagination token in this field. To retrieve the next page of results, call the same operation and specify this token in the request. If the NextToken field is empty, there are no further results.

    Returns Promise<{ nextToken: string; targets: ({ targetId: number; adGroupId: number; campaignId: number; expressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; resolvedExpressions: { type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs"; value: string; }; state: "paused" | "pending" | "enabled" | "archived" | "draft"; bid: number; })[] }>

updateTargets

  • Updates one or more targets.

    Returns

    Parameters

    • params: { adGroupId: undefined | number; bid: undefined | number; campaignId: undefined | number; state: undefined | "paused" | "pending" | "enabled" | "archived" | "draft"; targetId: undefined | number }[]

    Returns Promise<{ updateTargetErrorResults: ({ code: string; details: string; targetId: number; targetRequestIndex: number; })[]; updateTargetSuccessResults: ({ targetId: number; targetRequestIndex: number; })[] }>

Static create

Settings

Member Visibility

Theme