@google-ads/admanager
Version:
Google Ad Manager API client for Node.js
1,065 lines • 87.1 kB
JavaScript
"use strict";
// Copyright 2026 Google LLC
//
// 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
//
// https://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.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.LineItemServiceClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v1/line_item_service_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./line_item_service_client_config.json");
const version = require('../../../package.json').version;
/**
* Provides methods for handling `LineItem` objects.
* @class
* @memberof v1
*/
class LineItemServiceClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('admanager');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
pathTemplates;
lineItemServiceStub;
/**
* Construct an instance of LineItemServiceClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new LineItemServiceClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
this._servicePath = 'admanager.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
// Implicitly enable HTTP transport for the APIs that use REST as transport (e.g. Google Cloud Compute).
if (!opts) {
opts = { fallback: true };
}
else {
opts.fallback = opts.fallback ?? true;
}
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// Request numeric enum values if REST transport is used.
opts.numericEnums = true;
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set useJWTAccessWithScope on the auth object.
this.auth.useJWTAccessWithScope = true;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
// Determine the client header string.
const clientHeader = [
`gax/${this._gaxModule.version}`,
`gapic/${version}`,
];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// This API contains "path templates"; forward-slash-separated
// identifiers to uniquely identify resources within the API.
// Create useful helper objects for these.
this.pathTemplates = {
adBreakPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}'),
adReviewCenterAdPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad}'),
adUnitPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/adUnits/{ad_unit}'),
applicationPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/applications/{application}'),
audienceSegmentPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/audienceSegments/{audience_segment}'),
bandwidthGroupPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/bandwidthGroups/{bandwidth_group}'),
browserPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/browsers/{browser}'),
browserLanguagePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/browserLanguages/{browser_language}'),
cmsMetadataKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}'),
cmsMetadataValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/cmsMetadataValues/{cms_metadata_value}'),
companyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/companies/{company}'),
contactPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contacts/{contact}'),
contentPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/content/{content}'),
contentBundlePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contentBundles/{content_bundle}'),
contentLabelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contentLabels/{content_label}'),
creativeTemplatePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/creativeTemplates/{creative_template}'),
customFieldPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customFields/{custom_field}'),
customTargetingKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingKeys/{custom_targeting_key}'),
customTargetingValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingValues/{custom_targeting_value}'),
deviceCapabilityPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCapabilities/{device_capability}'),
deviceCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCategories/{device_category}'),
deviceManufacturerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceManufacturers/{device_manufacturer}'),
entitySignalsMappingPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}'),
geoTargetPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/geoTargets/{geo_target}'),
labelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/labels/{label}'),
lineItemPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/lineItems/{line_item}'),
liveStreamEventPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/liveStreamEvents/{live_stream_event}'),
mobileCarrierPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/mobileCarriers/{mobile_carrier}'),
mobileDevicePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/mobileDevices/{mobile_device}'),
mobileDeviceSubmodelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/mobileDeviceSubmodels/{mobile_device_submodel}'),
networkPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}'),
operatingSystemPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystems/{operating_system}'),
operatingSystemVersionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystemVersions/{operating_system_version}'),
orderPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/orders/{order}'),
placementPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/placements/{placement}'),
privateAuctionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctions/{private_auction}'),
privateAuctionDealPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctionDeals/{private_auction_deal}'),
programmaticBuyerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/programmaticBuyers/{programmatic_buyer}'),
reportPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/reports/{report}'),
rolePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/roles/{role}'),
sitePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/sites/{site}'),
taxonomyCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/taxonomyCategories/{taxonomy_category}'),
teamPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/teams/{team}'),
userPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/users/{user}'),
webPropertyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/webProperties/{web_property}'),
};
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
listLineItems: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'lineItems')
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.ads.admanager.v1.LineItemService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.lineItemServiceStub) {
return this.lineItemServiceStub;
}
// Put together the "service stub" for
// google.ads.admanager.v1.LineItemService.
this.lineItemServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.ads.admanager.v1.LineItemService') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.ads.admanager.v1.LineItemService, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const lineItemServiceStubMethods = ['getLineItem', 'listLineItems'];
for (const methodName of lineItemServiceStubMethods) {
const callPromise = this.lineItemServiceStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.lineItemServiceStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'admanager.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'admanager.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/admanager'
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
getLineItem(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getLineItem request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getLineItem response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getLineItem(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getLineItem response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
listLineItems(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listLineItems values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listLineItems request %j', request);
return this.innerApiCalls
.listLineItems(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listLineItems values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listLineItems`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent, which owns this collection of LineItems.
* Format: `networks/{network_code}`
* @param {number} [request.pageSize]
* Optional. The maximum number of `LineItems` to return. The service may
* return fewer than this value. If unspecified, at most 50 `LineItems` will
* be returned. The maximum value is 1000; values greater than 1000 will be
* coerced to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListLineItems` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListLineItems` must
* match the call that provided the page token.
* @param {string} [request.filter]
* Optional. Expression to filter the response.
* See syntax details at
* https://developers.google.com/ad-manager/api/beta/filters
* @param {string} [request.orderBy]
* Optional. Expression to specify sorting order.
* See syntax details at
* https://developers.google.com/ad-manager/api/beta/filters#order
* @param {number} [request.skip]
* Optional. Number of individual resources to skip while paginating.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.ads.admanager.v1.LineItem|LineItem} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listLineItemsAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listLineItemsStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
const defaultCallSettings = this._defaults['listLineItems'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listLineItems stream %j', request);
return this.descriptors.page.listLineItems.createStream(this.innerApiCalls.listLineItems, request, callSettings);
}
/**
* Equivalent to `listLineItems`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent, which owns this collection of LineItems.
* Format: `networks/{network_code}`
* @param {number} [request.pageSize]
* Optional. The maximum number of `LineItems` to return. The service may
* return fewer than this value. If unspecified, at most 50 `LineItems` will
* be returned. The maximum value is 1000; values greater than 1000 will be
* coerced to 1000.
* @param {string} [request.pageToken]
* Optional. A page token, received from a previous `ListLineItems` call.
* Provide this to retrieve the subsequent page.
*
* When paginating, all other parameters provided to `ListLineItems` must
* match the call that provided the page token.
* @param {string} [request.filter]
* Optional. Expression to filter the response.
* See syntax details at
* https://developers.google.com/ad-manager/api/beta/filters
* @param {string} [request.orderBy]
* Optional. Expression to specify sorting order.
* See syntax details at
* https://developers.google.com/ad-manager/api/beta/filters#order
* @param {number} [request.skip]
* Optional. Number of individual resources to skip while paginating.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.ads.admanager.v1.LineItem|LineItem}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1/line_item_service.list_line_items.js</caption>
* region_tag:admanager_v1_generated_LineItemService_ListLineItems_async
*/
listLineItemsAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'parent': request.parent ?? '',
});
const defaultCallSettings = this._defaults['listLineItems'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listLineItems iterate %j', request);
return this.descriptors.page.listLineItems.asyncIterate(this.innerApiCalls['listLineItems'], request, callSettings);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified adBreak resource name string.
*
* @param {string} network_code
* @param {string} asset_key
* @param {string} ad_break
* @returns {string} Resource name string.
*/
adBreakPath(networkCode, assetKey, adBreak) {
return this.pathTemplates.adBreakPathTemplate.render({
network_code: networkCode,
asset_key: assetKey,
ad_break: adBreak,
});
}
/**
* Parse the network_code from AdBreak resource.
*
* @param {string} adBreakName
* A fully-qualified path representing AdBreak resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromAdBreakName(adBreakName) {
return this.pathTemplates.adBreakPathTemplate.match(adBreakName).network_code;
}
/**
* Parse the asset_key from AdBreak resource.
*
* @param {string} adBreakName
* A fully-qualified path representing AdBreak resource.
* @returns {string} A string representing the asset_key.
*/
matchAssetKeyFromAdBreakName(adBreakName) {
return this.pathTemplates.adBreakPathTemplate.match(adBreakName).asset_key;
}
/**
* Parse the ad_break from AdBreak resource.
*
* @param {string} adBreakName
* A fully-qualified path representing AdBreak resource.
* @returns {string} A string representing the ad_break.
*/
matchAdBreakFromAdBreakName(adBreakName) {
return this.pathTemplates.adBreakPathTemplate.match(adBreakName).ad_break;
}
/**
* Return a fully-qualified adReviewCenterAd resource name string.
*
* @param {string} network_code
* @param {string} web_property_code
* @param {string} ad_review_center_ad
* @returns {string} Resource name string.
*/
adReviewCenterAdPath(networkCode, webPropertyCode, adReviewCenterAd) {
return this.pathTemplates.adReviewCenterAdPathTemplate.render({
network_code: networkCode,
web_property_code: webPropertyCode,
ad_review_center_ad: adReviewCenterAd,
});
}
/**
* Parse the network_code from AdReviewCenterAd resource.
*
* @param {string} adReviewCenterAdName
* A fully-qualified path representing AdReviewCenterAd resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName) {
return this.pathTemplates.adReviewCenterAdPathTemplate.match(adReviewCenterAdName).network_code;
}
/**
* Parse the web_property_code from AdReviewCenterAd resource.
*
* @param {string} adReviewCenterAdName
* A fully-qualified path representing AdReviewCenterAd resource.
* @returns {string} A string representing the web_property_code.
*/
matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName) {
return this.pathTemplates.adReviewCenterAdPathTemplate.match(adReviewCenterAdName).web_property_code;
}
/**
* Parse the ad_review_center_ad from AdReviewCenterAd resource.
*
* @param {string} adReviewCenterAdName
* A fully-qualified path representing AdReviewCenterAd resource.
* @returns {string} A string representing the ad_review_center_ad.
*/
matchAdReviewCenterAdFromAdReviewCenterAdName(adReviewCenterAdName) {
return this.pathTemplates.adReviewCenterAdPathTemplate.match(adReviewCenterAdName).ad_review_center_ad;
}
/**
* Return a fully-qualified adUnit resource name string.
*
* @param {string} network_code
* @param {string} ad_unit
* @returns {string} Resource name string.
*/
adUnitPath(networkCode, adUnit) {
return this.pathTemplates.adUnitPathTemplate.render({
network_code: networkCode,
ad_unit: adUnit,
});
}
/**
* Parse the network_code from AdUnit resource.
*
* @param {string} adUnitName
* A fully-qualified path representing AdUnit resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromAdUnitName(adUnitName) {
return this.pathTemplates.adUnitPathTemplate.match(adUnitName).network_code;
}
/**
* Parse the ad_unit from AdUnit resource.
*
* @param {string} adUnitName
* A fully-qualified path representing AdUnit resource.
* @returns {string} A string representing the ad_unit.
*/
matchAdUnitFromAdUnitName(adUnitName) {
return this.pathTemplates.adUnitPathTemplate.match(adUnitName).ad_unit;
}
/**
* Return a fully-qualified application resource name string.
*
* @param {string} network_code
* @param {string} application
* @returns {string} Resource name string.
*/
applicationPath(networkCode, application) {
return this.pathTemplates.applicationPathTemplate.render({
network_code: networkCode,
application: application,
});
}
/**
* Parse the network_code from Application resource.
*
* @param {string} applicationName
* A fully-qualified path representing Application resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromApplicationName(applicationName) {
return this.pathTemplates.applicationPathTemplate.match(applicationName).network_code;
}
/**
* Parse the application from Application resource.
*
* @param {string} applicationName
* A fully-qualified path representing Application resource.
* @returns {string} A string representing the application.
*/
matchApplicationFromApplicationName(applicationName) {
return this.pathTemplates.applicationPathTemplate.match(applicationName).application;
}
/**
* Return a fully-qualified audienceSegment resource name string.
*
* @param {string} network_code
* @param {string} audience_segment
* @returns {string} Resource name string.
*/
audienceSegmentPath(networkCode, audienceSegment) {
return this.pathTemplates.audienceSegmentPathTemplate.render({
network_code: networkCode,
audience_segment: audienceSegment,
});
}
/**
* Parse the network_code from AudienceSegment resource.
*
* @param {string} audienceSegmentName
* A fully-qualified path representing AudienceSegment resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromAudienceSegmentName(audienceSegmentName) {
return this.pathTemplates.audienceSegmentPathTemplate.match(audienceSegmentName).network_code;
}
/**
* Parse the audience_segment from AudienceSegment resource.
*
* @param {string} audienceSegmentName
* A fully-qualified path representing AudienceSegment resource.
* @returns {string} A string representing the audience_segment.
*/
matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName) {
return this.pathTemplates.audienceSegmentPathTemplate.match(audienceSegmentName).audience_segment;
}
/**
* Return a fully-qualified bandwidthGroup resource name string.
*
* @param {string} network_code
* @param {string} bandwidth_group
* @returns {string} Resource name string.
*/
bandwidthGroupPath(networkCode, bandwidthGroup) {
return this.pathTemplates.bandwidthGroupPathTemplate.render({
network_code: networkCode,
bandwidth_group: bandwidthGroup,
});
}
/**
* Parse the network_code from BandwidthGroup resource.
*
* @param {string} bandwidthGroupName
* A fully-qualified path representing BandwidthGroup resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName) {
return this.pathTemplates.bandwidthGroupPathTemplate.match(bandwidthGroupName).network_code;
}
/**
* Parse the bandwidth_group from BandwidthGroup resource.
*
* @param {string} bandwidthGroupName
* A fully-qualified path representing BandwidthGroup resource.
* @returns {string} A string representing the bandwidth_group.
*/
matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName) {
return this.pathTemplates.bandwidthGroupPathTemplate.match(bandwidthGroupName).bandwidth_group;
}
/**
* Return a fully-qualified browser resource name string.
*
* @param {string} network_code
* @param {string} browser
* @returns {string} Resource name string.
*/
browserPath(networkCode, browser) {
return this.pathTemplates.browserPathTemplate.render({
network_code: networkCode,
browser: browser,
});
}
/**
* Parse the network_code from Browser resource.
*
* @param {string} browserName
* A fully-qualified path representing Browser resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromBrowserName(browserName) {
return this.pathTemplates.browserPathTemplate.match(browserName).network_code;
}
/**
* Parse the browser from Browser resource.
*
* @param {string} browserName
* A fully-qualified path representing Browser resource.
* @returns {string} A string representing the browser.
*/
matchBrowserFromBrowserName(browserName) {
return this.pathTemplates.browserPathTemplate.match(browserName).browser;
}
/**
* Return a fully-qualified browserLanguage resource name string.
*
* @param {string} network_code
* @param {string} browser_language
* @returns {string} Resource name string.
*/
browserLanguagePath(networkCode, browserLanguage) {
return this.pathTemplates.browserLanguagePathTemplate.render({
network_code: networkCode,
browser_language: browserLanguage,
});
}
/**
* Parse the network_code from BrowserLanguage resource.
*
* @param {string} browserLanguageName
* A fully-qualified path representing BrowserLanguage resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromBrowserLanguageName(browserLanguageName) {
return this.pathTemplates.browserLanguagePathTemplate.match(browserLanguageName).network_code;
}
/**
* Parse the browser_language from BrowserLanguage resource.
*
* @param {string} browserLanguageName
* A fully-qualified path representing BrowserLanguage resource.
* @returns {string} A string representing the browser_language.
*/
matchBrowserLanguageFromBrowserLanguageName(browserLanguageName) {
return this.pathTemplates.browserLanguagePathTemplate.match(browserLanguageName).browser_language;
}
/**
* Return a fully-qualified cmsMetadataKey resource name string.
*
* @param {string} network_code
* @param {string} cms_metadata_key
* @returns {string} Resource name string.
*/
cmsMetadataKeyPath(networkCode, cmsMetadataKey) {
return this.pathTemplates.cmsMetadataKeyPathTemplate.render({
network_code: networkCode,
cms_metadata_key: cmsMetadataKey,
});
}
/**
* Parse the network_code from CmsMetadataKey resource.
*
* @param {string} cmsMetadataKeyName
* A fully-qualified path representing CmsMetadataKey resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName) {
return this.pathTemplates.cmsMetadataKeyPathTemplate.match(cmsMetadataKeyName).network_code;
}
/**
* Parse the cms_metadata_key from CmsMetadataKey resource.
*
* @param {string} cmsMetadataKeyName
* A fully-qualified path representing CmsMetadataKey resource.
* @returns {string} A string representing the cms_metadata_key.
*/
matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName) {
return this.pathTemplates.cmsMetadataKeyPathTemplate.match(cmsMetadataKeyName).cms_metadata_key;
}
/**
* Return a fully-qualified cmsMetadataValue resource name string.
*
* @param {string} network_code
* @param {string} cms_metadata_value
* @returns {string} Resource name string.
*/
cmsMetadataValuePath(networkCode, cmsMetadataValue) {
return this.pathTemplates.cmsMetadataValuePathTemplate.render({
network_code: networkCode,
cms_metadata_value: cmsMetadataValue,
});
}
/**
* Parse the network_code from CmsMetadataValue resource.
*
* @param {string} cmsMetadataValueName
* A fully-qualified path representing CmsMetadataValue resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName) {
return this.pathTemplates.cmsMetadataValuePathTemplate.match(cmsMetadataValueName).network_code;
}
/**
* Parse the cms_metadata_value from CmsMetadataValue resource.
*
* @param {string} cmsMetadataValueName
* A fully-qualified path representing CmsMetadataValue resource.
* @returns {string} A string representing the cms_metadata_value.
*/
matchCmsMetadataValueFromCmsMetadataValueName(cmsMetadataValueName) {
return this.pathTemplates.cmsMetadataValuePathTemplate.match(cmsMetadataValueName).cms_metadata_value;
}
/**
* Return a fully-qualified company resource name string.
*
* @param {string} network_code
* @param {string} company
* @returns {string} Resource name string.
*/
companyPath(networkCode, company) {
return this.pathTemplates.companyPathTemplate.render({
network_code: networkCode,
company: company,
});
}
/**
* Parse the network_code from Company resource.
*
* @param {string} companyName
* A fully-qualified path representing Company resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromCompanyName(companyName) {
return this.pathTemplates.companyPathTemplate.match(companyName).network_code;
}
/**
* Parse the company from Company resource.
*
* @param {string} companyName
* A fully-qualified path representing Company resource.
* @returns {string} A string representing the company.
*/
matchCompanyFromCompanyName(companyName) {
return this.pathTemplates.companyPathTemplate.match(companyName).company;
}
/**
* Return a fully-qualified contact resource name string.
*
* @param {string} network_code
* @param {string} contact
* @returns {string} Resource name string.
*/
contactPath(networkCode, contact) {
return this.pathTemplates.contactPathTemplate.render({
network_code: networkCode,
contact: contact,
});
}
/**
* Parse the network_code from Contact resource.
*
* @param {string} contactName
* A fully-qualified path representing Contact resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromContactName(contactName) {
return this.pathTemplates.contactPathTemplate.match(contactName).network_code;
}
/**
* Parse the contact from Contact resource.
*
* @param {string} contactName
* A fully-qualified path representing Contact resource.
* @returns {string} A string representing the contact.
*/
matchContactFromContactName(contactName) {
return this.pathTemplates.contactPathTemplate.match(contactName).contact;
}
/**
* Return a fully-qualified content resource name string.
*
* @param {string} network_code
* @param {string} content
* @returns {string} Resource name string.
*/
contentPath(networkCode, content) {
return this.pathTemplates.contentPathTemplate.render({
network_code: networkCode,
content: content,
});
}
/**
* Parse the network_code from Content resource.
*
* @param {string} contentName
* A fully-qualified path representing Content resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromContentName(contentName) {
return this.pathTemplates.contentPathTemplate.match(contentName).network_code;
}
/**
* Parse the content from Content resource.
*
* @param {string} contentName
* A fully-qualified path representing Content resource.
* @returns {string} A string representing the content.
*/
matchContentFromContentName(contentName) {
return this.pathTemplates.contentPathTemplate.match(contentName).content;
}
/**
* Return a fully-qualified contentBundle resource name string.
*
* @param {string} network_code
* @param {string} content_bundle
* @returns {string} Resource name string.
*/
contentBundlePath(networkCode, contentBundle) {
return this.pathTemplates.contentBundlePathTemplate.render({
network_code: networkCode,
content_bundle: contentBundle,
});
}
/**
* Parse the network_code from ContentBundle resource.
*
* @param {string} contentBundleName
* A fully-qualified path representing ContentBundle resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromContentBundleName(contentBundleName) {
return this.pathTemplates.contentBundlePathTemplate.match(contentBundleName).network_code;
}
/**
* Parse the content_bundle from ContentBundle resource.
*
* @param {string} contentBundleName
* A fully-qualified path representing ContentBundle resource.
* @returns {string} A string representing the content_bundle.
*/
matchContentBundleFromContentBundleName(contentBundleName) {
return this.pathTemplates.contentBundlePathTemplate.match(contentBundleName).content_bundle;
}
/**
* Return a fully-qualified contentLabel resource name string.
*
* @param {string} network_code
* @param {string} content_label
* @returns {string} Resource name string.
*/
contentLabelPath(networkCode, contentLabel) {
return this.pathTemplates.contentLabelPathTemplate.render({
network_code: networkCode,
content_label: contentLabel,
});
}
/**
* Parse the network_code from ContentLabel resource.
*
* @param {string} contentLabelName
* A fully-qualified path representing ContentLabel resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromContentLabelName(contentLabelName) {
return this.pathTemplates.contentLabelPathTemplate.match(contentLabelName).network_code;
}
/**
* Parse the content_label from ContentLabel resource.
*
* @param {string} contentLabelName
* A fully-qualified path representing ContentLabel resource.
* @returns {string} A string representing the content_label.
*/
matchContentLabelFromContentLabelName(contentLabelName) {
return this.pathTemplates.contentLabelPathTemplate.match(contentLabelName).content_label;
}
/**
* Return a fully-qualified creativeTemplate resource name string.
*
* @param {string} network_code
* @param {string} creative_template
* @returns {string} Resource name string.
*/
creativeTemplatePath(networkCode, creativeTemplate) {
return this.pathTemplates.creativeTemplatePathTemplate.render({
network_code: networkCode,
creative_template: creativeTemplate,
});
}
/**
* Parse the network_code from CreativeTemplate resource.
*
* @param {string} creativeTemplateName
* A fully-qualified path representing CreativeTemplate resource.
* @returns {string} A string representing the network_code.
*/
matchNetworkCodeFromCreativeTemplateName(creativeTemplateName) {
return this.pathTemplates.creativeTemplatePathTemplate.match(creativeTemplateName).network_code;
}
/**
* Parse the creative_template from CreativeTemplate resource.
*
* @param {string} creativeTemplateName
* A fully-qualified path representing CreativeTemplate resource.
* @returns {string} A string representing the creative_template.
*/
matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName) {
return this.pathTemplates.creativeTemplatePathTemplate.match(creativeTemplateName).creative_template;
}
/**
* Return a fully-qualified custom