Class v1.NetworkServiceClient (0.6.0)

Provides methods for handling Network objects. v1

Package

@google-ads/admanager

Constructors

(constructor)(opts, gaxInstance)

  constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 , 
  
 gaxInstance 
 ?: 
  
 typeof 
  
 gax 
  
 | 
  
 typeof 
  
 gax 
 . 
 fallback 
 ); 
 

Construct an instance of NetworkServiceClient.

Parameters
Name
Description
opts
ClientOptions
gaxInstance
typeof gax | typeof fallback

: 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 NetworkServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

  get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ; 
 

The DNS address for this API service.

apiEndpoint

  static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ; 
 

The DNS address for this API service - same as servicePath.

auth

  auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ; 
 

descriptors

  descriptors 
 : 
  
 Descriptors 
 ; 
 

innerApiCalls

  innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }; 
 

networkServiceStub

  networkServiceStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>; 
 

pathTemplates

  pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 }; 
 

port

  static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ; 
 

The port for this API service.

scopes

  static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 []; 
 

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

  static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ; 
 

The DNS address for this API service.

universeDomain

  get 
  
 universeDomain 
 () 
 : 
  
 string 
 ; 
 

warn

  warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ; 
 

Methods

adBreakPath(networkCode, assetKey, adBreak)

  adBreakPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 assetKey 
 : 
  
 string 
 , 
  
 adBreak 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified adBreak resource name string.

Parameters
Name
Description
networkCode
string
assetKey
string
adBreak
string
Returns
Type
Description
string

{string} Resource name string.

adReviewCenterAdPath(networkCode, webPropertyCode, adReviewCenterAd)

  adReviewCenterAdPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 webPropertyCode 
 : 
  
 string 
 , 
  
 adReviewCenterAd 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified adReviewCenterAd resource name string.

Parameters
Name
Description
networkCode
string
webPropertyCode
string
adReviewCenterAd
string
Returns
Type
Description
string

{string} Resource name string.

adUnitPath(networkCode, adUnit)

  adUnitPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 adUnit 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified adUnit resource name string.

Parameters
Name
Description
networkCode
string
adUnit
string
Returns
Type
Description
string

{string} Resource name string.

applicationPath(networkCode, application)

  applicationPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 application 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified application resource name string.

Parameters
Name
Description
networkCode
string
application
string
Returns
Type
Description
string

{string} Resource name string.

audienceSegmentPath(networkCode, audienceSegment)

  audienceSegmentPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 audienceSegment 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified audienceSegment resource name string.

Parameters
Name
Description
networkCode
string
audienceSegment
string
Returns
Type
Description
string

{string} Resource name string.

bandwidthGroupPath(networkCode, bandwidthGroup)

  bandwidthGroupPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 bandwidthGroup 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified bandwidthGroup resource name string.

Parameters
Name
Description
networkCode
string
bandwidthGroup
string
Returns
Type
Description
string

{string} Resource name string.

browserLanguagePath(networkCode, browserLanguage)

  browserLanguagePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 browserLanguage 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified browserLanguage resource name string.

Parameters
Name
Description
networkCode
string
browserLanguage
string
Returns
Type
Description
string

{string} Resource name string.

browserPath(networkCode, browser)

  browserPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 browser 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified browser resource name string.

Parameters
Name
Description
networkCode
string
browser
string
Returns
Type
Description
string

{string} Resource name string.

childPublisherPath(networkCode, childPublisher)

  childPublisherPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 childPublisher 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified childPublisher resource name string.

Parameters
Name
Description
networkCode
string
childPublisher
string
Returns
Type
Description
string

{string} Resource name string.

close()

  close 
 () 
 : 
  
 Promise<void> 
 ; 
 

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type
Description
Promise <void>

{Promise} A promise that resolves when the client is closed.

cmsMetadataKeyPath(networkCode, cmsMetadataKey)

  cmsMetadataKeyPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 cmsMetadataKey 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified cmsMetadataKey resource name string.

Parameters
Name
Description
networkCode
string
cmsMetadataKey
string
Returns
Type
Description
string

{string} Resource name string.

cmsMetadataValuePath(networkCode, cmsMetadataValue)

  cmsMetadataValuePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 cmsMetadataValue 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified cmsMetadataValue resource name string.

Parameters
Name
Description
networkCode
string
cmsMetadataValue
string
Returns
Type
Description
string

{string} Resource name string.

companyPath(networkCode, company)

  companyPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 company 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified company resource name string.

Parameters
Name
Description
networkCode
string
company
string
Returns
Type
Description
string

{string} Resource name string.

contactPath(networkCode, contact)

  contactPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 contact 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified contact resource name string.

Parameters
Name
Description
networkCode
string
contact
string
Returns
Type
Description
string

{string} Resource name string.

contentBundlePath(networkCode, contentBundle)

  contentBundlePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 contentBundle 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified contentBundle resource name string.

Parameters
Name
Description
networkCode
string
contentBundle
string
Returns
Type
Description
string

{string} Resource name string.

  contentLabelPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 contentLabel 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified contentLabel resource name string.

Parameters
Name
Description
networkCode
string
contentLabel
string
Returns
Type
Description
string

{string} Resource name string.

contentPath(networkCode, content)

  contentPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 content 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified content resource name string.

Parameters
Name
Description
networkCode
string
content
string
Returns
Type
Description
string

{string} Resource name string.

creativeTemplatePath(networkCode, creativeTemplate)

  creativeTemplatePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 creativeTemplate 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified creativeTemplate resource name string.

Parameters
Name
Description
networkCode
string
creativeTemplate
string
Returns
Type
Description
string

{string} Resource name string.

customFieldPath(networkCode, customField)

  customFieldPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 customField 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified customField resource name string.

Parameters
Name
Description
networkCode
string
customField
string
Returns
Type
Description
string

{string} Resource name string.

customTargetingKeyPath(networkCode, customTargetingKey)

  customTargetingKeyPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 customTargetingKey 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified customTargetingKey resource name string.

Parameters
Name
Description
networkCode
string
customTargetingKey
string
Returns
Type
Description
string

{string} Resource name string.

customTargetingValuePath(networkCode, customTargetingValue)

  customTargetingValuePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 customTargetingValue 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified customTargetingValue resource name string.

Parameters
Name
Description
networkCode
string
customTargetingValue
string
Returns
Type
Description
string

{string} Resource name string.

deviceCapabilityPath(networkCode, deviceCapability)

  deviceCapabilityPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 deviceCapability 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified deviceCapability resource name string.

Parameters
Name
Description
networkCode
string
deviceCapability
string
Returns
Type
Description
string

{string} Resource name string.

deviceCategoryPath(networkCode, deviceCategory)

  deviceCategoryPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 deviceCategory 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified deviceCategory resource name string.

Parameters
Name
Description
networkCode
string
deviceCategory
string
Returns
Type
Description
string

{string} Resource name string.

deviceManufacturerPath(networkCode, deviceManufacturer)

  deviceManufacturerPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 deviceManufacturer 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified deviceManufacturer resource name string.

Parameters
Name
Description
networkCode
string
deviceManufacturer
string
Returns
Type
Description
string

{string} Resource name string.

entitySignalsMappingPath(networkCode, entitySignalsMapping)

  entitySignalsMappingPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 entitySignalsMapping 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified entitySignalsMapping resource name string.

Parameters
Name
Description
networkCode
string
entitySignalsMapping
string
Returns
Type
Description
string

{string} Resource name string.

geoTargetPath(networkCode, geoTarget)

  geoTargetPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 geoTarget 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified geoTarget resource name string.

Parameters
Name
Description
networkCode
string
geoTarget
string
Returns
Type
Description
string

{string} Resource name string.

getNetwork(request, options)

  getNetwork 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IGetNetworkRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IGetNetworkRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>; 
 

API to retrieve a Network object.

Parameters
Name
Description
request
IGetNetworkRequest

The request object that will be sent.

options
CallOptions

Call options. See CallOptions for more details.

Returns
Type
Description

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Network . Please see the documentation for more details and examples.

Example
   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. Resource name of Network. 
 *  Format: networks/{network_code} 
 */ 
  
 // const name = 'abc123' 
  
 // Imports the Admanager library 
  
 const 
  
 { 
 NetworkServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-ads/admanager 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 admanagerClient 
  
 = 
  
 new 
  
  NetworkServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callGetNetwork 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 admanagerClient 
 . 
 getNetwork 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callGetNetwork 
 (); 
 

getNetwork(request, options, callback)

  getNetwork 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IGetNetworkRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IGetNetworkRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Name
Description
options
CallOptions
callback
Callback < protos.google.ads.admanager.v1.INetwork , protos.google.ads.admanager.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type
Description
void

getNetwork(request, callback)

  getNetwork 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IGetNetworkRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IGetNetworkRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Name
Description
callback
Callback < protos.google.ads.admanager.v1.INetwork , protos.google.ads.admanager.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>
Returns
Type
Description
void

getProjectId()

  getProjectId 
 () 
 : 
  
 Promise<string> 
 ; 
 
Returns
Type
Description
Promise <string>

getProjectId(callback)

  getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ; 
 
Parameter
Name
Description
callback
Callback <string, undefined, undefined>
Returns
Type
Description
void

initialize()

  initialize 
 () 
 : 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>; 
 

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
Type
Description
Promise <{ [name: string]: Function ; }>

{Promise} A promise that resolves to an authenticated service stub.

labelPath(networkCode, label)

  labelPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 label 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified label resource name string.

Parameters
Name
Description
networkCode
string
label
string
Returns
Type
Description
string

{string} Resource name string.

lineItemPath(networkCode, lineItem)

  lineItemPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 lineItem 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified lineItem resource name string.

Parameters
Name
Description
networkCode
string
lineItem
string
Returns
Type
Description
string

{string} Resource name string.

linkedDevicePath(networkCode, linkedDevice)

  linkedDevicePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 linkedDevice 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified linkedDevice resource name string.

Parameters
Name
Description
networkCode
string
linkedDevice
string
Returns
Type
Description
string

{string} Resource name string.

listNetworks(request, options)

  listNetworks 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
 [], 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksResponse 
  
 ]>; 
 

API to retrieve all the networks the current user has access to.

Parameters
Name
Description
request
IListNetworksRequest

The request object that will be sent.

options
CallOptions

Call options. See CallOptions for more details.

Returns
Type
Description

{Promise} - The promise which resolves to an array. The first element of the array is Array of Network . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listNetworksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNetworks(request, options, callback)

  listNetworks 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
> ) 
 : 
  
 void 
 ; 
 
Parameters
Name
Description
options
CallOptions
Returns
Type
Description
void

listNetworks(request, callback)

  listNetworks 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
> ) 
 : 
  
 void 
 ; 
 
Returns
Type
Description
void

listNetworksAsync(request, options)

  listNetworksAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 INetwork 
> ; 
 

Equivalent to listNetworks , but returns an iterable object.

for - await - of syntax is used with the iterable to get response elements on-demand.

Parameters
Name
Description
request
IListNetworksRequest

The request object that will be sent.

options
CallOptions

Call options. See CallOptions for more details.

Returns
Type
Description

{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Network . 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 documentation for more details and examples.

Example
   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Optional. The maximum number of `Network`s to return. The service may 
 *  return fewer than this value. If unspecified, at most 50 `Network`s will be 
 *  returned. The maximum value is 1000; values greater than 1000 will be 
 *  coerced to 1000. 
 */ 
  
 // const pageSize = 1234 
  
 /** 
 *  Optional. A page token, received from a previous `ListNetworks` call. 
 *  Provide this to retrieve the subsequent page. 
 *  When paginating, all other parameters provided to `ListNetworks` must match 
 *  the call that provided the page token. 
 */ 
  
 // const pageToken = 'abc123' 
  
 /** 
 *  Optional. Number of individual resources to skip while paginating. 
 */ 
  
 // const skip = 1234 
  
 // Imports the Admanager library 
  
 const 
  
 { 
 NetworkServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-ads/admanager 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 admanagerClient 
  
 = 
  
 new 
  
  NetworkServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callListNetworks 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 }; 
  
 // Run request 
  
 const 
  
 iterable 
  
 = 
  
 admanagerClient 
 . 
  listNetworksAsync 
 
 ( 
 request 
 ); 
  
 for 
  
 await 
  
 ( 
 const 
  
 response 
  
 of 
  
 iterable 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 } 
  
 callListNetworks 
 (); 
 

listNetworksStream(request, options)

  listNetworksStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 ads 
 . 
 admanager 
 . 
 v1 
 . 
 IListNetworksRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ; 
 

Equivalent to listNetworks , but returns a NodeJS Stream object.

Parameters
Name
Description
request
IListNetworksRequest

The request object that will be sent.

options
CallOptions

Call options. See CallOptions for more details.

Returns
Type
Description
Transform

{Stream} An object stream which emits an object representing Network 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 listNetworksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

liveStreamEventPath(networkCode, liveStreamEvent)

  liveStreamEventPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 liveStreamEvent 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified liveStreamEvent resource name string.

Parameters
Name
Description
networkCode
string
liveStreamEvent
string
Returns
Type
Description
string

{string} Resource name string.

matchAdBreakFromAdBreakName(adBreakName)

  matchAdBreakFromAdBreakName 
 ( 
 adBreakName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the ad_break from AdBreak resource.

Parameter
Name
Description
adBreakName
string

A fully-qualified path representing AdBreak resource.

Returns
Type
Description
string | number

{string} A string representing the ad_break.

matchAdReviewCenterAdFromAdReviewCenterAdName(adReviewCenterAdName)

  matchAdReviewCenterAdFromAdReviewCenterAdName 
 ( 
 adReviewCenterAdName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the ad_review_center_ad from AdReviewCenterAd resource.

Parameter
Name
Description
adReviewCenterAdName
string

A fully-qualified path representing AdReviewCenterAd resource.

Returns
Type
Description
string | number

{string} A string representing the ad_review_center_ad.

matchAdUnitFromAdUnitName(adUnitName)

  matchAdUnitFromAdUnitName 
 ( 
 adUnitName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the ad_unit from AdUnit resource.

Parameter
Name
Description
adUnitName
string

A fully-qualified path representing AdUnit resource.

Returns
Type
Description
string | number

{string} A string representing the ad_unit.

matchApplicationFromApplicationName(applicationName)

  matchApplicationFromApplicationName 
 ( 
 applicationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the application from Application resource.

Parameter
Name
Description
applicationName
string

A fully-qualified path representing Application resource.

Returns
Type
Description
string | number

{string} A string representing the application.

matchAssetKeyFromAdBreakName(adBreakName)

  matchAssetKeyFromAdBreakName 
 ( 
 adBreakName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the asset_key from AdBreak resource.

Parameter
Name
Description
adBreakName
string

A fully-qualified path representing AdBreak resource.

Returns
Type
Description
string | number

{string} A string representing the asset_key.

matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName)

  matchAudienceSegmentFromAudienceSegmentName 
 ( 
 audienceSegmentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the audience_segment from AudienceSegment resource.

Parameter
Name
Description
audienceSegmentName
string

A fully-qualified path representing AudienceSegment resource.

Returns
Type
Description
string | number

{string} A string representing the audience_segment.

matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName)

  matchBandwidthGroupFromBandwidthGroupName 
 ( 
 bandwidthGroupName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the bandwidth_group from BandwidthGroup resource.

Parameter
Name
Description
bandwidthGroupName
string

A fully-qualified path representing BandwidthGroup resource.

Returns
Type
Description
string | number

{string} A string representing the bandwidth_group.

matchBrowserFromBrowserName(browserName)

  matchBrowserFromBrowserName 
 ( 
 browserName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the browser from Browser resource.

Parameter
Name
Description
browserName
string

A fully-qualified path representing Browser resource.

Returns
Type
Description
string | number

{string} A string representing the browser.

matchBrowserLanguageFromBrowserLanguageName(browserLanguageName)

  matchBrowserLanguageFromBrowserLanguageName 
 ( 
 browserLanguageName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the browser_language from BrowserLanguage resource.

Parameter
Name
Description
browserLanguageName
string

A fully-qualified path representing BrowserLanguage resource.

Returns
Type
Description
string | number

{string} A string representing the browser_language.

matchChildPublisherFromChildPublisherName(childPublisherName)

  matchChildPublisherFromChildPublisherName 
 ( 
 childPublisherName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the child_publisher from ChildPublisher resource.

Parameter
Name
Description
childPublisherName
string

A fully-qualified path representing ChildPublisher resource.

Returns
Type
Description
string | number

{string} A string representing the child_publisher.

matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName)

  matchCmsMetadataKeyFromCmsMetadataKeyName 
 ( 
 cmsMetadataKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the cms_metadata_key from CmsMetadataKey resource.

Parameter
Name
Description
cmsMetadataKeyName
string

A fully-qualified path representing CmsMetadataKey resource.

Returns
Type
Description
string | number

{string} A string representing the cms_metadata_key.

matchCmsMetadataValueFromCmsMetadataValueName(cmsMetadataValueName)

  matchCmsMetadataValueFromCmsMetadataValueName 
 ( 
 cmsMetadataValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the cms_metadata_value from CmsMetadataValue resource.

Parameter
Name
Description
cmsMetadataValueName
string

A fully-qualified path representing CmsMetadataValue resource.

Returns
Type
Description
string | number

{string} A string representing the cms_metadata_value.

matchCompanyFromCompanyName(companyName)

  matchCompanyFromCompanyName 
 ( 
 companyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the company from Company resource.

Parameter
Name
Description
companyName
string

A fully-qualified path representing Company resource.

Returns
Type
Description
string | number

{string} A string representing the company.

matchContactFromContactName(contactName)

  matchContactFromContactName 
 ( 
 contactName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the contact from Contact resource.

Parameter
Name
Description
contactName
string

A fully-qualified path representing Contact resource.

Returns
Type
Description
string | number

{string} A string representing the contact.

matchContentBundleFromContentBundleName(contentBundleName)

  matchContentBundleFromContentBundleName 
 ( 
 contentBundleName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the content_bundle from ContentBundle resource.

Parameter
Name
Description
contentBundleName
string

A fully-qualified path representing ContentBundle resource.

Returns
Type
Description
string | number

{string} A string representing the content_bundle.

matchContentFromContentName(contentName)

  matchContentFromContentName 
 ( 
 contentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the content from Content resource.

Parameter
Name
Description
contentName
string

A fully-qualified path representing Content resource.

Returns
Type
Description
string | number

{string} A string representing the content.

matchContentLabelFromContentLabelName(contentLabelName)

  matchContentLabelFromContentLabelName 
 ( 
 contentLabelName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the content_label from ContentLabel resource.

Parameter
Name
Description
contentLabelName
string

A fully-qualified path representing ContentLabel resource.

Returns
Type
Description
string | number

{string} A string representing the content_label.

matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName)

  matchCreativeTemplateFromCreativeTemplateName 
 ( 
 creativeTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the creative_template from CreativeTemplate resource.

Parameter
Name
Description
creativeTemplateName
string

A fully-qualified path representing CreativeTemplate resource.

Returns
Type
Description
string | number

{string} A string representing the creative_template.

matchCustomFieldFromCustomFieldName(customFieldName)

  matchCustomFieldFromCustomFieldName 
 ( 
 customFieldName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the custom_field from CustomField resource.

Parameter
Name
Description
customFieldName
string

A fully-qualified path representing CustomField resource.

Returns
Type
Description
string | number

{string} A string representing the custom_field.

matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName)

  matchCustomTargetingKeyFromCustomTargetingKeyName 
 ( 
 customTargetingKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the custom_targeting_key from CustomTargetingKey resource.

Parameter
Name
Description
customTargetingKeyName
string

A fully-qualified path representing CustomTargetingKey resource.

Returns
Type
Description
string | number

{string} A string representing the custom_targeting_key.

matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName)

  matchCustomTargetingValueFromCustomTargetingValueName 
 ( 
 customTargetingValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the custom_targeting_value from CustomTargetingValue resource.

Parameter
Name
Description
customTargetingValueName
string

A fully-qualified path representing CustomTargetingValue resource.

Returns
Type
Description
string | number

{string} A string representing the custom_targeting_value.

matchDeviceCapabilityFromDeviceCapabilityName(deviceCapabilityName)

  matchDeviceCapabilityFromDeviceCapabilityName 
 ( 
 deviceCapabilityName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the device_capability from DeviceCapability resource.

Parameter
Name
Description
deviceCapabilityName
string

A fully-qualified path representing DeviceCapability resource.

Returns
Type
Description
string | number

{string} A string representing the device_capability.

matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName)

  matchDeviceCategoryFromDeviceCategoryName 
 ( 
 deviceCategoryName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the device_category from DeviceCategory resource.

Parameter
Name
Description
deviceCategoryName
string

A fully-qualified path representing DeviceCategory resource.

Returns
Type
Description
string | number

{string} A string representing the device_category.

matchDeviceManufacturerFromDeviceManufacturerName(deviceManufacturerName)

  matchDeviceManufacturerFromDeviceManufacturerName 
 ( 
 deviceManufacturerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the device_manufacturer from DeviceManufacturer resource.

Parameter
Name
Description
deviceManufacturerName
string

A fully-qualified path representing DeviceManufacturer resource.

Returns
Type
Description
string | number

{string} A string representing the device_manufacturer.

matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName)

  matchEntitySignalsMappingFromEntitySignalsMappingName 
 ( 
 entitySignalsMappingName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the entity_signals_mapping from EntitySignalsMapping resource.

Parameter
Name
Description
entitySignalsMappingName
string

A fully-qualified path representing EntitySignalsMapping resource.

Returns
Type
Description
string | number

{string} A string representing the entity_signals_mapping.

matchGeoTargetFromGeoTargetName(geoTargetName)

  matchGeoTargetFromGeoTargetName 
 ( 
 geoTargetName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the geo_target from GeoTarget resource.

Parameter
Name
Description
geoTargetName
string

A fully-qualified path representing GeoTarget resource.

Returns
Type
Description
string | number

{string} A string representing the geo_target.

matchLabelFromLabelName(labelName)

  matchLabelFromLabelName 
 ( 
 labelName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the label from Label resource.

Parameter
Name
Description
labelName
string

A fully-qualified path representing Label resource.

Returns
Type
Description
string | number

{string} A string representing the label.

matchLineItemFromLineItemName(lineItemName)

  matchLineItemFromLineItemName 
 ( 
 lineItemName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the line_item from LineItem resource.

Parameter
Name
Description
lineItemName
string

A fully-qualified path representing LineItem resource.

Returns
Type
Description
string | number

{string} A string representing the line_item.

matchLinkedDeviceFromLinkedDeviceName(linkedDeviceName)

  matchLinkedDeviceFromLinkedDeviceName 
 ( 
 linkedDeviceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the linked_device from LinkedDevice resource.

Parameter
Name
Description
linkedDeviceName
string

A fully-qualified path representing LinkedDevice resource.

Returns
Type
Description
string | number

{string} A string representing the linked_device.

matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName)

  matchLiveStreamEventFromLiveStreamEventName 
 ( 
 liveStreamEventName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the live_stream_event from LiveStreamEvent resource.

Parameter
Name
Description
liveStreamEventName
string

A fully-qualified path representing LiveStreamEvent resource.

Returns
Type
Description
string | number

{string} A string representing the live_stream_event.

matchMobileCarrierFromMobileCarrierName(mobileCarrierName)

  matchMobileCarrierFromMobileCarrierName 
 ( 
 mobileCarrierName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the mobile_carrier from MobileCarrier resource.

Parameter
Name
Description
mobileCarrierName
string

A fully-qualified path representing MobileCarrier resource.

Returns
Type
Description
string | number

{string} A string representing the mobile_carrier.

matchMobileDeviceFromMobileDeviceName(mobileDeviceName)

  matchMobileDeviceFromMobileDeviceName 
 ( 
 mobileDeviceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the mobile_device from MobileDevice resource.

Parameter
Name
Description
mobileDeviceName
string

A fully-qualified path representing MobileDevice resource.

Returns
Type
Description
string | number

{string} A string representing the mobile_device.

matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName)

  matchMobileDeviceSubmodelFromMobileDeviceSubmodelName 
 ( 
 mobileDeviceSubmodelName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the mobile_device_submodel from MobileDeviceSubmodel resource.

Parameter
Name
Description
mobileDeviceSubmodelName
string

A fully-qualified path representing MobileDeviceSubmodel resource.

Returns
Type
Description
string | number

{string} A string representing the mobile_device_submodel.

matchNetworkCodeFromAdBreakName(adBreakName)

  matchNetworkCodeFromAdBreakName 
 ( 
 adBreakName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from AdBreak resource.

Parameter
Name
Description
adBreakName
string

A fully-qualified path representing AdBreak resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName)

  matchNetworkCodeFromAdReviewCenterAdName 
 ( 
 adReviewCenterAdName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from AdReviewCenterAd resource.

Parameter
Name
Description
adReviewCenterAdName
string

A fully-qualified path representing AdReviewCenterAd resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromAdUnitName(adUnitName)

  matchNetworkCodeFromAdUnitName 
 ( 
 adUnitName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from AdUnit resource.

Parameter
Name
Description
adUnitName
string

A fully-qualified path representing AdUnit resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromApplicationName(applicationName)

  matchNetworkCodeFromApplicationName 
 ( 
 applicationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Application resource.

Parameter
Name
Description
applicationName
string

A fully-qualified path representing Application resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromAudienceSegmentName(audienceSegmentName)

  matchNetworkCodeFromAudienceSegmentName 
 ( 
 audienceSegmentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from AudienceSegment resource.

Parameter
Name
Description
audienceSegmentName
string

A fully-qualified path representing AudienceSegment resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName)

  matchNetworkCodeFromBandwidthGroupName 
 ( 
 bandwidthGroupName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from BandwidthGroup resource.

Parameter
Name
Description
bandwidthGroupName
string

A fully-qualified path representing BandwidthGroup resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromBrowserLanguageName(browserLanguageName)

  matchNetworkCodeFromBrowserLanguageName 
 ( 
 browserLanguageName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from BrowserLanguage resource.

Parameter
Name
Description
browserLanguageName
string

A fully-qualified path representing BrowserLanguage resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromBrowserName(browserName)

  matchNetworkCodeFromBrowserName 
 ( 
 browserName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Browser resource.

Parameter
Name
Description
browserName
string

A fully-qualified path representing Browser resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromChildPublisherName(childPublisherName)

  matchNetworkCodeFromChildPublisherName 
 ( 
 childPublisherName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from ChildPublisher resource.

Parameter
Name
Description
childPublisherName
string

A fully-qualified path representing ChildPublisher resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName)

  matchNetworkCodeFromCmsMetadataKeyName 
 ( 
 cmsMetadataKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from CmsMetadataKey resource.

Parameter
Name
Description
cmsMetadataKeyName
string

A fully-qualified path representing CmsMetadataKey resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName)

  matchNetworkCodeFromCmsMetadataValueName 
 ( 
 cmsMetadataValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from CmsMetadataValue resource.

Parameter
Name
Description
cmsMetadataValueName
string

A fully-qualified path representing CmsMetadataValue resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCompanyName(companyName)

  matchNetworkCodeFromCompanyName 
 ( 
 companyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Company resource.

Parameter
Name
Description
companyName
string

A fully-qualified path representing Company resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromContactName(contactName)

  matchNetworkCodeFromContactName 
 ( 
 contactName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Contact resource.

Parameter
Name
Description
contactName
string

A fully-qualified path representing Contact resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromContentBundleName(contentBundleName)

  matchNetworkCodeFromContentBundleName 
 ( 
 contentBundleName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from ContentBundle resource.

Parameter
Name
Description
contentBundleName
string

A fully-qualified path representing ContentBundle resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromContentLabelName(contentLabelName)

  matchNetworkCodeFromContentLabelName 
 ( 
 contentLabelName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from ContentLabel resource.

Parameter
Name
Description
contentLabelName
string

A fully-qualified path representing ContentLabel resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromContentName(contentName)

  matchNetworkCodeFromContentName 
 ( 
 contentName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Content resource.

Parameter
Name
Description
contentName
string

A fully-qualified path representing Content resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCreativeTemplateName(creativeTemplateName)

  matchNetworkCodeFromCreativeTemplateName 
 ( 
 creativeTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from CreativeTemplate resource.

Parameter
Name
Description
creativeTemplateName
string

A fully-qualified path representing CreativeTemplate resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCustomFieldName(customFieldName)

  matchNetworkCodeFromCustomFieldName 
 ( 
 customFieldName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from CustomField resource.

Parameter
Name
Description
customFieldName
string

A fully-qualified path representing CustomField resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName)

  matchNetworkCodeFromCustomTargetingKeyName 
 ( 
 customTargetingKeyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from CustomTargetingKey resource.

Parameter
Name
Description
customTargetingKeyName
string

A fully-qualified path representing CustomTargetingKey resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName)

  matchNetworkCodeFromCustomTargetingValueName 
 ( 
 customTargetingValueName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from CustomTargetingValue resource.

Parameter
Name
Description
customTargetingValueName
string

A fully-qualified path representing CustomTargetingValue resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromDeviceCapabilityName(deviceCapabilityName)

  matchNetworkCodeFromDeviceCapabilityName 
 ( 
 deviceCapabilityName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from DeviceCapability resource.

Parameter
Name
Description
deviceCapabilityName
string

A fully-qualified path representing DeviceCapability resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromDeviceCategoryName(deviceCategoryName)

  matchNetworkCodeFromDeviceCategoryName 
 ( 
 deviceCategoryName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from DeviceCategory resource.

Parameter
Name
Description
deviceCategoryName
string

A fully-qualified path representing DeviceCategory resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromDeviceManufacturerName(deviceManufacturerName)

  matchNetworkCodeFromDeviceManufacturerName 
 ( 
 deviceManufacturerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from DeviceManufacturer resource.

Parameter
Name
Description
deviceManufacturerName
string

A fully-qualified path representing DeviceManufacturer resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName)

  matchNetworkCodeFromEntitySignalsMappingName 
 ( 
 entitySignalsMappingName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from EntitySignalsMapping resource.

Parameter
Name
Description
entitySignalsMappingName
string

A fully-qualified path representing EntitySignalsMapping resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromGeoTargetName(geoTargetName)

  matchNetworkCodeFromGeoTargetName 
 ( 
 geoTargetName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from GeoTarget resource.

Parameter
Name
Description
geoTargetName
string

A fully-qualified path representing GeoTarget resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromLabelName(labelName)

  matchNetworkCodeFromLabelName 
 ( 
 labelName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Label resource.

Parameter
Name
Description
labelName
string

A fully-qualified path representing Label resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromLineItemName(lineItemName)

  matchNetworkCodeFromLineItemName 
 ( 
 lineItemName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from LineItem resource.

Parameter
Name
Description
lineItemName
string

A fully-qualified path representing LineItem resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromLinkedDeviceName(linkedDeviceName)

  matchNetworkCodeFromLinkedDeviceName 
 ( 
 linkedDeviceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from LinkedDevice resource.

Parameter
Name
Description
linkedDeviceName
string

A fully-qualified path representing LinkedDevice resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromLiveStreamEventName(liveStreamEventName)

  matchNetworkCodeFromLiveStreamEventName 
 ( 
 liveStreamEventName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from LiveStreamEvent resource.

Parameter
Name
Description
liveStreamEventName
string

A fully-qualified path representing LiveStreamEvent resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromMobileCarrierName(mobileCarrierName)

  matchNetworkCodeFromMobileCarrierName 
 ( 
 mobileCarrierName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from MobileCarrier resource.

Parameter
Name
Description
mobileCarrierName
string

A fully-qualified path representing MobileCarrier resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromMobileDeviceName(mobileDeviceName)

  matchNetworkCodeFromMobileDeviceName 
 ( 
 mobileDeviceName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from MobileDevice resource.

Parameter
Name
Description
mobileDeviceName
string

A fully-qualified path representing MobileDevice resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromMobileDeviceSubmodelName(mobileDeviceSubmodelName)

  matchNetworkCodeFromMobileDeviceSubmodelName 
 ( 
 mobileDeviceSubmodelName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from MobileDeviceSubmodel resource.

Parameter
Name
Description
mobileDeviceSubmodelName
string

A fully-qualified path representing MobileDeviceSubmodel resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromNetworkName(networkName)

  matchNetworkCodeFromNetworkName 
 ( 
 networkName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Network resource.

Parameter
Name
Description
networkName
string

A fully-qualified path representing Network resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromOperatingSystemName(operatingSystemName)

  matchNetworkCodeFromOperatingSystemName 
 ( 
 operatingSystemName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from OperatingSystem resource.

Parameter
Name
Description
operatingSystemName
string

A fully-qualified path representing OperatingSystem resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName)

  matchNetworkCodeFromOperatingSystemVersionName 
 ( 
 operatingSystemVersionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from OperatingSystemVersion resource.

Parameter
Name
Description
operatingSystemVersionName
string

A fully-qualified path representing OperatingSystemVersion resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromOrderName(orderName)

  matchNetworkCodeFromOrderName 
 ( 
 orderName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Order resource.

Parameter
Name
Description
orderName
string

A fully-qualified path representing Order resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromPlacementName(placementName)

  matchNetworkCodeFromPlacementName 
 ( 
 placementName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Placement resource.

Parameter
Name
Description
placementName
string

A fully-qualified path representing Placement resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName)

  matchNetworkCodeFromPrivateAuctionDealName 
 ( 
 privateAuctionDealName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from PrivateAuctionDeal resource.

Parameter
Name
Description
privateAuctionDealName
string

A fully-qualified path representing PrivateAuctionDeal resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromPrivateAuctionName(privateAuctionName)

  matchNetworkCodeFromPrivateAuctionName 
 ( 
 privateAuctionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from PrivateAuction resource.

Parameter
Name
Description
privateAuctionName
string

A fully-qualified path representing PrivateAuction resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName)

  matchNetworkCodeFromProgrammaticBuyerName 
 ( 
 programmaticBuyerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from ProgrammaticBuyer resource.

Parameter
Name
Description
programmaticBuyerName
string

A fully-qualified path representing ProgrammaticBuyer resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromReportName(reportName)

  matchNetworkCodeFromReportName 
 ( 
 reportName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Report resource.

Parameter
Name
Description
reportName
string

A fully-qualified path representing Report resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromRichMediaAdsCompanyName(richMediaAdsCompanyName)

  matchNetworkCodeFromRichMediaAdsCompanyName 
 ( 
 richMediaAdsCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from RichMediaAdsCompany resource.

Parameter
Name
Description
richMediaAdsCompanyName
string

A fully-qualified path representing RichMediaAdsCompany resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromRoleName(roleName)

  matchNetworkCodeFromRoleName 
 ( 
 roleName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Role resource.

Parameter
Name
Description
roleName
string

A fully-qualified path representing Role resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromSiteName(siteName)

  matchNetworkCodeFromSiteName 
 ( 
 siteName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Site resource.

Parameter
Name
Description
siteName
string

A fully-qualified path representing Site resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName)

  matchNetworkCodeFromTaxonomyCategoryName 
 ( 
 taxonomyCategoryName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from TaxonomyCategory resource.

Parameter
Name
Description
taxonomyCategoryName
string

A fully-qualified path representing TaxonomyCategory resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromTeamName(teamName)

  matchNetworkCodeFromTeamName 
 ( 
 teamName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from Team resource.

Parameter
Name
Description
teamName
string

A fully-qualified path representing Team resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromUserName(userName)

  matchNetworkCodeFromUserName 
 ( 
 userName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from User resource.

Parameter
Name
Description
userName
string

A fully-qualified path representing User resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchNetworkCodeFromWebPropertyName(webPropertyName)

  matchNetworkCodeFromWebPropertyName 
 ( 
 webPropertyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the network_code from WebProperty resource.

Parameter
Name
Description
webPropertyName
string

A fully-qualified path representing WebProperty resource.

Returns
Type
Description
string | number

{string} A string representing the network_code.

matchOperatingSystemFromOperatingSystemName(operatingSystemName)

  matchOperatingSystemFromOperatingSystemName 
 ( 
 operatingSystemName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the operating_system from OperatingSystem resource.

Parameter
Name
Description
operatingSystemName
string

A fully-qualified path representing OperatingSystem resource.

Returns
Type
Description
string | number

{string} A string representing the operating_system.

matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName)

  matchOperatingSystemVersionFromOperatingSystemVersionName 
 ( 
 operatingSystemVersionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the operating_system_version from OperatingSystemVersion resource.

Parameter
Name
Description
operatingSystemVersionName
string

A fully-qualified path representing OperatingSystemVersion resource.

Returns
Type
Description
string | number

{string} A string representing the operating_system_version.

matchOrderFromOrderName(orderName)

  matchOrderFromOrderName 
 ( 
 orderName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the order from Order resource.

Parameter
Name
Description
orderName
string

A fully-qualified path representing Order resource.

Returns
Type
Description
string | number

{string} A string representing the order.

matchPlacementFromPlacementName(placementName)

  matchPlacementFromPlacementName 
 ( 
 placementName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the placement from Placement resource.

Parameter
Name
Description
placementName
string

A fully-qualified path representing Placement resource.

Returns
Type
Description
string | number

{string} A string representing the placement.

matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName)

  matchPrivateAuctionDealFromPrivateAuctionDealName 
 ( 
 privateAuctionDealName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the private_auction_deal from PrivateAuctionDeal resource.

Parameter
Name
Description
privateAuctionDealName
string

A fully-qualified path representing PrivateAuctionDeal resource.

Returns
Type
Description
string | number

{string} A string representing the private_auction_deal.

matchPrivateAuctionFromPrivateAuctionName(privateAuctionName)

  matchPrivateAuctionFromPrivateAuctionName 
 ( 
 privateAuctionName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the private_auction from PrivateAuction resource.

Parameter
Name
Description
privateAuctionName
string

A fully-qualified path representing PrivateAuction resource.

Returns
Type
Description
string | number

{string} A string representing the private_auction.

matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName)

  matchProgrammaticBuyerFromProgrammaticBuyerName 
 ( 
 programmaticBuyerName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the programmatic_buyer from ProgrammaticBuyer resource.

Parameter
Name
Description
programmaticBuyerName
string

A fully-qualified path representing ProgrammaticBuyer resource.

Returns
Type
Description
string | number

{string} A string representing the programmatic_buyer.

matchReportFromReportName(reportName)

  matchReportFromReportName 
 ( 
 reportName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the report from Report resource.

Parameter
Name
Description
reportName
string

A fully-qualified path representing Report resource.

Returns
Type
Description
string | number

{string} A string representing the report.

matchRichMediaAdsCompanyFromRichMediaAdsCompanyName(richMediaAdsCompanyName)

  matchRichMediaAdsCompanyFromRichMediaAdsCompanyName 
 ( 
 richMediaAdsCompanyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the rich_media_ads_company from RichMediaAdsCompany resource.

Parameter
Name
Description
richMediaAdsCompanyName
string

A fully-qualified path representing RichMediaAdsCompany resource.

Returns
Type
Description
string | number

{string} A string representing the rich_media_ads_company.

matchRoleFromRoleName(roleName)

  matchRoleFromRoleName 
 ( 
 roleName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the role from Role resource.

Parameter
Name
Description
roleName
string

A fully-qualified path representing Role resource.

Returns
Type
Description
string | number

{string} A string representing the role.

matchSiteFromSiteName(siteName)

  matchSiteFromSiteName 
 ( 
 siteName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the site from Site resource.

Parameter
Name
Description
siteName
string

A fully-qualified path representing Site resource.

Returns
Type
Description
string | number

{string} A string representing the site.

matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName)

  matchTaxonomyCategoryFromTaxonomyCategoryName 
 ( 
 taxonomyCategoryName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the taxonomy_category from TaxonomyCategory resource.

Parameter
Name
Description
taxonomyCategoryName
string

A fully-qualified path representing TaxonomyCategory resource.

Returns
Type
Description
string | number

{string} A string representing the taxonomy_category.

matchTeamFromTeamName(teamName)

  matchTeamFromTeamName 
 ( 
 teamName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the team from Team resource.

Parameter
Name
Description
teamName
string

A fully-qualified path representing Team resource.

Returns
Type
Description
string | number

{string} A string representing the team.

matchUserFromUserName(userName)

  matchUserFromUserName 
 ( 
 userName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the user from User resource.

Parameter
Name
Description
userName
string

A fully-qualified path representing User resource.

Returns
Type
Description
string | number

{string} A string representing the user.

matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName)

  matchWebPropertyCodeFromAdReviewCenterAdName 
 ( 
 adReviewCenterAdName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the web_property_code from AdReviewCenterAd resource.

Parameter
Name
Description
adReviewCenterAdName
string

A fully-qualified path representing AdReviewCenterAd resource.

Returns
Type
Description
string | number

{string} A string representing the web_property_code.

matchWebPropertyFromWebPropertyName(webPropertyName)

  matchWebPropertyFromWebPropertyName 
 ( 
 webPropertyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ; 
 

Parse the web_property from WebProperty resource.

Parameter
Name
Description
webPropertyName
string

A fully-qualified path representing WebProperty resource.

Returns
Type
Description
string | number

{string} A string representing the web_property.

mobileCarrierPath(networkCode, mobileCarrier)

  mobileCarrierPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 mobileCarrier 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified mobileCarrier resource name string.

Parameters
Name
Description
networkCode
string
mobileCarrier
string
Returns
Type
Description
string

{string} Resource name string.

mobileDevicePath(networkCode, mobileDevice)

  mobileDevicePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 mobileDevice 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified mobileDevice resource name string.

Parameters
Name
Description
networkCode
string
mobileDevice
string
Returns
Type
Description
string

{string} Resource name string.

mobileDeviceSubmodelPath(networkCode, mobileDeviceSubmodel)

  mobileDeviceSubmodelPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 mobileDeviceSubmodel 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified mobileDeviceSubmodel resource name string.

Parameters
Name
Description
networkCode
string
mobileDeviceSubmodel
string
Returns
Type
Description
string

{string} Resource name string.

networkPath(networkCode)

  networkPath 
 ( 
 networkCode 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified network resource name string.

Parameter
Name
Description
networkCode
string
Returns
Type
Description
string

{string} Resource name string.

operatingSystemPath(networkCode, operatingSystem)

  operatingSystemPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 operatingSystem 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified operatingSystem resource name string.

Parameters
Name
Description
networkCode
string
operatingSystem
string
Returns
Type
Description
string

{string} Resource name string.

operatingSystemVersionPath(networkCode, operatingSystemVersion)

  operatingSystemVersionPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 operatingSystemVersion 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified operatingSystemVersion resource name string.

Parameters
Name
Description
networkCode
string
operatingSystemVersion
string
Returns
Type
Description
string

{string} Resource name string.

orderPath(networkCode, order)

  orderPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 order 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified order resource name string.

Parameters
Name
Description
networkCode
string
order
string
Returns
Type
Description
string

{string} Resource name string.

placementPath(networkCode, placement)

  placementPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 placement 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified placement resource name string.

Parameters
Name
Description
networkCode
string
placement
string
Returns
Type
Description
string

{string} Resource name string.

privateAuctionDealPath(networkCode, privateAuctionDeal)

  privateAuctionDealPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 privateAuctionDeal 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified privateAuctionDeal resource name string.

Parameters
Name
Description
networkCode
string
privateAuctionDeal
string
Returns
Type
Description
string

{string} Resource name string.

privateAuctionPath(networkCode, privateAuction)

  privateAuctionPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 privateAuction 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified privateAuction resource name string.

Parameters
Name
Description
networkCode
string
privateAuction
string
Returns
Type
Description
string

{string} Resource name string.

programmaticBuyerPath(networkCode, programmaticBuyer)

  programmaticBuyerPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 programmaticBuyer 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified programmaticBuyer resource name string.

Parameters
Name
Description
networkCode
string
programmaticBuyer
string
Returns
Type
Description
string

{string} Resource name string.

reportPath(networkCode, report)

  reportPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 report 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified report resource name string.

Parameters
Name
Description
networkCode
string
report
string
Returns
Type
Description
string

{string} Resource name string.

richMediaAdsCompanyPath(networkCode, richMediaAdsCompany)

  richMediaAdsCompanyPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 richMediaAdsCompany 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified richMediaAdsCompany resource name string.

Parameters
Name
Description
networkCode
string
richMediaAdsCompany
string
Returns
Type
Description
string

{string} Resource name string.

rolePath(networkCode, role)

  rolePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 role 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified role resource name string.

Parameters
Name
Description
networkCode
string
role
string
Returns
Type
Description
string

{string} Resource name string.

sitePath(networkCode, site)

  sitePath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 site 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified site resource name string.

Parameters
Name
Description
networkCode
string
site
string
Returns
Type
Description
string

{string} Resource name string.

taxonomyCategoryPath(networkCode, taxonomyCategory)

  taxonomyCategoryPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 taxonomyCategory 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified taxonomyCategory resource name string.

Parameters
Name
Description
networkCode
string
taxonomyCategory
string
Returns
Type
Description
string

{string} Resource name string.

teamPath(networkCode, team)

  teamPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 team 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified team resource name string.

Parameters
Name
Description
networkCode
string
team
string
Returns
Type
Description
string

{string} Resource name string.

userPath(networkCode, user)

  userPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 user 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified user resource name string.

Parameters
Name
Description
networkCode
string
user
string
Returns
Type
Description
string

{string} Resource name string.

webPropertyPath(networkCode, webProperty)

  webPropertyPath 
 ( 
 networkCode 
 : 
  
 string 
 , 
  
 webProperty 
 : 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Return a fully-qualified webProperty resource name string.

Parameters
Name
Description
networkCode
string
webProperty
string
Returns
Type
Description
string

{string} Resource name string.

Create a Mobile Website
View Site in Mobile | Classic
Share by: