"use strict"; /** * Copyright 2015 Google Inc. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* jshint maxlen: false */ const apirequest_1 = require("../../lib/apirequest"); /** * Ad Exchange Buyer API * * Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports. * * @example * const google = require('googleapis'); * const adexchangebuyer = google.adexchangebuyer('v1.3'); * * @namespace adexchangebuyer * @type {Function} * @version v1.3 * @variation v1.3 * @param {object=} options Options for Adexchangebuyer */ function Adexchangebuyer(options) { const self = this; self._options = options || {}; self.accounts = { /** * adexchangebuyer.accounts.get * * @desc Gets one account by ID. * * @alias adexchangebuyer.accounts.get * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/accounts/{id}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['id'], pathParams: ['id'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.accounts.list * * @desc Retrieves the authenticated user's list of accounts. * * @alias adexchangebuyer.accounts.list * @memberOf! adexchangebuyer(v1.3) * * @param {object=} params Parameters for request * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/accounts').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: [], pathParams: [], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.accounts.patch * * @desc Updates an existing account. This method supports patch semantics. * * @alias adexchangebuyer.accounts.patch * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {adexchangebuyer(v1.3).Account} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/accounts/{id}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH' }, options), params: params, requiredParams: ['id'], pathParams: ['id'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.accounts.update * * @desc Updates an existing account. * * @alias adexchangebuyer.accounts.update * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {integer} params.id The account id * @param {adexchangebuyer(v1.3).Account} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/accounts/{id}').replace(/([^:]\/)\/+/g, '$1'), method: 'PUT' }, options), params: params, requiredParams: ['id'], pathParams: ['id'], context: self }; return apirequest_1.default(parameters, callback); } }; self.billingInfo = { /** * adexchangebuyer.billingInfo.get * * @desc Returns the billing information for one account specified by account ID. * * @alias adexchangebuyer.billingInfo.get * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {integer} params.accountId The account id. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/billinginfo/{accountId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['accountId'], pathParams: ['accountId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.billingInfo.list * * @desc Retrieves a list of billing information for all accounts of the authenticated user. * * @alias adexchangebuyer.billingInfo.list * @memberOf! adexchangebuyer(v1.3) * * @param {object=} params Parameters for request * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/billinginfo').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: [], pathParams: [], context: self }; return apirequest_1.default(parameters, callback); } }; self.budget = { /** * adexchangebuyer.budget.get * * @desc Returns the budget information for the adgroup specified by the accountId and billingId. * * @alias adexchangebuyer.budget.get * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to get the budget information for. * @param {string} params.billingId The billing id to get the budget information for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/billinginfo/{accountId}/{billingId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['accountId', 'billingId'], pathParams: ['accountId', 'billingId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.budget.patch * * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics. * * @alias adexchangebuyer.budget.patch * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id associated with the budget being updated. * @param {string} params.billingId The billing id associated with the budget being updated. * @param {adexchangebuyer(v1.3).Budget} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/billinginfo/{accountId}/{billingId}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH' }, options), params: params, requiredParams: ['accountId', 'billingId'], pathParams: ['accountId', 'billingId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.budget.update * * @desc Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. * * @alias adexchangebuyer.budget.update * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id associated with the budget being updated. * @param {string} params.billingId The billing id associated with the budget being updated. * @param {adexchangebuyer(v1.3).Budget} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/billinginfo/{accountId}/{billingId}').replace(/([^:]\/)\/+/g, '$1'), method: 'PUT' }, options), params: params, requiredParams: ['accountId', 'billingId'], pathParams: ['accountId', 'billingId'], context: self }; return apirequest_1.default(parameters, callback); } }; self.creatives = { /** * adexchangebuyer.creatives.get * * @desc Gets the status for a single creative. A creative will be available 30-40 minutes after submission. * * @alias adexchangebuyer.creatives.get * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {integer} params.accountId The id for the account that will serve this creative. * @param {string} params.buyerCreativeId The buyer-specific id for this creative. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/creatives/{accountId}/{buyerCreativeId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['accountId', 'buyerCreativeId'], pathParams: ['accountId', 'buyerCreativeId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.creatives.insert * * @desc Submit a new creative. * * @alias adexchangebuyer.creatives.insert * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {adexchangebuyer(v1.3).Creative} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/creatives').replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params: params, requiredParams: [], pathParams: [], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.creatives.list * * @desc Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. * * @alias adexchangebuyer.creatives.list * @memberOf! adexchangebuyer(v1.3) * * @param {object=} params Parameters for request * @param {integer=} params.accountId When specified, only creatives for the given account ids are returned. * @param {string=} params.buyerCreativeId When specified, only creatives for the given buyer creative ids are returned. * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. * @param {string=} params.pageToken A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. * @param {string=} params.statusFilter When specified, only creatives having the given status are returned. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/creatives').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: [], pathParams: [], context: self }; return apirequest_1.default(parameters, callback); } }; self.directDeals = { /** * adexchangebuyer.directDeals.get * * @desc Gets one direct deal by ID. * * @alias adexchangebuyer.directDeals.get * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.id The direct deal id * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/directdeals/{id}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['id'], pathParams: ['id'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.directDeals.list * * @desc Retrieves the authenticated user's list of direct deals. * * @alias adexchangebuyer.directDeals.list * @memberOf! adexchangebuyer(v1.3) * * @param {object=} params Parameters for request * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/directdeals').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: [], pathParams: [], context: self }; return apirequest_1.default(parameters, callback); } }; self.performanceReport = { /** * adexchangebuyer.performanceReport.list * * @desc Retrieves the authenticated user's list of performance metrics. * * @alias adexchangebuyer.performanceReport.list * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to get the reports. * @param {string} params.endDateTime The end time of the report in ISO 8601 timestamp format using UTC. * @param {integer=} params.maxResults Maximum number of entries returned on one result page. If not set, the default is 100. Optional. * @param {string=} params.pageToken A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional. * @param {string} params.startDateTime The start time of the report in ISO 8601 timestamp format using UTC. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/performancereport').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['accountId', 'endDateTime', 'startDateTime'], pathParams: [], context: self }; return apirequest_1.default(parameters, callback); } }; self.pretargetingConfig = { /** * adexchangebuyer.pretargetingConfig.delete * * @desc Deletes an existing pretargeting config. * * @alias adexchangebuyer.pretargetingConfig.delete * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to delete the pretargeting config for. * @param {string} params.configId The specific id of the configuration to delete. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/pretargetingconfigs/{accountId}/{configId}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE' }, options), params: params, requiredParams: ['accountId', 'configId'], pathParams: ['accountId', 'configId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.pretargetingConfig.get * * @desc Gets a specific pretargeting configuration * * @alias adexchangebuyer.pretargetingConfig.get * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to get the pretargeting config for. * @param {string} params.configId The specific id of the configuration to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/pretargetingconfigs/{accountId}/{configId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['accountId', 'configId'], pathParams: ['accountId', 'configId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.pretargetingConfig.insert * * @desc Inserts a new pretargeting configuration. * * @alias adexchangebuyer.pretargetingConfig.insert * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to insert the pretargeting config for. * @param {adexchangebuyer(v1.3).PretargetingConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ insert: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/pretargetingconfigs/{accountId}').replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, options), params: params, requiredParams: ['accountId'], pathParams: ['accountId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.pretargetingConfig.list * * @desc Retrieves a list of the authenticated user's pretargeting configurations. * * @alias adexchangebuyer.pretargetingConfig.list * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to get the pretargeting configs for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/pretargetingconfigs/{accountId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, options), params: params, requiredParams: ['accountId'], pathParams: ['accountId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.pretargetingConfig.patch * * @desc Updates an existing pretargeting config. This method supports patch semantics. * * @alias adexchangebuyer.pretargetingConfig.patch * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to update the pretargeting config for. * @param {string} params.configId The specific id of the configuration to update. * @param {adexchangebuyer(v1.3).PretargetingConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/pretargetingconfigs/{accountId}/{configId}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH' }, options), params: params, requiredParams: ['accountId', 'configId'], pathParams: ['accountId', 'configId'], context: self }; return apirequest_1.default(parameters, callback); }, /** * adexchangebuyer.pretargetingConfig.update * * @desc Updates an existing pretargeting config. * * @alias adexchangebuyer.pretargetingConfig.update * @memberOf! adexchangebuyer(v1.3) * * @param {object} params Parameters for request * @param {string} params.accountId The account id to update the pretargeting config for. * @param {string} params.configId The specific id of the configuration to update. * @param {adexchangebuyer(v1.3).PretargetingConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update: function (params, options, callback) { if (typeof options === 'function') { callback = options; options = {}; } options || (options = {}); const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; const parameters = { options: Object.assign({ url: (rootUrl + '/adexchangebuyer/v1.3/pretargetingconfigs/{accountId}/{configId}').replace(/([^:]\/)\/+/g, '$1'), method: 'PUT' }, options), params: params, requiredParams: ['accountId', 'configId'], pathParams: ['accountId', 'configId'], context: self }; return apirequest_1.default(parameters, callback); } }; } module.exports = Adexchangebuyer; //# sourceMappingURL=v1.3.js.map