v1

latestOpenAPI 3.0.02026-07-2678399358.2 KB
Intelligence

ReadCampaignGuidance

Read guidance for a reasonable campaign setup.

get/rmp/mgmt/v1/platforms/{platform_id}/ad-accounts/{ad_account_id}/campaign-guidances

Path parameters

platform_idstring required

Identifier of the platform who requests management api. It is passed as a path parameter.

ad_account_idstring required

AdAccount id.

Query parameters

campaign_idstring

Campaign id must be specified when requesting guidance for an existing campaign to be guided according to the campaign history.

goal_type'FIXED_CPC' | 'OPTIMIZE_ROAS' | 'FIXED_COMMISSION_RATE'

Campaign goal type must be specified when requesting guidance for a new campaign to be selectively guided according to the goal.

ad_type'ITEM'

Campaign ad type must be specified when requesting guidance for a new campaign.

Response

A successful response.

guided_commission_rateinteger

Target commission rate guidance in percent.