Skip to content

TrackingApi.md

Latest commit

 

History

History
371 lines (251 loc) · 11 KB

TrackingApi.md

File metadata and controls

371 lines (251 loc) · 11 KB

GoAdServerApi\TrackingApi

Conversion-tracking pixels — create, list, update, delete.

All URIs are relative to https://up.go-adserver.com, except if the operation defines another base path.

Method HTTP request Description
apiV1TrackingConversionTypesGet() GET /api/v1/tracking/conversion-types Available conversion types for the caller's account.
apiV1TrackingPixelsGet() GET /api/v1/tracking/pixels List the caller's conversion-tracking pixels.
apiV1TrackingPixelsIdDelete() DELETE /api/v1/tracking/pixels/{id} Delete a pixel.
apiV1TrackingPixelsIdGet() GET /api/v1/tracking/pixels/{id} Get one pixel.
apiV1TrackingPixelsIdPut() PUT /api/v1/tracking/pixels/{id} Update a pixel's name or conversion type.
apiV1TrackingPixelsPost() POST /api/v1/tracking/pixels Create a new tracking pixel.

apiV1TrackingConversionTypesGet()

apiV1TrackingConversionTypesGet(): \GoAdServerApi\Model\ApiV1TrackingConversionTypesGet200Response

Available conversion types for the caller's account.

Use to discover valid conversion_type_id values for new pixels, plus the network's ad-domain and the configured tracking variable name (needed to construct the actual tracking URL).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\TrackingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->apiV1TrackingConversionTypesGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TrackingApi->apiV1TrackingConversionTypesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\GoAdServerApi\Model\ApiV1TrackingConversionTypesGet200Response

Authorization

apiKey

HTTP request headers

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

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

apiV1TrackingPixelsGet()

apiV1TrackingPixelsGet($conversion_type_id, $name, $page, $per_page): \GoAdServerApi\Model\ApiV1TrackingPixelsGet200Response

List the caller's conversion-tracking pixels.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\TrackingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$conversion_type_id = 56; // int | Filter by conversion type.
$name = 'name_example'; // string | Substring search on name.
$page = 1; // int
$per_page = 100; // int

try {
    $result = $apiInstance->apiV1TrackingPixelsGet($conversion_type_id, $name, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TrackingApi->apiV1TrackingPixelsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
conversion_type_id int Filter by conversion type. [optional]
name string Substring search on name. [optional]
page int [optional] [default to 1]
per_page int [optional] [default to 100]

Return type

\GoAdServerApi\Model\ApiV1TrackingPixelsGet200Response

Authorization

apiKey

HTTP request headers

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

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

apiV1TrackingPixelsIdDelete()

apiV1TrackingPixelsIdDelete($id)

Delete a pixel.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\TrackingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int

try {
    $apiInstance->apiV1TrackingPixelsIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling TrackingApi->apiV1TrackingPixelsIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int

Return type

void (empty response body)

Authorization

apiKey

HTTP request headers

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

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

apiV1TrackingPixelsIdGet()

apiV1TrackingPixelsIdGet($id): \GoAdServerApi\Model\TrackingPixel

Get one pixel.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\TrackingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int

try {
    $result = $apiInstance->apiV1TrackingPixelsIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TrackingApi->apiV1TrackingPixelsIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int

Return type

\GoAdServerApi\Model\TrackingPixel

Authorization

apiKey

HTTP request headers

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

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

apiV1TrackingPixelsIdPut()

apiV1TrackingPixelsIdPut($id, $api_v1_tracking_pixels_id_put_request): \GoAdServerApi\Model\TrackingPixel

Update a pixel's name or conversion type.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\TrackingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int
$api_v1_tracking_pixels_id_put_request = new \GoAdServerApi\Model\ApiV1TrackingPixelsIdPutRequest(); // \GoAdServerApi\Model\ApiV1TrackingPixelsIdPutRequest

try {
    $result = $apiInstance->apiV1TrackingPixelsIdPut($id, $api_v1_tracking_pixels_id_put_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TrackingApi->apiV1TrackingPixelsIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
api_v1_tracking_pixels_id_put_request \GoAdServerApi\Model\ApiV1TrackingPixelsIdPutRequest

Return type

\GoAdServerApi\Model\TrackingPixel

Authorization

apiKey

HTTP request headers

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

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

apiV1TrackingPixelsPost()

apiV1TrackingPixelsPost($api_v1_tracking_pixels_post_request): \GoAdServerApi\Model\TrackingPixel

Create a new tracking pixel.

pixel_code is generated server-side (32 random hex chars) and returned in the response. Use it in the conversion URL the advertiser embeds on the post-conversion page.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (gas_live_<32 chars>) authorization: apiKey
$config = GoAdServerApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new GoAdServerApi\Api\TrackingApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$api_v1_tracking_pixels_post_request = new \GoAdServerApi\Model\ApiV1TrackingPixelsPostRequest(); // \GoAdServerApi\Model\ApiV1TrackingPixelsPostRequest

try {
    $result = $apiInstance->apiV1TrackingPixelsPost($api_v1_tracking_pixels_post_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TrackingApi->apiV1TrackingPixelsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
api_v1_tracking_pixels_post_request \GoAdServerApi\Model\ApiV1TrackingPixelsPostRequest

Return type

\GoAdServerApi\Model\TrackingPixel

Authorization

apiKey

HTTP request headers

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

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