Interface AdsGetAdsLayoutParams

interface AdsGetAdsLayoutParams {
    account_id: number;
    ad_ids?: string;
    campaign_ids?: string;
    client_id?: number;
    include_deleted?: number | boolean;
    limit?: number;
    offset?: number;
    only_deleted?: number | boolean;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

account_id ad_ids? campaign_ids? client_id? include_deleted? limit? offset? only_deleted?

Properties

account_id

account_id: number

Advertising account ID.

Optional ad_ids

ad_ids?: string

Filter by ads. Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.

Optional campaign_ids

campaign_ids?: string

Filter by advertising campaigns. Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.

Optional client_id

client_id?: number

'For advertising agencies.' ID of the client ads are retrieved from.

Optional include_deleted

include_deleted?: number | boolean

Flag that specifies whether archived ads shall be shown. *0 - show only active ads,, *1 - show all ads.

Optional limit

limit?: number

Limit of number of returned ads. Used only if 'ad_ids' parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.

Optional offset

offset?: number

Offset. Used in the same cases as 'limit' parameter.

Optional only_deleted

only_deleted?: number | boolean

Flag that specifies whether to show only archived ads: *0 - show all ads,, *1 - show only archived ads. Available when include_deleted flag is *1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc