Class SponsoredBrandsSnapshotOperation

Hierarchy

Constructors

constructor

Methods

downloadSnapshot getSnapshot requestSnapshot create

Constructors

constructor

Methods

downloadSnapshot

  • Downloads the snapshot corresponding to the success snapshot response specified

    Returns

    Type Parameters

    • T extends ({ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean } | { adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" } | { adGroupId: number; campaignId: number; keywordId: number; keywordText: string; matchType: "exact" | "broad" | "phrase"; state: "paused" | "enabled" | "archived" } & { bid: undefined | number } | { adGroupId: number; campaignId: number; keywordId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase"; state: "paused" | "enabled" | "archived" } | { campaignId: number; keywordId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase"; state: "enabled" | "deleted" } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string } | { adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number } | { adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number })[]

    Parameters

    • snapshot: { snapshotId: string } & { status: "SUCCESS" } & { expiration: undefined | Date; fileSize: undefined | number; location: undefined | string; statusDetails: undefined | string }

    Returns Promise<T>

getSnapshot

requestSnapshot

  • Request a file-based snapshot of all entities of the specified type in the account satisfying the filtering criteria

    Returns

    Parameters

    • recordType: "keywords" | "campaigns"
    • params: { stateFilter: undefined | "paused" | "enabled" | "archived" }
      • stateFilter: undefined | "paused" | "enabled" | "archived"

        Restricts results to entities with state within the specified comma-separated list. Must be one of: enabled, paused, archived. Default behavior is to include enabled and paused.

    Returns Promise<SnapshotResponse>

Static create

Settings

Member Visibility

Theme