Class SponsoredBrandsKeywordsOperation

Hierarchy

Constructors

constructor

Methods

archiveKeyword createKeywords getKeyword listKeywords updateKeywords create

Constructors

constructor

Methods

archiveKeyword

  • Archives a keyword specified by identifier. This operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. See Developer Notes for more information.

    Returns

    Parameters

    • keywordId: number

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

createKeywords

  • Creates one or more keywords. Note that state can't be set at keyword creation. Keywords submitted for creation have state set to pending while under moderation review. Note that moderation review may take up to 72 hours.

    Returns

    Parameters

    • params: { adGroupId: number; bid: number; campaignId: number; keywordText: string; matchType: "exact" | "broad" | "phrase" }[]

    Returns Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>

getKeyword

  • Gets a keyword specified by identifier.

    Returns

    Parameters

    • keywordId: number

    Returns Promise<{ adGroupId: number; bid: number; campaignId: number; keywordId: number; keywordText: string; matchType: "exact" | "broad" | "phrase"; state: "paused" | "pending" | "enabled" | "archived" | "draft" }>

listKeywords

  • Gets an array of keywords, filtered by optional criteria

    Returns

    Parameters

    • Optional params: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; keywordIdFilter: undefined | number[]; keywordText: undefined | string; matchTypeFilter: undefined | ("exact" | "broad" | "phrase")[]; stateFilter: undefined | "paused" | "enabled" | "archived" }

    Returns Promise<{ adGroupId: number; bid: number; campaignId: number; keywordId: number; keywordText: string; matchType: "exact" | "broad" | "phrase"; state: "paused" | "pending" | "enabled" | "archived" | "draft" }[]>

updateKeywords

  • Updates one or more keywords. Keywords submitted for update have state set to pending while under moderation review. Note that moderation may take up to 72 hours.

    Returns

    Parameters

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

    Returns Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>

Static create

Settings

Member Visibility

Theme