AdPlan

/api/v2/ad_plans/(?P<ad_plan_id>d+).json

A resource that allows you to retrieve/edit a single ad campaign.

Used object: AdPlan

GET

Retrieving a single ad campaign

Request example


    GET /api/v2/ad_plans/6617841.json

Response example


    {
        "id": 6617841,
        "name": "New campaign 2016-07-15 17:53"
    }

Parameters

  • fields — list of fields in the response

    /api/v2/ad_plans.json?fields=id,package_id

Available fields are described in AdGroup.

POST

Editing an ad campaign

Request example


    POST /api/v2/ad_plans/6617841.json
    {
        "name": "New name"
    }

Response example


    HTTP 204

Possible response codes

  • 200/204 — campaign saved
  • 400 — validation error
  • 404 — campaign not found

Possible error codes

  • required — field is required
  • max_value — value is greater than the maximum
  • min_value — value is less than the minimum
  • bad_value — invalid value format or type
  • bad_items — the list contains invalid values
  • read_only_field — read-only field
  • duplicate_value — duplicate values
  • required_value — required values are expected
  • required_one_of_value — one of the required values is expected
  • unallowed_value — value is not in the list of allowed values
  • unallowed_field — field is not allowed