SwaggerClient-php

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Build date: 2017-09-22T15:11:48.849+02:00
• Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/dolead/DcmApiClient-php.git"
    }
  ],
  "require": {
    "dolead/DcmApiClient-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: api_key
Dcm\Configuration::getDefaultConfiguration()->setApiKey('DCM-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Dcm\Configuration::getDefaultConfiguration()->setApiKeyPrefix('DCM-API-KEY', 'Bearer');

$api_instance = new Dcm\Api\AccountApi();
$body = new \Dcm\Model\AccountQuery(); // \Dcm\Model\AccountQuery | 
$limit = 100; // int | Number of accounts returned. Used in pagination
$offset = 0; // int | Pagination offset

try {
    $result = $api_instance->controllersAccountAccountList($body, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->controllersAccountAccountList: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://dcmapi.dolead.com/v1

Class	Method	HTTP request	Description
AccountApi	controllersAccountAccountList	GET /account	List accounts matching given criteria
AdApi	controllersAdAdList	GET /ad	List ads matching given criteria
AdGroupApi	controllersAdGroupAdGroupList	GET /ad_group	List adgroups matching given criteria
CallCampaignManagementApi	controllersCallsRegisterCallsStats	POST /calls/statistics	Provide custom call metrics to Dolead system.
CampaignApi	controllersCampaignCampaignList	GET /campaign	List campaigns matching given criteria
CampaignApi	controllersCampaignGet	GET /campaign/{campaign_id}	Get campaign by its id
CampaignApi	controllersCampaignUpdateMany	PUT /campaign	Update campaigns matching given criteria.
CampaignApi	controllersCampaignUpdateOne	PUT /campaign/{campaign_id}	Update campaign by its id
CampaignBidModifierApi	controllersCampaignBidModifierBimoList	GET /campaign/{campaign_id}/bid_modifier/{bm_type}	List campaign bid modifiers matching given criteria
CampaignBidModifierApi	controllersCampaignBidModifierGet	GET /campaign/{campaign_id}/bid_modifier/{bm_type}/{bid_modifier_id}	Get bid modifier by its id
CampaignBidModifierApi	controllersCampaignBidModifierUpdateMany	PUT /campaign/{campaign_id}/bid_modifier/{bm_type}	Update bid modifiers matching given criteria.
CampaignBidModifierApi	controllersCampaignBidModifierUpdateOne	PUT /campaign/{campaign_id}/bid_modifier/{bm_type}/{bid_modifier_id}	Update bid_modifier by its id
GeoBidModifierApi	controllersGeoBidModifierBimoList	GET /geo_bid_modifier/{biddable_level}/{biddable_id}/	Get bid modifier on an object (account, campaign, ad_group)
GeoBidModifierApi	controllersGeoBidModifierUpdateMany	PUT /geo_bid_modifier/{biddable_level}/{biddable_id}/	Update multiple bid modifiers
KeywordApi	controllersKeywordKeywordList	GET /keyword	List keywords matching given criteria
ProductApi	controllersProductGet	GET /product/{product_id}	Get product by its Dolead id
ProductApi	controllersProductProductList	GET /product	List product matching given criteria
ProductApi	controllersProductUpdateMany	PUT /product	Update campaigns matching given criteria.
ProductApi	controllersProductUpdateOne	PUT /product/{product_id}	Update product by its id
RevenueTrackingApi	controllersClickRevenueAdwordsContext	GET /adwords_click_revenue/context	Get the Dolead context of the click (Account, Campaign, Keyword, AdGroup, Ad)
RevenueTrackingApi	controllersClickRevenueAdwordsUpsert	POST /adwords_click_revenue/upsert_many	Create or update a list of Adwords conversions / revenues, using gclid
RevenueTrackingApi	controllersClickRevenueBingContext	GET /bing_click_revenue/context	Get the Dolead context from a Bing click context.
RevenueTrackingApi	controllersClickRevenueBingUpsert	POST /bing_click_revenue/upsert_many	Create or update a list of Bing Ads conversions / revenues, using Bing URL tracking
StatisticApi	controllersStatisticsGetCampaignSegmentedStatistics	GET /campaign/segmented_statistics/{campaign_id}/{period_start}/{period_end}	Get campaign stats for a given period, segmented by day.
StatisticApi	controllersStatisticsGetCampaignStatistics	GET /campaign/statistics/{campaign_id}/{period_start}/{period_end}	Get campaign stats for a given period.

Documentation For Models

• Account
• AccountQuery
• Ad
• AdGroup
• AdGroupQuery
• AdQuery
• AdwordsClickRevenue
• BidModifier
• BidModifierQuery
• BidModifierUpdate
• BingClickContext
• BingClickRevenue
• CallsStatistic
• Campaign
• CampaignQuery
• CampaignUpdate
• ClickContext
• GeoBidModifier
• GeoBidModifierUpdateResponse
• GeoCriteria
• IDParameter
• Keyword
• KeywordQuery
• Product
• ProductQuery
• ProductUpdate
• SingleCampaignStatistic
• TextParameter
• UpdatableBidModifier
• UpdatableCampaign
• UpdatableProduct

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: DCM-API-KEY
• Location: HTTP header

Author