Update campaign conversion goals

curl --request PATCH \
  --url https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "campaignId": "<string>",
  "customConversionGoalId": "<string>",
  "customerId": "<string>",
  "goalConfigLevel": "CUSTOMER",
  "goals": [
    {
      "biddable": true,
      "category": "<string>",
      "origin": "<string>",
      "resourceName": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

AIsa Ads

Update campaign conversion goals

Ad Campaigns. Changes the ad account without starting or raising spend; audited. Changes which conversions a Google campaign bids on, switching between account-default goals, its own goals or a custom goal. In one mutate, it can: set `biddable` on campaign goals switch `goalConfigLevel` point the campaign at a custom conversion goal `customConversionGoalId: null` clears it.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

PATCH

https://api.aisa.one

apis

ads

campaigns

{campaignId}

conversion-goals

Update campaign conversion goals

curl --request PATCH \
  --url https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "campaignId": "<string>",
  "customConversionGoalId": "<string>",
  "customerId": "<string>",
  "goalConfigLevel": "CUSTOMER",
  "goals": [
    {
      "biddable": true,
      "category": "<string>",
      "origin": "<string>",
      "resourceName": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "details": {},
    "message": "<string>",
    "param": "<string>",
    "retryHint": "<string>",
    "retryable": true,
    "type": "<string>"
  }
}

Request contract

Method and path: PATCH /apis/v1/ads/campaigns/{campaignId}/conversion-goals
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/conversion-goals
campaignId: path; required
connectionId: query; required
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "patch_aisa_ads_apis_v1_ads_campaigns_campaignid_c_6ea0b0",
  "method": "PATCH",
  "path": "/apis/v1/ads/campaigns/{campaignId}/conversion-goals",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "description": "Google campaign id",
      "in": "path",
      "name": "campaignId",
      "required": true,
      "schema": {
        "pattern": "^\\d+$",
        "type": "string"
      }
    },
    {
      "description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
      "in": "query",
      "name": "connectionId",
      "required": true,
      "schema": {
        "pattern": "^adc_[0-9A-Za-z]+$",
        "type": "string"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "example": {
          "connectionId": "adc_7f3k2m9q",
          "customConversionGoalId": "1234567890",
          "goalConfigLevel": "CUSTOMER"
        },
        "schema": {
          "additionalProperties": false,
          "properties": {
            "connectionId": {
              "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
              "pattern": "^adc_[0-9A-Za-z]+$",
              "type": "string"
            },
            "customConversionGoalId": {
              "description": "Custom goal to bid on, or null to clear",
              "pattern": "^\\d+$",
              "type": [
                "string",
                "null"
              ]
            },
            "goalConfigLevel": {
              "enum": [
                "CUSTOMER",
                "CAMPAIGN"
              ],
              "type": "string"
            },
            "goals": {
              "items": {
                "additionalProperties": false,
                "properties": {
                  "biddable": {
                    "type": "boolean"
                  },
                  "category": {
                    "description": "Google ConversionActionCategory, e.g. PURCHASE, SIGNUP, SUBMIT_LEAD_FORM",
                    "pattern": "^[A-Z][A-Z0-9_]*$",
                    "type": "string"
                  },
                  "origin": {
                    "description": "Google ConversionOrigin, e.g. WEBSITE, APP, CALL_FROM_ADS, STORE, GOOGLE_HOSTED",
                    "pattern": "^[A-Z][A-Z0-9_]*$",
                    "type": "string"
                  }
                },
                "required": [
                  "biddable",
                  "category",
                  "origin"
                ],
                "type": "object"
              },
              "maxItems": 100,
              "type": "array"
            }
          },
          "type": "object"
        }
      }
    },
    "required": true
  },
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
    "kind": "no_customer_charge"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId

string

required

Google campaign id

Pattern: ^\d+$

Query Parameters

connectionId

string

required

The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.

Pattern: ^adc_[0-9A-Za-z]+$

Body

application/json

connectionId

string

The ads connection (adc_...), when not sent as the connectionId query parameter.

Pattern: ^adc_[0-9A-Za-z]+$

customConversionGoalId

string | null

Custom goal to bid on, or null to clear

Pattern: ^\d+$

goalConfigLevel

enum<string>

Available options:

CUSTOMER,

CAMPAIGN

goals

object[]

Maximum array length: 100

Show child attributes

Response

Campaign goals updated

campaignId

string

customConversionGoalId

string | null

customerId

string

goalConfigLevel

enum<string>

Available options:

CUSTOMER,

CAMPAIGN,

UNSPECIFIED,

UNKNOWN

goals

object[]

Show child attributes

​Request contract

​Cost and request rules

Authorizations

Path Parameters

Query Parameters

Body

Response

Request contract

Cost and request rules