Skip to content

AdspacesApi.md

Latest commit

 

History

History
130 lines (88 loc) · 3.41 KB

AdspacesApi.md

File metadata and controls

130 lines (88 loc) · 3.41 KB

GoAdServerApi\AdspacesApi

Read publisher ad zones + on/off toggle.

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

Method HTTP request Description
apiV1AdspacesGet() GET /api/v1/adspaces List ad zones owned by the caller.
apiV1AdspacesIdGet() GET /api/v1/adspaces/{id} Get a single adspace.

apiV1AdspacesGet()

apiV1AdspacesGet($site_id, $page, $per_page): \GoAdServerApi\Model\ApiV1AdspacesGet200Response

List ad zones owned by the caller.

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\AdspacesApi(
    // 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
);
$site_id = 56; // int | Filter to one site.
$page = 1; // int
$per_page = 100; // int

try {
    $result = $apiInstance->apiV1AdspacesGet($site_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdspacesApi->apiV1AdspacesGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
site_id int Filter to one site. [optional]
page int [optional] [default to 1]
per_page int [optional] [default to 100]

Return type

\GoAdServerApi\Model\ApiV1AdspacesGet200Response

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]

apiV1AdspacesIdGet()

apiV1AdspacesIdGet($id)

Get a single adspace.

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\AdspacesApi(
    // 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->apiV1AdspacesIdGet($id);
} catch (Exception $e) {
    echo 'Exception when calling AdspacesApi->apiV1AdspacesIdGet: ', $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]