Skip to content

URLPoolsApi.md

Latest commit

 

History

History
1109 lines (772 loc) · 26.9 KB

URLPoolsApi.md

File metadata and controls

1109 lines (772 loc) · 26.9 KB

URLPoolsApi

All URIs are relative to https://up.go-adserver.com

Method HTTP request Description
apiV1UrlPoolsGet GET /api/v1/url-pools List URL pools.
apiV1UrlPoolsIdClonePost POST /api/v1/url-pools/{id}/clone Clone a URL pool with all its URLs.
apiV1UrlPoolsIdDelete DELETE /api/v1/url-pools/{id} Soft-delete a URL pool.
apiV1UrlPoolsIdGet GET /api/v1/url-pools/{id} Show one URL pool.
apiV1UrlPoolsIdPut PUT /api/v1/url-pools/{id} Update URL pool meta.
apiV1UrlPoolsIdUrlsGet GET /api/v1/url-pools/{id}/urls List URLs in a pool.
apiV1UrlPoolsIdUrlsPost POST /api/v1/url-pools/{id}/urls Add a URL to a pool.
apiV1UrlPoolsIdUrlsUrlIdClonePost POST /api/v1/url-pools/{id}/urls/{urlId}/clone Clone a single URL within the same pool.
apiV1UrlPoolsIdUrlsUrlIdDelete DELETE /api/v1/url-pools/{id}/urls/{urlId} Soft-delete a single URL.
apiV1UrlPoolsIdUrlsUrlIdGet GET /api/v1/url-pools/{id}/urls/{urlId} Show a single URL.
apiV1UrlPoolsIdUrlsUrlIdPut PUT /api/v1/url-pools/{id}/urls/{urlId} Update a single URL.
apiV1UrlPoolsIdUrlsUrlIdTogglePut PUT /api/v1/url-pools/{id}/urls/{urlId}/toggle Toggle a URL on / off.
apiV1UrlPoolsIdUrlsUrlIdWeightPut PUT /api/v1/url-pools/{id}/urls/{urlId}/weight Set a URL's rotation weight.
apiV1UrlPoolsIdUsedInGet GET /api/v1/url-pools/{id}/used-in List campaigns / ads that reference this URL pool.
apiV1UrlPoolsPost POST /api/v1/url-pools Create a URL pool.

apiV1UrlPoolsGet

ApiV1CampaignsTypeCampaignIdAdsGet200Response apiV1UrlPoolsGet(page, perPage)

List URL pools.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number (optional)
    page: 56,
    // number (optional)
    perPage: 56,
  } satisfies ApiV1UrlPoolsGetRequest;

  try {
    const data = await api.apiV1UrlPoolsGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
page number [Optional] [Defaults to 1]
perPage number [Optional] [Defaults to 50]

Return type

ApiV1CampaignsTypeCampaignIdAdsGet200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Pools. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdClonePost

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response apiV1UrlPoolsIdClonePost(id)

Clone a URL pool with all its URLs.

Duplicates the pool row and every URL in it (`isdeleted=0`). New pool title is suffixed with " (Copy)".

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdClonePostRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
  } satisfies ApiV1UrlPoolsIdClonePostRequest;

  try {
    const data = await api.apiV1UrlPoolsIdClonePost(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]

Return type

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Pool cloned. -
404 Source pool not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdDelete

apiV1UrlPoolsIdDelete(id)

Soft-delete a URL pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdDeleteRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
  } satisfies ApiV1UrlPoolsIdDeleteRequest;

  try {
    const data = await api.apiV1UrlPoolsIdDelete(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Deleted. -
404 Pool not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdGet

apiV1UrlPoolsIdGet(id)

Show one URL pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
  } satisfies ApiV1UrlPoolsIdGetRequest;

  try {
    const data = await api.apiV1UrlPoolsIdGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Pool detail. -
404 Pool not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdPut

apiV1UrlPoolsIdPut(id, apiV1UrlPoolsIdPutRequest)

Update URL pool meta.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdPutOperationRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // ApiV1UrlPoolsIdPutRequest
    apiV1UrlPoolsIdPutRequest: ...,
  } satisfies ApiV1UrlPoolsIdPutOperationRequest;

  try {
    const data = await api.apiV1UrlPoolsIdPut(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
apiV1UrlPoolsIdPutRequest ApiV1UrlPoolsIdPutRequest

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Updated. -
404 Pool not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsGet

apiV1UrlPoolsIdUrlsGet(id)

List URLs in a pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
  } satisfies ApiV1UrlPoolsIdUrlsGetRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 URLs. -
404 Pool not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsPost

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response apiV1UrlPoolsIdUrlsPost(id, apiV1UrlPoolsIdUrlsPostRequest)

Add a URL to a pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsPostOperationRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // ApiV1UrlPoolsIdUrlsPostRequest
    apiV1UrlPoolsIdUrlsPostRequest: ...,
  } satisfies ApiV1UrlPoolsIdUrlsPostOperationRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsPost(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
apiV1UrlPoolsIdUrlsPostRequest ApiV1UrlPoolsIdUrlsPostRequest

Return type

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 URL added. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsUrlIdClonePost

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response apiV1UrlPoolsIdUrlsUrlIdClonePost(id, urlId)

Clone a single URL within the same pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsUrlIdClonePostRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // number
    urlId: 56,
  } satisfies ApiV1UrlPoolsIdUrlsUrlIdClonePostRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsUrlIdClonePost(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
urlId number [Defaults to undefined]

Return type

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 URL cloned. -
404 URL not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsUrlIdDelete

apiV1UrlPoolsIdUrlsUrlIdDelete(id, urlId)

Soft-delete a single URL.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsUrlIdDeleteRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // number
    urlId: 56,
  } satisfies ApiV1UrlPoolsIdUrlsUrlIdDeleteRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsUrlIdDelete(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
urlId number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Deleted. -
404 URL not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsUrlIdGet

apiV1UrlPoolsIdUrlsUrlIdGet(id, urlId)

Show a single URL.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsUrlIdGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // number
    urlId: 56,
  } satisfies ApiV1UrlPoolsIdUrlsUrlIdGetRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsUrlIdGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
urlId number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 URL detail. -
404 URL not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsUrlIdPut

apiV1UrlPoolsIdUrlsUrlIdPut(id, urlId, apiV1UrlPoolsIdUrlsUrlIdPutRequest)

Update a single URL.

Editable fields — `url`, `title`, `weight`, `properties`.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsUrlIdPutOperationRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // number
    urlId: 56,
    // ApiV1UrlPoolsIdUrlsUrlIdPutRequest
    apiV1UrlPoolsIdUrlsUrlIdPutRequest: ...,
  } satisfies ApiV1UrlPoolsIdUrlsUrlIdPutOperationRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsUrlIdPut(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
urlId number [Defaults to undefined]
apiV1UrlPoolsIdUrlsUrlIdPutRequest ApiV1UrlPoolsIdUrlsUrlIdPutRequest

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Updated. -
404 URL not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsUrlIdTogglePut

apiV1UrlPoolsIdUrlsUrlIdTogglePut(id, urlId)

Toggle a URL on / off.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsUrlIdTogglePutRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // number
    urlId: 56,
  } satisfies ApiV1UrlPoolsIdUrlsUrlIdTogglePutRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsUrlIdTogglePut(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
urlId number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Toggled. -
404 URL not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUrlsUrlIdWeightPut

apiV1UrlPoolsIdUrlsUrlIdWeightPut(id, urlId, apiV1UrlPoolsIdUrlsUrlIdWeightPutRequest)

Set a URL's rotation weight.

Higher weight = more traffic share when `sort_type=wr`. Has no effect for `rnd`, `ctr` and `cr` sort modes.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUrlsUrlIdWeightPutOperationRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
    // number
    urlId: 56,
    // ApiV1UrlPoolsIdUrlsUrlIdWeightPutRequest
    apiV1UrlPoolsIdUrlsUrlIdWeightPutRequest: ...,
  } satisfies ApiV1UrlPoolsIdUrlsUrlIdWeightPutOperationRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUrlsUrlIdWeightPut(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]
urlId number [Defaults to undefined]
apiV1UrlPoolsIdUrlsUrlIdWeightPutRequest ApiV1UrlPoolsIdUrlsUrlIdWeightPutRequest

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Updated. -
404 URL not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsIdUsedInGet

apiV1UrlPoolsIdUsedInGet(id)

List campaigns / ads that reference this URL pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsIdUsedInGetRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // number
    id: 56,
  } satisfies ApiV1UrlPoolsIdUsedInGetRequest;

  try {
    const data = await api.apiV1UrlPoolsIdUsedInGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
id number [Defaults to undefined]

Return type

void (Empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 References. -
404 Pool not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV1UrlPoolsPost

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response apiV1UrlPoolsPost(apiV1UrlPoolsPostRequest)

Create a URL pool.

Example

import {
  Configuration,
  URLPoolsApi,
} from 'goadserver-sdk';
import type { ApiV1UrlPoolsPostOperationRequest } from 'goadserver-sdk';

async function example() {
  console.log("🚀 Testing goadserver-sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: apiKey
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new URLPoolsApi(config);

  const body = {
    // ApiV1UrlPoolsPostRequest
    apiV1UrlPoolsPostRequest: ...,
  } satisfies ApiV1UrlPoolsPostOperationRequest;

  try {
    const data = await api.apiV1UrlPoolsPost(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name Type Description Notes
apiV1UrlPoolsPostRequest ApiV1UrlPoolsPostRequest

Return type

ApiV1CampaignsTypeCampaignIdAdsAdIdClonePost200Response

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]