Class SponsoredBrandsReportOperation<ReportParams>

Type Parameters

Hierarchy

Constructors

constructor

Methods

downloadReport getReport requestReport create

Constructors

constructor

Methods

downloadReport

  • Downloads the report corresponding to the reportId specified

    Returns

    {(Promise<Partial<Record<T, 'number' | 'string'>>[]>)}

    Type Parameters

    • T extends string

    Parameters

    • reportId: string

    Returns Promise<Partial<Record<T, "string" | "number">>[]>

getReport

  • Retrieve status, metadata and location of a previously requested performance report.

    Returns

    Parameters

    • reportId: string

    Returns Promise<{ reportId: string; status: "SUCCESS" | "IN_PROGRESS" | "FAILURE"; statusDetails: string } & { fileSize: undefined | number; location: undefined | string; recordType: undefined | string }>

requestReport

  • Request the creation of a performance report for all entities of a single type which have performance data to report. Record types can be: campaigns, adGroups, and keywords

    Returns

    Parameters

    • params: ReportParams

    Returns Promise<{ reportId: string; status: "SUCCESS" | "IN_PROGRESS" | "FAILURE"; statusDetails: string } & { fileSize: undefined | number; location: undefined | string; recordType: undefined | string }>

Static create

Settings

Member Visibility

Theme