internal_public_v1.UpdateCampaignRequest — openapi

Properties

Name	Type	Required	Description
bid		false	Immutable in v1; including it returns 400.
budget		false	A budget change. Only the amount is mutable; the budget type is fixed at creation, so it is not part of this object. Sending `type` returns 400.
creativeAssetIds	array	false	Immutable in v1; including it returns 400.
name	string	false	A new display name for the campaign.
schedule		false	A schedule change. Allowed only before the campaign starts.
status	string	false	A lifecycle transition: `ACTIVE` to run or resume, `PAUSED` to pause, or `CANCELLED` to cancel permanently.
targeting		false	Immutable in v1; including it returns 400.

Complete Schema

{
  "type": "object",
  "properties": {
    "bid": {
      "description": "Immutable in v1; including it returns 400.",
      "allOf": [
        {
          "$ref": "#/components/schemas/internal_public_v1.Bid"
        }
      ]
    },
    "budget": {
      "description": "A budget change. Only the amount is mutable; the budget type is fixed at\ncreation, so it is not part of this object. Sending `type` returns 400.",
      "allOf": [
        {
          "$ref": "#/components/schemas/internal_public_v1.UpdateBudget"
        }
      ]
    },
    "creativeAssetIds": {
      "description": "Immutable in v1; including it returns 400.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "description": "A new display name for the campaign.",
      "type": "string"
    },
    "schedule": {
      "description": "A schedule change. Allowed only before the campaign starts.",
      "allOf": [
        {
          "$ref": "#/components/schemas/internal_public_v1.Schedule"
        }
      ]
    },
    "status": {
      "description": "A lifecycle transition: `ACTIVE` to run or resume, `PAUSED` to pause, or\n`CANCELLED` to cancel permanently.",
      "type": "string",
      "enum": [
        "ACTIVE",
        "PAUSED",
        "CANCELLED"
      ]
    },
    "targeting": {
      "description": "Immutable in v1; including it returns 400.",
      "allOf": [
        {
          "$ref": "#/components/schemas/internal_public_v1.Targeting"
        }
      ]
    }
  }
}

internal_public_v1.UpdateCampaignRequest — openapi

Properties

Related Schemas

Complete Schema