ebay-api 8.2.0 → 8.3.0

package/dist/types/restfulTypes.d.ts

@@ -477,6 +477,96 @@ export type CreateAdRequest = {
 export type BulkCreateAdRequest = {
     requests: CreateAdRequest[];
 };
+export type AdStatus = 'ACTIVE' | 'PAUSED' | 'ARCHIVED';
+export type UpdateAdStatusRequest = {
+    adId: string;
+    adStatus: AdStatus;
+};
+export type BulkUpdateAdStatusRequest = {
+    items: UpdateAdStatusRequest[];
+};
+export type UpdateAdStatusByListingIdRequest = {
+    adGroupId: string;
+    adStatus: AdStatus;
+    listingId: string;
+};
+export type BulkUpdateAdStatusByListingIdRequest = {
+    items: UpdateAdStatusByListingIdRequest[];
+};
+export type CreateAdGroupRequest = {
+    defaultBid: Amount;
+    name: string;
+};
+export type AdGroupStatus = 'ACTIVE' | 'PAUSED' | 'ARCHIVED';
+export type UpdateAdGroupRequest = {
+    adGroupStatus: AdGroupStatus;
+    defaultBid: Amount;
+    name: string;
+};
+export type KeywordRequest = {
+    keywordText: string;
+    matchType: string;
+};
+export type TargetedBidRequest = {
+    keywords: KeywordRequest[];
+};
+export type TargetedKeywordRequest = {
+    additionalInfo: string[];
+    exclusions: string[];
+    listingIds: string[];
+    matchType: string;
+};
+export type DynamicAdRatePreference = {
+    adRateAdjustmentPercent: string;
+    adRateCapPercent: string;
+};
+export type UpdateAdrateStrategyRequest = {
+    adRateStrategy: string;
+    bidPercentage: string;
+    dynamicAdRatePreferences: DynamicAdRatePreference[];
+};
+export type BudgetRequest = {
+    amount: Amount;
+};
+export type UpdateCampaignBudgetRequest = {
+    daily: BudgetRequest;
+};
+export type CreateKeywordRequest = {
+    adGroupId: string;
+    bid: Amount;
+    keywordText: string;
+    matchType: string;
+};
+export type UpdateKeywordRequest = {
+    bid: Amount;
+    keywordStatus: string;
+};
+export type UpdateKeywordByKeywordIdRequest = {
+    bid: Amount;
+    keywordId: string;
+    keywordStatus: string;
+};
+export type BulkCreateKeywordRequest = {
+    requests: CreateKeywordRequest[];
+};
+export type BulkUpdateKeywordRequest = {
+    requests: UpdateKeywordByKeywordIdRequest[];
+};
+export type CreateNegativeKeywordRequest = {
+    adGroupId: string;
+    campaignId: string;
+    negativeKeywordMatchType: string;
+    negativeKeywordText: string;
+};
+export type BulkCreateNegativeKeywordRequest = {
+    requests: CreateNegativeKeywordRequest[];
+};
+export type BulkUpdateNegativeKeywordRequest = {
+    requests: CreateNegativeKeywordRequest[];
+};
+export type UpdateNegativeKeywordRequest = {
+    negativeKeywordStatus: string;
+};
 export type DeleteAdsByInventoryReferenceRequest = {
     inventoryReferenceId: string;
     inventoryReferenceType: string;

package/lib/api/restful/sell/marketing/index.d.ts

@@ -1,5 +1,5 @@
+import { BulkCreateAdRequest, BulkCreateAdsByInventoryReferenceRequest, BulkCreateKeywordRequest, BulkCreateNegativeKeywordRequest, BulkDeleteAdRequest, BulkDeleteAdsByInventoryReferenceRequest, BulkUpdateAdStatusByListingIdRequest, BulkUpdateAdStatusRequest, BulkUpdateKeywordRequest, BulkUpdateNegativeKeywordRequest, CloneCampaignRequest, CreateAdGroupRequest, CreateAdRequest, CreateAdsByInventoryReferenceRequest, CreateCampaignRequest, CreateKeywordRequest, CreateNegativeKeywordRequest, CreateReportTask, ItemPriceMarkdown, ItemPromotion, TargetedBidRequest, TargetedKeywordRequest, UpdateAdGroupRequest, UpdateAdrateStrategyRequest, UpdateBidPercentageRequest, UpdateCampaignBudgetRequest, UpdateCampaignIdentificationRequest, UpdateKeywordRequest, UpdateNegativeKeywordRequest } from '../../../../types/index.js';
 import Restful from '../../index.js';
-import { BulkCreateAdRequest, BulkCreateAdsByInventoryReferenceRequest, BulkDeleteAdRequest, BulkDeleteAdsByInventoryReferenceRequest, CloneCampaignRequest, CreateAdRequest, CreateAdsByInventoryReferenceRequest, CreateCampaignRequest, CreateReportTask, ItemPriceMarkdown, ItemPromotion, UpdateBidPercentageRequest, UpdateCampaignIdentificationRequest } from '../../../../types/index.js';
 /**
  * <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:
  * </p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i>
@@ -61,6 +61,22 @@ export default class Marketing extends Restful {
      * @param body Container for the bulk request to update ads.
      */
     bulkUpdateAdsBidByListingId(campaignId: string, body: BulkCreateAdRequest): Promise<any>;
+    /**
+     * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body The bulk request to update the ads.
+     */
+    bulkUpdateAdsStatus(campaignId: string, body: BulkUpdateAdStatusRequest): Promise<any>;
+    /**
+     * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body The bulk request to update ads.
+     */
+    bulkUpdateAdsStatusByListingId(campaignId: string, body: BulkUpdateAdStatusByListingIdRequest): Promise<any>;
     /**
      * This method retrieves all the ads for the specified campaign.
      *
@@ -140,6 +156,57 @@ export default class Marketing extends Restful {
      * @param body This type defines the fields for the updateBid request.
      */
     updateBid(campaignId: string, adId: string, body: UpdateBidPercentageRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupStatus A comma-separated list of ad group statuses.
+     * @param limit The number of results, from the current result set, to be returned in a single page.
+     * @param offset The number of results that will be skipped in the result set.
+     */
+    getAdGroups(campaignId: string, { adGroupStatus, limit, offset }?: {
+        adGroupStatus?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body This type defines the fields for the <b>createAdGroup</b> request.
+     */
+    createAdGroup(campaignId: string, body: CreateAdGroupRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     */
+    getAdGroup(campaignId: string, adGroupId: string): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     * @param body This type defines the fields for the <b>UpdateAdGroup</b> request.
+     */
+    updateAdGroup(campaignId: string, adGroupId: string, body: UpdateAdGroupRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     * @param body The data requested to retrieve the suggested bids.
+     */
+    suggestBids(campaignId: string, adGroupId: string, body: TargetedBidRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     * @param body The required data to retrieve suggested keywords.
+     */
+    suggestKeywords(campaignId: string, adGroupId: string, body: TargetedKeywordRequest): Promise<any>;
     /**
      * This method clones (makes a copy of) the specified campaign.
      *
@@ -236,6 +303,30 @@ export default class Marketing extends Restful {
      *     a seller's campaign IDs by calling getCampaigns.
      */
     resumeCampaign(campaignId: string): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param categoryIds Specifies the category ID that is used to limit the results.
+     * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response.
+     * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response.
+     */
+    suggestItems(campaignId: string, { categoryIds, limit, offset }?: {
+        categoryIds?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param body This type defines the request fields for the ad rate strategy that shall be updated.
+     */
+    updateAdRateStrategy(campaignId: string, body: UpdateAdrateStrategyRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param body This type defines the request fields for the budget details that shall be updated.
+     */
+    updateCampaignBudget(campaignId: string, body: UpdateCampaignBudgetRequest): Promise<any>;
     /**
      * This method replaces the name and the start and end dates of a campaign.
      *
@@ -244,6 +335,98 @@ export default class Marketing extends Restful {
      * @param body This type defines the fields to updated the campaign name and start and end dates.
      */
     updateCampaignIdentification(campaignId: string, body: UpdateCampaignIdentificationRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body A type that defines the fields for the bulk request to create keywords.
+     */
+    bulkCreateKeyword(campaignId: string, body: BulkCreateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body A type that defines the fields for the bulk request to update keywords.
+     */
+    bulkUpdateKeyword(campaignId: string, body: BulkUpdateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupIds A comma-separated list of ad group IDs.
+     * @param keywordStatus A comma-separated list of keyword statuses.
+     * @param limit Specifies the maximum number of results to return on a page in the paginated response.
+     * @param offset Specifies the number of results to skip in the result set before returning the first report in the paginated response.
+     */
+    getKeywords(campaignId: string, { adGroupIds, keywordStatus, limit, offset }?: {
+        adGroupIds?: string;
+        keywordStatus?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body A type that defines the fields for the request to create a keyword.
+     */
+    createKeyword(campaignId: string, body: CreateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param keywordId This path parameter is used to identify the keyword to retrieve.
+     */
+    getKeyword(campaignId: string, keywordId: string): Promise<any>;
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param keywordId This path parameter is used to identify the keyword to retrieve.
+     * @param body A type that defines the fields for the request to update a keyword.
+     */
+    updateKeyword(campaignId: string, keywordId: string, body: UpdateKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param body A type that defines the fields for the bulk request to create negative keywords.
+     */
+    bulkCreateNegativeKeyword(body: BulkCreateNegativeKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param body A type that defines the fields for the bulk request to create negative keywords.
+     */
+    bulkUpdateNegativeKeyword(body: BulkUpdateNegativeKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param adGroupIds A comma-separated list of ad group IDs.
+     * @param campaignIds A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param limit The number of results, from the current result set, to be returned in a single page.
+     * @param negativeKeywordStatus A comma-separated list of negative keyword statuses.
+     * @param offset The number of results that will be skipped in the result set.
+     */
+    getNegativeKeywords({ adGroupIds, campaignIds, limit, negativeKeywordStatus, offset }?: {
+        adGroupIds?: string;
+        campaignIds?: string;
+        limit?: number;
+        negativeKeywordStatus?: string;
+        offset?: number;
+    }): Promise<any>;
+    /**
+     *
+     * @param body A type that defines the fields for the request to create a negative keyword.
+     */
+    createNegativeKeyword(body: CreateNegativeKeywordRequest): Promise<any>;
+    /**
+     *
+     * @param negativeKeywordId The unique identifier for the negative keyword.
+     */
+    getNegativeKeyword(negativeKeywordId: string): Promise<any>;
+    /**
+     *
+     * @param negativeKeywordId The unique identifier for the negative keyword.
+     * @param body A type that defines the fields for the request to update a negative keyword.
+     */
+    updateNegativeKeyword(negativeKeywordId: string, body: UpdateNegativeKeywordRequest): Promise<any>;
     /**
      * This call downloads the report as specified by the report_id path parameter.
      *

package/lib/api/restful/sell/marketing/index.js

@@ -84,6 +84,28 @@ class Marketing extends index_js_1.default {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_bid_by_listing_id`, body);
     }
+    /**
+     * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body The bulk request to update the ads.
+     */
+    bulkUpdateAdsStatus(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status`, body);
+    }
+    /**
+     * This method is only available for select partners who have been approved for the eBay Promoted Listings Advanced (PLA) program.
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body The bulk request to update ads.
+     */
+    bulkUpdateAdsStatusByListingId(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/bulk_update_ads_status_by_listing_id`, body);
+    }
     /**
      * This method retrieves all the ads for the specified campaign.
      *
@@ -197,6 +219,81 @@ class Marketing extends index_js_1.default {
         adId = encodeURIComponent(adId);
         return this.post(`/ad_campaign/${campaignId}/ad/${adId}/update_bid`, body);
     }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupStatus A comma-separated list of ad group statuses.
+     * @param limit The number of results, from the current result set, to be returned in a single page.
+     * @param offset The number of results that will be skipped in the result set.
+     */
+    getAdGroups(campaignId, { adGroupStatus, limit, offset } = {}) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.get(`/ad_campaign/${campaignId}/ad_group`, {
+            params: {
+                ad_group_status: adGroupStatus,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body This type defines the fields for the <b>createAdGroup</b> request.
+     */
+    createAdGroup(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/ad_group`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     */
+    getAdGroup(campaignId, adGroupId) {
+        adGroupId = encodeURIComponent(adGroupId);
+        campaignId = encodeURIComponent(campaignId);
+        return this.get(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     * @param body This type defines the fields for the <b>UpdateAdGroup</b> request.
+     */
+    updateAdGroup(campaignId, adGroupId, body) {
+        adGroupId = encodeURIComponent(adGroupId);
+        campaignId = encodeURIComponent(campaignId);
+        return this.put(`/ad_campaign/${campaignId}/ad_group/${adGroupId}`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     * @param body The data requested to retrieve the suggested bids.
+     */
+    suggestBids(campaignId, adGroupId, body) {
+        adGroupId = encodeURIComponent(adGroupId);
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_bids`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupId The ID of the ad group that shall be retrieved.
+     * @param body The required data to retrieve suggested keywords.
+     */
+    suggestKeywords(campaignId, adGroupId, body) {
+        adGroupId = encodeURIComponent(adGroupId);
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/ad_group/${adGroupId}/suggest_keywords`, body);
+    }
     /**
      * This method clones (makes a copy of) the specified campaign.
      *
@@ -327,6 +424,41 @@ class Marketing extends index_js_1.default {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/resume`);
     }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param categoryIds Specifies the category ID that is used to limit the results.
+     * @param limit Specifies the maximum number of campaigns to return on a page in the paginated response.
+     * @param offset Specifies the number of campaigns to skip in the result set before returning the first report in the paginated response.
+     */
+    suggestItems(campaignId, { categoryIds, limit, offset } = {}) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.get(`/ad_campaign/${campaignId}/suggest_items`, {
+            params: {
+                category_ids: categoryIds,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param body This type defines the request fields for the ad rate strategy that shall be updated.
+     */
+    updateAdRateStrategy(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/update_ad_rate_strategy`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param body This type defines the request fields for the budget details that shall be updated.
+     */
+    updateCampaignBudget(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/update_campaign_budget`, body);
+    }
     /**
      * This method replaces the name and the start and end dates of a campaign.
      *
@@ -338,6 +470,134 @@ class Marketing extends index_js_1.default {
         campaignId = encodeURIComponent(campaignId);
         return this.post(`/ad_campaign/${campaignId}/update_campaign_identification`, body);
     }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body A type that defines the fields for the bulk request to create keywords.
+     */
+    bulkCreateKeyword(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/bulk_create_keyword`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body A type that defines the fields for the bulk request to update keywords.
+     */
+    bulkUpdateKeyword(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/bulk_update_keyword`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param adGroupIds A comma-separated list of ad group IDs.
+     * @param keywordStatus A comma-separated list of keyword statuses.
+     * @param limit Specifies the maximum number of results to return on a page in the paginated response.
+     * @param offset Specifies the number of results to skip in the result set before returning the first report in the paginated response.
+     */
+    getKeywords(campaignId, { adGroupIds, keywordStatus, limit, offset } = {}) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.get(`/ad_campaign/${campaignId}/keyword`, {
+            params: {
+                ad_group_ids: adGroupIds,
+                keyword_status: keywordStatus,
+                limit,
+                offset
+            }
+        });
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param body A type that defines the fields for the request to create a keyword.
+     */
+    createKeyword(campaignId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        return this.post(`/ad_campaign/${campaignId}/keyword`, body);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param keywordId This path parameter is used to identify the keyword to retrieve.
+     */
+    getKeyword(campaignId, keywordId) {
+        campaignId = encodeURIComponent(campaignId);
+        keywordId = encodeURIComponent(keywordId);
+        return this.get(`/ad_campaign/${campaignId}/keyword/${keywordId}`);
+    }
+    /**
+     *
+     * @param campaignId A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get
+     *     a seller's campaign IDs by calling getCampaigns.
+     * @param keywordId This path parameter is used to identify the keyword to retrieve.
+     * @param body A type that defines the fields for the request to update a keyword.
+     */
+    updateKeyword(campaignId, keywordId, body) {
+        campaignId = encodeURIComponent(campaignId);
+        keywordId = encodeURIComponent(keywordId);
+        return this.put(`/ad_campaign/${campaignId}/keyword/${keywordId}`, body);
+    }
+    /**
+     *
+     * @param body A type that defines the fields for the bulk request to create negative keywords.
+     */
+    bulkCreateNegativeKeyword(body) {
+        return this.post(`/bulk_create_negative_keyword`, body);
+    }
+    /**
+     *
+     * @param body A type that defines the fields for the bulk request to create negative keywords.
+     */
+    bulkUpdateNegativeKeyword(body) {
+        return this.post(`/bulk_update_negative_keyword`, body);
+    }
+    /**
+     *
+     * @param adGroupIds A comma-separated list of ad group IDs.
+     * @param campaignIds A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.
+     * @param limit The number of results, from the current result set, to be returned in a single page.
+     * @param negativeKeywordStatus A comma-separated list of negative keyword statuses.
+     * @param offset The number of results that will be skipped in the result set.
+     */
+    getNegativeKeywords({ adGroupIds, campaignIds, limit, negativeKeywordStatus, offset } = {}) {
+        return this.get(`/negative_keyword`, {
+            params: {
+                ad_group_ids: adGroupIds,
+                campaign_ids: campaignIds, limit,
+                negative_keyword_status: negativeKeywordStatus, offset
+            }
+        });
+    }
+    /**
+     *
+     * @param body A type that defines the fields for the request to create a negative keyword.
+     */
+    createNegativeKeyword(body) {
+        return this.post(`/negative_keyword`, body);
+    }
+    /**
+     *
+     * @param negativeKeywordId The unique identifier for the negative keyword.
+     */
+    getNegativeKeyword(negativeKeywordId) {
+        negativeKeywordId = encodeURIComponent(negativeKeywordId);
+        return this.get(`/negative_keyword/${negativeKeywordId}`);
+    }
+    /**
+     *
+     * @param negativeKeywordId The unique identifier for the negative keyword.
+     * @param body A type that defines the fields for the request to update a negative keyword.
+     */
+    updateNegativeKeyword(negativeKeywordId, body) {
+        negativeKeywordId = encodeURIComponent(negativeKeywordId);
+        return this.put(`/negative_keyword/${negativeKeywordId}`, body);
+    }
     /**
      * This call downloads the report as specified by the report_id path parameter.
      *