Create website conversion action

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/conversions/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Winter launch",
  "type": "WEBPAGE"
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/conversions/actions"

payload = {
    "name": "Winter launch",
    "type": "WEBPAGE"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://api.aisa.one/apis/v1/ads/conversions/actions', 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/conversions/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Winter launch',
    'type' => 'WEBPAGE'
  ]),
  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/conversions/actions"

	payload := strings.NewReader("{\n  \"name\": \"Winter launch\",\n  \"type\": \"WEBPAGE\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.aisa.one/apis/v1/ads/conversions/actions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Winter launch\",\n  \"type\": \"WEBPAGE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/conversions/actions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Winter launch\",\n  \"type\": \"WEBPAGE\"\n}"

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

{
  "action": {
    "category": "<string>",
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "tagSnippets": [
      {
        "type": "<string>",
        "eventSnippet": "<string>",
        "globalSiteTag": "<string>",
        "pageFormat": "<string>"
      }
    ],
    "type": "<string>",
    "alwaysUseDefaultValue": true,
    "clickThroughLookbackWindowDays": 123,
    "countingType": "<string>",
    "defaultCurrency": "<string>",
    "defaultValue": 123,
    "origin": "<string>",
    "primaryForGoal": true,
    "viewThroughLookbackWindowDays": 123
  }
}

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

AIsa Ads

Create website conversion action

Conversions. Changes the ad account without starting or raising spend; audited. Creates a Google Ads website conversion action and returns the tag snippets to install on your site. Creates a `WEBPAGE` conversion action (category `DEFAULT`) and returns it with its tag snippets, read back after creation since Google never returns them on the create response itself. Invalidates the cached list `GET` on this resource would otherwise keep serving.  A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.

POST

https://api.aisa.one

apis

ads

conversions

actions

Create website conversion action

curl --request POST \
  --url https://api.aisa.one/apis/v1/ads/conversions/actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Winter launch",
  "type": "WEBPAGE"
}
'

import requests

url = "https://api.aisa.one/apis/v1/ads/conversions/actions"

payload = {
    "name": "Winter launch",
    "type": "WEBPAGE"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://api.aisa.one/apis/v1/ads/conversions/actions', 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/conversions/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Winter launch',
    'type' => 'WEBPAGE'
  ]),
  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/conversions/actions"

	payload := strings.NewReader("{\n  \"name\": \"Winter launch\",\n  \"type\": \"WEBPAGE\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.aisa.one/apis/v1/ads/conversions/actions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Winter launch\",\n  \"type\": \"WEBPAGE\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/ads/conversions/actions")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Winter launch\",\n  \"type\": \"WEBPAGE\"\n}"

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

{
  "action": {
    "category": "<string>",
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "tagSnippets": [
      {
        "type": "<string>",
        "eventSnippet": "<string>",
        "globalSiteTag": "<string>",
        "pageFormat": "<string>"
      }
    ],
    "type": "<string>",
    "alwaysUseDefaultValue": true,
    "clickThroughLookbackWindowDays": 123,
    "countingType": "<string>",
    "defaultCurrency": "<string>",
    "defaultValue": 123,
    "origin": "<string>",
    "primaryForGoal": true,
    "viewThroughLookbackWindowDays": 123
  }
}

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

Request contract

Method and path: POST /apis/v1/ads/conversions/actions
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/ads/conversions/actions
connectionId: query; required
Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09

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

{
  "operationId": "post_aisa_ads_apis_v1_ads_conversions_actions",
  "method": "POST",
  "path": "/apis/v1/ads/conversions/actions",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "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",
          "name": "Winter launch",
          "type": "WEBPAGE"
        },
        "schema": {
          "additionalProperties": true,
          "properties": {
            "adAccountId": {
              "description": "Platform ad account ID (Google customer ID, digits only). Resolved automatically when the connection has exactly one accessible customer.",
              "type": "string"
            },
            "alwaysUseDefaultValue": {
              "description": "When true, always use defaultValue and ignore any value sent with the event. Defaults to true when defaultValue is set.",
              "type": "boolean"
            },
            "category": {
              "description": "conversion_action.category. Defaults to DEFAULT on create.",
              "enum": [
                "DEFAULT",
                "PAGE_VIEW",
                "PURCHASE",
                "SIGNUP",
                "DOWNLOAD",
                "ADD_TO_CART",
                "BEGIN_CHECKOUT",
                "SUBSCRIBE_PAID",
                "PHONE_CALL_LEAD",
                "IMPORTED_LEAD",
                "SUBMIT_LEAD_FORM",
                "BOOK_APPOINTMENT",
                "REQUEST_QUOTE",
                "GET_DIRECTIONS",
                "OUTBOUND_CLICK",
                "CONTACT",
                "ENGAGEMENT",
                "STORE_VISIT",
                "STORE_SALE",
                "QUALIFIED_LEAD",
                "CONVERTED_LEAD"
              ],
              "type": "string"
            },
            "clickThroughLookbackWindowDays": {
              "description": "Days after an ad click a conversion still counts.",
              "maximum": 90,
              "minimum": 1,
              "type": "integer"
            },
            "connectionId": {
              "description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
              "pattern": "^adc_[0-9A-Za-z]+$",
              "type": "string"
            },
            "countingType": {
              "description": "ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).",
              "enum": [
                "ONE_PER_CLICK",
                "MANY_PER_CLICK"
              ],
              "type": "string"
            },
            "customerId": {
              "description": "Alias of adAccountId, kept for existing callers",
              "type": "string"
            },
            "defaultCurrency": {
              "description": "ISO 4217 currency of defaultValue (value_settings.default_currency_code).",
              "pattern": "^[A-Z]{3}$",
              "type": "string"
            },
            "defaultValue": {
              "description": "Default conversion value used when an event doesn't carry its own value.",
              "minimum": 0,
              "type": "number"
            },
            "name": {
              "maxLength": 100,
              "minLength": 1,
              "type": "string"
            },
            "primaryForGoal": {
              "description": "true = primary (counts toward bidding when its goal is biddable), false = secondary.",
              "type": "boolean"
            },
            "type": {
              "description": "Only WEBPAGE is supported for creation today.",
              "enum": [
                "WEBPAGE"
              ],
              "type": "string"
            },
            "viewThroughLookbackWindowDays": {
              "description": "Days after an ad view a view-through conversion still counts.",
              "maximum": 30,
              "minimum": 1,
              "type": "integer"
            }
          },
          "required": [
            "name",
            "type"
          ],
          "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.

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

name

string

required

Required string length: 1 - 100

type

enum<string>

required

Only WEBPAGE is supported for creation today.

Available options:

WEBPAGE

adAccountId

string

Platform ad account ID (Google customer ID, digits only). Resolved automatically when the connection has exactly one accessible customer.

alwaysUseDefaultValue

boolean

When true, always use defaultValue and ignore any value sent with the event. Defaults to true when defaultValue is set.

Response

The created conversion action, with its tag snippets.

action

object

A Google Ads conversion action, e.g. a WEBPAGE conversion created via createConversionAction. Returned by listConversionActions and createConversionAction.

Show child attributes

​Request contract

​Cost and request rules

Authorizations

Query Parameters

Body

Response

Request contract

Cost and request rules