928 lines
38 KiB
TypeScript
928 lines
38 KiB
TypeScript
/**
|
|
* 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 */
|
|
|
|
import createAPIRequest from '../../lib/apirequest';
|
|
|
|
/**
|
|
* Ad Exchange Seller API
|
|
*
|
|
* Accesses the inventory of Ad Exchange seller users and generates reports.
|
|
*
|
|
* @example
|
|
* const google = require('googleapis');
|
|
* const adexchangeseller = google.adexchangeseller('v1.1');
|
|
*
|
|
* @namespace adexchangeseller
|
|
* @type {Function}
|
|
* @version v1.1
|
|
* @variation v1.1
|
|
* @param {object=} options Options for Adexchangeseller
|
|
*/
|
|
function Adexchangeseller(options) { // eslint-disable-line
|
|
const self = this;
|
|
self._options = options || {};
|
|
|
|
self.accounts = {
|
|
|
|
/**
|
|
* adexchangeseller.accounts.get
|
|
*
|
|
* @desc Get information about the selected Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.accounts.get
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.accountId Account to get information about. Tip: 'myaccount' is a valid 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 + '/adexchangeseller/v1.1/accounts/{accountId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['accountId'],
|
|
pathParams: ['accountId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.adclients = {
|
|
|
|
/**
|
|
* adexchangeseller.adclients.list
|
|
*
|
|
* @desc List all ad clients in this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.adclients.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object=} params Parameters for request
|
|
* @param {integer=} params.maxResults The maximum number of ad clients to include in the response, used for paging.
|
|
* @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.
|
|
* @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 + '/adexchangeseller/v1.1/adclients').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.adunits = {
|
|
|
|
/**
|
|
* adexchangeseller.adunits.get
|
|
*
|
|
* @desc Gets the specified ad unit in the specified ad client.
|
|
*
|
|
* @alias adexchangeseller.adunits.get
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client for which to get the ad unit.
|
|
* @param {string} params.adUnitId Ad unit 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 + '/adexchangeseller/v1.1/adclients/{adClientId}/adunits/{adUnitId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId', 'adUnitId'],
|
|
pathParams: ['adClientId', 'adUnitId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* adexchangeseller.adunits.list
|
|
*
|
|
* @desc List all ad units in the specified ad client for this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.adunits.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client for which to list ad units.
|
|
* @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true.
|
|
* @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging.
|
|
* @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
|
* @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 + '/adexchangeseller/v1.1/adclients/{adClientId}/adunits').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId'],
|
|
pathParams: ['adClientId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
customchannels: {
|
|
|
|
/**
|
|
* adexchangeseller.adunits.customchannels.list
|
|
*
|
|
* @desc List all custom channels which the specified ad unit belongs to.
|
|
*
|
|
* @alias adexchangeseller.adunits.customchannels.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client which contains the ad unit.
|
|
* @param {string} params.adUnitId Ad unit for which to list custom channels.
|
|
* @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging.
|
|
* @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
|
* @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 + '/adexchangeseller/v1.1/adclients/{adClientId}/adunits/{adUnitId}/customchannels').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId', 'adUnitId'],
|
|
pathParams: ['adClientId', 'adUnitId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
};
|
|
|
|
self.alerts = {
|
|
|
|
/**
|
|
* adexchangeseller.alerts.list
|
|
*
|
|
* @desc List the alerts for this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.alerts.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object=} params Parameters for request
|
|
* @param {string=} params.locale The locale to use for translating alert messages. The account locale will be used if this is not supplied. The AdSense default (English) will be used if the supplied locale is invalid or unsupported.
|
|
* @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 + '/adexchangeseller/v1.1/alerts').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.customchannels = {
|
|
|
|
/**
|
|
* adexchangeseller.customchannels.get
|
|
*
|
|
* @desc Get the specified custom channel from the specified ad client.
|
|
*
|
|
* @alias adexchangeseller.customchannels.get
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client which contains the custom channel.
|
|
* @param {string} params.customChannelId Custom channel 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 + '/adexchangeseller/v1.1/adclients/{adClientId}/customchannels/{customChannelId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId', 'customChannelId'],
|
|
pathParams: ['adClientId', 'customChannelId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* adexchangeseller.customchannels.list
|
|
*
|
|
* @desc List all custom channels in the specified ad client for this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.customchannels.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client for which to list custom channels.
|
|
* @param {integer=} params.maxResults The maximum number of custom channels to include in the response, used for paging.
|
|
* @param {string=} params.pageToken A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
|
* @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 + '/adexchangeseller/v1.1/adclients/{adClientId}/customchannels').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId'],
|
|
pathParams: ['adClientId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
adunits: {
|
|
|
|
/**
|
|
* adexchangeseller.customchannels.adunits.list
|
|
*
|
|
* @desc List all ad units in the specified custom channel.
|
|
*
|
|
* @alias adexchangeseller.customchannels.adunits.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client which contains the custom channel.
|
|
* @param {string} params.customChannelId Custom channel for which to list ad units.
|
|
* @param {boolean=} params.includeInactive Whether to include inactive ad units. Default: true.
|
|
* @param {integer=} params.maxResults The maximum number of ad units to include in the response, used for paging.
|
|
* @param {string=} params.pageToken A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
|
* @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 + '/adexchangeseller/v1.1/adclients/{adClientId}/customchannels/{customChannelId}/adunits').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId', 'customChannelId'],
|
|
pathParams: ['adClientId', 'customChannelId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
};
|
|
|
|
self.metadata = {
|
|
dimensions: {
|
|
|
|
/**
|
|
* adexchangeseller.metadata.dimensions.list
|
|
*
|
|
* @desc List the metadata for the dimensions available to this AdExchange account.
|
|
*
|
|
* @alias adexchangeseller.metadata.dimensions.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @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 + '/adexchangeseller/v1.1/metadata/dimensions').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
},
|
|
metrics: {
|
|
|
|
/**
|
|
* adexchangeseller.metadata.metrics.list
|
|
*
|
|
* @desc List the metadata for the metrics available to this AdExchange account.
|
|
*
|
|
* @alias adexchangeseller.metadata.metrics.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @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 + '/adexchangeseller/v1.1/metadata/metrics').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
};
|
|
|
|
self.preferreddeals = {
|
|
|
|
/**
|
|
* adexchangeseller.preferreddeals.get
|
|
*
|
|
* @desc Get information about the selected Ad Exchange Preferred Deal.
|
|
*
|
|
* @alias adexchangeseller.preferreddeals.get
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.dealId Preferred deal to get information about.
|
|
* @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 + '/adexchangeseller/v1.1/preferreddeals/{dealId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['dealId'],
|
|
pathParams: ['dealId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* adexchangeseller.preferreddeals.list
|
|
*
|
|
* @desc List the preferred deals for this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.preferreddeals.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @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 + '/adexchangeseller/v1.1/preferreddeals').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.reports = {
|
|
|
|
/**
|
|
* adexchangeseller.reports.generate
|
|
*
|
|
* @desc Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter.
|
|
*
|
|
* @alias adexchangeseller.reports.generate
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string=} params.dimension Dimensions to base the report on.
|
|
* @param {string} params.endDate End of the date range to report on in "YYYY-MM-DD" format, inclusive.
|
|
* @param {string=} params.filter Filters to be run on the report.
|
|
* @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
|
* @param {integer=} params.maxResults The maximum number of rows of report data to return.
|
|
* @param {string=} params.metric Numeric columns to include in the report.
|
|
* @param {string=} params.sort The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.
|
|
* @param {string} params.startDate Start of the date range to report on in "YYYY-MM-DD" format, inclusive.
|
|
* @param {integer=} params.startIndex Index of the first row of report data to return.
|
|
* @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
|
|
*/
|
|
generate: 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 + '/adexchangeseller/v1.1/reports').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['startDate', 'endDate'],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
saved: {
|
|
|
|
/**
|
|
* adexchangeseller.reports.saved.generate
|
|
*
|
|
* @desc Generate an Ad Exchange report based on the saved report ID sent in the query parameters.
|
|
*
|
|
* @alias adexchangeseller.reports.saved.generate
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string=} params.locale Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.
|
|
* @param {integer=} params.maxResults The maximum number of rows of report data to return.
|
|
* @param {string} params.savedReportId The saved report to retrieve.
|
|
* @param {integer=} params.startIndex Index of the first row of report data to return.
|
|
* @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
|
|
*/
|
|
generate: 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 + '/adexchangeseller/v1.1/reports/{savedReportId}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['savedReportId'],
|
|
pathParams: ['savedReportId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* adexchangeseller.reports.saved.list
|
|
*
|
|
* @desc List all saved reports in this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.reports.saved.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object=} params Parameters for request
|
|
* @param {integer=} params.maxResults The maximum number of saved reports to include in the response, used for paging.
|
|
* @param {string=} params.pageToken A continuation token, used to page through saved reports. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
|
* @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 + '/adexchangeseller/v1.1/reports/saved').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
};
|
|
|
|
self.urlchannels = {
|
|
|
|
/**
|
|
* adexchangeseller.urlchannels.list
|
|
*
|
|
* @desc List all URL channels in the specified ad client for this Ad Exchange account.
|
|
*
|
|
* @alias adexchangeseller.urlchannels.list
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.adClientId Ad client for which to list URL channels.
|
|
* @param {integer=} params.maxResults The maximum number of URL channels to include in the response, used for paging.
|
|
* @param {string=} params.pageToken A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.
|
|
* @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 + '/adexchangeseller/v1.1/adclients/{adClientId}/urlchannels').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['adClientId'],
|
|
pathParams: ['adClientId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @typedef Account
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} id Unique identifier of this account.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#account.
|
|
* @property {string} name Name of this account.
|
|
*/
|
|
|
|
/**
|
|
* @typedef AdClient
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {boolean} arcOptIn Whether this ad client is opted in to ARC.
|
|
* @property {string} id Unique identifier of this ad client.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#adClient.
|
|
* @property {string} productCode This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
|
|
* @property {boolean} supportsReporting Whether this ad client supports being reported on.
|
|
*/
|
|
|
|
/**
|
|
* @typedef AdClients
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} etag ETag of this response for caching purposes.
|
|
* @property {adexchangeseller(v1.1).AdClient[]} items The ad clients returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#adClients.
|
|
* @property {string} nextPageToken Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
|
*/
|
|
|
|
/**
|
|
* @typedef AdUnit
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} code Identity code of this ad unit, not necessarily unique across ad clients.
|
|
* @property {string} id Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#adUnit.
|
|
* @property {string} name Name of this ad unit.
|
|
* @property {string} status Status of this ad unit. Possible values are:
|
|
NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
|
|
|
|
ACTIVE: Indicates that there has been activity on this ad unit in the last seven days.
|
|
|
|
INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.
|
|
*/
|
|
|
|
/**
|
|
* @typedef AdUnits
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} etag ETag of this response for caching purposes.
|
|
* @property {adexchangeseller(v1.1).AdUnit[]} items The ad units returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#adUnits.
|
|
* @property {string} nextPageToken Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Alert
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} id Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#alert.
|
|
* @property {string} message The localized alert message.
|
|
* @property {string} severity Severity of this alert. Possible values: INFO, WARNING, SEVERE.
|
|
* @property {string} type Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Alerts
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {adexchangeseller(v1.1).Alert[]} items The alerts returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#alerts.
|
|
*/
|
|
|
|
/**
|
|
* @typedef CustomChannel
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} code Code of this custom channel, not necessarily unique across ad clients.
|
|
* @property {string} id Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#customChannel.
|
|
* @property {string} name Name of this custom channel.
|
|
* @property {object} targetingInfo The targeting information of this custom channel, if activated.
|
|
*/
|
|
|
|
/**
|
|
* @typedef CustomChannels
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} etag ETag of this response for caching purposes.
|
|
* @property {adexchangeseller(v1.1).CustomChannel[]} items The custom channels returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#customChannels.
|
|
* @property {string} nextPageToken Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Metadata
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {adexchangeseller(v1.1).ReportingMetadataEntry[]} items
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#metadata.
|
|
*/
|
|
|
|
/**
|
|
* @typedef PreferredDeal
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} advertiserName The name of the advertiser this deal is for.
|
|
* @property {string} buyerNetworkName The name of the buyer network this deal is for.
|
|
* @property {string} currencyCode The currency code that applies to the fixed_cpm value. If not set then assumed to be USD.
|
|
* @property {string} endTime Time when this deal stops being active in seconds since the epoch (GMT). If not set then this deal is valid until manually disabled by the publisher.
|
|
* @property {string} fixedCpm The fixed price for this preferred deal. In cpm micros of currency according to currencyCode. If set, then this preferred deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).
|
|
* @property {string} id Unique identifier of this preferred deal.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#preferredDeal.
|
|
* @property {string} startTime Time when this deal becomes active in seconds since the epoch (GMT). If not set then this deal is active immediately upon creation.
|
|
*/
|
|
|
|
/**
|
|
* @typedef PreferredDeals
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {adexchangeseller(v1.1).PreferredDeal[]} items The preferred deals returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#preferredDeals.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Report
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string[]} averages The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
|
* @property {object[]} headers The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.
|
|
* @property {string} kind Kind this is, in this case adexchangeseller#report.
|
|
* @property {array[]} rows The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.
|
|
* @property {string} totalMatchedRows The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.
|
|
* @property {string[]} totals The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
|
|
* @property {string[]} warnings Any warnings associated with generation of the report.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ReportingMetadataEntry
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string[]} compatibleDimensions For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.
|
|
* @property {string[]} compatibleMetrics The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.
|
|
* @property {string} id Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#reportingMetadataEntry.
|
|
* @property {string[]} requiredDimensions The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
|
|
* @property {string[]} requiredMetrics The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.
|
|
* @property {string[]} supportedProducts The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SavedReport
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} id Unique identifier of this saved report.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#savedReport.
|
|
* @property {string} name This saved report's name.
|
|
*/
|
|
|
|
/**
|
|
* @typedef SavedReports
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} etag ETag of this response for caching purposes.
|
|
* @property {adexchangeseller(v1.1).SavedReport[]} items The saved reports returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#savedReports.
|
|
* @property {string} nextPageToken Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
|
*/
|
|
|
|
/**
|
|
* @typedef UrlChannel
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} id Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.
|
|
* @property {string} kind Kind of resource this is, in this case adexchangeseller#urlChannel.
|
|
* @property {string} urlPattern URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
|
|
*/
|
|
|
|
/**
|
|
* @typedef UrlChannels
|
|
* @memberOf! adexchangeseller(v1.1)
|
|
* @type object
|
|
* @property {string} etag ETag of this response for caching purposes.
|
|
* @property {adexchangeseller(v1.1).UrlChannel[]} items The URL channels returned in this list response.
|
|
* @property {string} kind Kind of list this is, in this case adexchangeseller#urlChannels.
|
|
* @property {string} nextPageToken Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
|
|
*/
|
|
export = Adexchangeseller;
|