Provides methods for handling Role
objects. v1
Package
@google-ads/admanagerConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of RoleServiceClient.
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 RoleServiceClient({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
;
};
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
roleServiceStub
roleServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
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.
networkCode
string
assetKey
string
adBreak
string
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.
networkCode
string
webPropertyCode
string
adReviewCenterAd
string
string
{string} Resource name string.
adUnitPath(networkCode, adUnit)
adUnitPath
(
networkCode
:
string
,
adUnit
:
string
)
:
string
;
Return a fully-qualified adUnit resource name string.
networkCode
string
adUnit
string
string
{string} Resource name string.
applicationPath(networkCode, application)
applicationPath
(
networkCode
:
string
,
application
:
string
)
:
string
;
Return a fully-qualified application resource name string.
networkCode
string
application
string
string
{string} Resource name string.
audienceSegmentPath(networkCode, audienceSegment)
audienceSegmentPath
(
networkCode
:
string
,
audienceSegment
:
string
)
:
string
;
Return a fully-qualified audienceSegment resource name string.
networkCode
string
audienceSegment
string
string
{string} Resource name string.
bandwidthGroupPath(networkCode, bandwidthGroup)
bandwidthGroupPath
(
networkCode
:
string
,
bandwidthGroup
:
string
)
:
string
;
Return a fully-qualified bandwidthGroup resource name string.
networkCode
string
bandwidthGroup
string
string
{string} Resource name string.
browserLanguagePath(networkCode, browserLanguage)
browserLanguagePath
(
networkCode
:
string
,
browserLanguage
:
string
)
:
string
;
Return a fully-qualified browserLanguage resource name string.
networkCode
string
browserLanguage
string
string
{string} Resource name string.
browserPath(networkCode, browser)
browserPath
(
networkCode
:
string
,
browser
:
string
)
:
string
;
Return a fully-qualified browser resource name string.
networkCode
string
browser
string
string
{string} Resource name string.
childPublisherPath(networkCode, childPublisher)
childPublisherPath
(
networkCode
:
string
,
childPublisher
:
string
)
:
string
;
Return a fully-qualified childPublisher resource name string.
networkCode
string
childPublisher
string
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.
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.
networkCode
string
cmsMetadataKey
string
string
{string} Resource name string.
cmsMetadataValuePath(networkCode, cmsMetadataValue)
cmsMetadataValuePath
(
networkCode
:
string
,
cmsMetadataValue
:
string
)
:
string
;
Return a fully-qualified cmsMetadataValue resource name string.
networkCode
string
cmsMetadataValue
string
string
{string} Resource name string.
companyPath(networkCode, company)
companyPath
(
networkCode
:
string
,
company
:
string
)
:
string
;
Return a fully-qualified company resource name string.
networkCode
string
company
string
string
{string} Resource name string.
contactPath(networkCode, contact)
contactPath
(
networkCode
:
string
,
contact
:
string
)
:
string
;
Return a fully-qualified contact resource name string.
networkCode
string
contact
string
string
{string} Resource name string.
contentBundlePath(networkCode, contentBundle)
contentBundlePath
(
networkCode
:
string
,
contentBundle
:
string
)
:
string
;
Return a fully-qualified contentBundle resource name string.
networkCode
string
contentBundle
string
string
{string} Resource name string.
contentLabelPath(networkCode, contentLabel)
contentLabelPath
(
networkCode
:
string
,
contentLabel
:
string
)
:
string
;
Return a fully-qualified contentLabel resource name string.
networkCode
string
contentLabel
string
string
{string} Resource name string.
contentPath(networkCode, content)
contentPath
(
networkCode
:
string
,
content
:
string
)
:
string
;
Return a fully-qualified content resource name string.
networkCode
string
content
string
string
{string} Resource name string.
creativeTemplatePath(networkCode, creativeTemplate)
creativeTemplatePath
(
networkCode
:
string
,
creativeTemplate
:
string
)
:
string
;
Return a fully-qualified creativeTemplate resource name string.
networkCode
string
creativeTemplate
string
string
{string} Resource name string.
customFieldPath(networkCode, customField)
customFieldPath
(
networkCode
:
string
,
customField
:
string
)
:
string
;
Return a fully-qualified customField resource name string.
networkCode
string
customField
string
string
{string} Resource name string.
customTargetingKeyPath(networkCode, customTargetingKey)
customTargetingKeyPath
(
networkCode
:
string
,
customTargetingKey
:
string
)
:
string
;
Return a fully-qualified customTargetingKey resource name string.
networkCode
string
customTargetingKey
string
string
{string} Resource name string.
customTargetingValuePath(networkCode, customTargetingValue)
customTargetingValuePath
(
networkCode
:
string
,
customTargetingValue
:
string
)
:
string
;
Return a fully-qualified customTargetingValue resource name string.
networkCode
string
customTargetingValue
string
string
{string} Resource name string.
deviceCapabilityPath(networkCode, deviceCapability)
deviceCapabilityPath
(
networkCode
:
string
,
deviceCapability
:
string
)
:
string
;
Return a fully-qualified deviceCapability resource name string.
networkCode
string
deviceCapability
string
string
{string} Resource name string.
deviceCategoryPath(networkCode, deviceCategory)
deviceCategoryPath
(
networkCode
:
string
,
deviceCategory
:
string
)
:
string
;
Return a fully-qualified deviceCategory resource name string.
networkCode
string
deviceCategory
string
string
{string} Resource name string.
deviceManufacturerPath(networkCode, deviceManufacturer)
deviceManufacturerPath
(
networkCode
:
string
,
deviceManufacturer
:
string
)
:
string
;
Return a fully-qualified deviceManufacturer resource name string.
networkCode
string
deviceManufacturer
string
string
{string} Resource name string.
entitySignalsMappingPath(networkCode, entitySignalsMapping)
entitySignalsMappingPath
(
networkCode
:
string
,
entitySignalsMapping
:
string
)
:
string
;
Return a fully-qualified entitySignalsMapping resource name string.
networkCode
string
entitySignalsMapping
string
string
{string} Resource name string.
geoTargetPath(networkCode, geoTarget)
geoTargetPath
(
networkCode
:
string
,
geoTarget
:
string
)
:
string
;
Return a fully-qualified geoTarget resource name string.
networkCode
string
geoTarget
string
string
{string} Resource name string.
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getRole(request, options)
getRole
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IGetRoleRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
ads
.
admanager
.
v1
.
IRole
,
protos
.
google
.
ads
.
admanager
.
v1
.
IGetRoleRequest
|
undefined
,
{}
|
undefined
]>;
API to retrieve a Role
object.
request
options
Promise
<[ protos.google.ads.admanager.v1.IRole
, protos.google.ads.admanager.v1.IGetRoleRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Role . Please see the documentation for more details and examples.
/**
* 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. The resource name of the Role.
* Format: `networks/{network_code}/roles/{role_id}`
*/
// const name = 'abc123'
// Imports the Admanager library
const
{
RoleServiceClient
}
=
require
(
' @google-ads/admanager
'
).
v1
;
// Instantiates a client
const
admanagerClient
=
new
RoleServiceClient
();
async
function
callGetRole
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
admanagerClient
.
getRole
(
request
);
console
.
log
(
response
);
}
callGetRole
();
getRole(request, options, callback)
getRole
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IGetRoleRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
ads
.
admanager
.
v1
.
IRole
,
protos
.
google
.
ads
.
admanager
.
v1
.
IGetRoleRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.ads.admanager.v1.IRole
, protos.google.ads.admanager.v1.IGetRoleRequest
| null | undefined, {} | null | undefined>
void
getRole(request, callback)
getRole
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IGetRoleRequest
,
callback
:
Callback<protos
.
google
.
ads
.
admanager
.
v1
.
IRole
,
protos
.
google
.
ads
.
admanager
.
v1
.
IGetRoleRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.ads.admanager.v1.IRole
, protos.google.ads.admanager.v1.IGetRoleRequest
| null | undefined, {} | null | undefined>
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.
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.
networkCode
string
label
string
string
{string} Resource name string.
lineItemPath(networkCode, lineItem)
lineItemPath
(
networkCode
:
string
,
lineItem
:
string
)
:
string
;
Return a fully-qualified lineItem resource name string.
networkCode
string
lineItem
string
string
{string} Resource name string.
linkedDevicePath(networkCode, linkedDevice)
linkedDevicePath
(
networkCode
:
string
,
linkedDevice
:
string
)
:
string
;
Return a fully-qualified linkedDevice resource name string.
networkCode
string
linkedDevice
string
string
{string} Resource name string.
listRoles(request, options)
listRoles
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
ads
.
admanager
.
v1
.
IRole
[],
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
|
null
,
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesResponse
]>;
API to retrieve a list of Role
objects.
request
options
Promise
<[ protos.google.ads.admanager.v1.IRole
[], protos.google.ads.admanager.v1.IListRolesRequest
| null, protos.google.ads.admanager.v1.IListRolesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Role
. 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 listRolesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listRoles(request, options, callback)
listRoles
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesResponse
|
null
|
undefined
,
protos
.
google
.
ads
.
admanager
.
v1
.
IRole
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.ads.admanager.v1.IListRolesRequest
, protos.google.ads.admanager.v1.IListRolesResponse
| null | undefined, protos.google.ads.admanager.v1.IRole
>
void
listRoles(request, callback)
listRoles
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
callback
:
PaginationCallback<protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesResponse
|
null
|
undefined
,
protos
.
google
.
ads
.
admanager
.
v1
.
IRole
> )
:
void
;
request
callback
PaginationCallback
< protos.google.ads.admanager.v1.IListRolesRequest
, protos.google.ads.admanager.v1.IListRolesResponse
| null | undefined, protos.google.ads.admanager.v1.IRole
>
void
listRolesAsync(request, options)
listRolesAsync
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
ads
.
admanager
.
v1
.
IRole
> ;
Equivalent to listRoles
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.ads.admanager.v1.IRole
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Role . 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.
/** * 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. The parent, which owns this collection of Roles. * Format: `networks/{network_code}` */ // const parent = 'abc123' /** * Optional. The maximum number of `Roles` to return. The service may return * fewer than this value. If unspecified, at most 50 `Roles` 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 `ListRoles` call. * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListRoles` must match * the call that provided the page token. */ // const pageToken = 'abc123' /** * Optional. Expression to filter the response. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters * Filterable fields: ***
builtIn* description* displayName* name* */ // const filter = 'abc123' /** * Optional. Expression to specify sorting order. * See syntax details at * https://developers.google.com/ad-manager/api/beta/filters#order */ // const orderBy = 'abc123' /** * Optional. Number of individual resources to skip while paginating. */ // const skip = 1234 // Imports the Admanager library const { RoleServiceClient } = require ( ' @google-ads/admanager ' ). v1 ; // Instantiates a client const admanagerClient = new RoleServiceClient (); async function callListRoles () { // Construct request const request = { parent , }; // Run request const iterable = admanagerClient . listRolesAsync ( request ); for await ( const response of iterable ) { console . log ( response ); } } callListRoles (); status
listRolesStream(request, options)
listRolesStream
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IListRolesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listRoles
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Role
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 listRolesAsync()
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.
networkCode
string
liveStreamEvent
string
string
{string} Resource name string.
matchAdBreakFromAdBreakName(adBreakName)
matchAdBreakFromAdBreakName
(
adBreakName
:
string
)
:
string
|
number
;
Parse the ad_break from AdBreak resource.
adBreakName
string
A fully-qualified path representing AdBreak resource.
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.
adReviewCenterAdName
string
A fully-qualified path representing AdReviewCenterAd resource.
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.
adUnitName
string
A fully-qualified path representing AdUnit resource.
string | number
{string} A string representing the ad_unit.
matchApplicationFromApplicationName(applicationName)
matchApplicationFromApplicationName
(
applicationName
:
string
)
:
string
|
number
;
Parse the application from Application resource.
applicationName
string
A fully-qualified path representing Application resource.
string | number
{string} A string representing the application.
matchAssetKeyFromAdBreakName(adBreakName)
matchAssetKeyFromAdBreakName
(
adBreakName
:
string
)
:
string
|
number
;
Parse the asset_key from AdBreak resource.
adBreakName
string
A fully-qualified path representing AdBreak resource.
string | number
{string} A string representing the asset_key.
matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName)
matchAudienceSegmentFromAudienceSegmentName
(
audienceSegmentName
:
string
)
:
string
|
number
;
Parse the audience_segment from AudienceSegment resource.
audienceSegmentName
string
A fully-qualified path representing AudienceSegment resource.
string | number
{string} A string representing the audience_segment.
matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName)
matchBandwidthGroupFromBandwidthGroupName
(
bandwidthGroupName
:
string
)
:
string
|
number
;
Parse the bandwidth_group from BandwidthGroup resource.
bandwidthGroupName
string
A fully-qualified path representing BandwidthGroup resource.
string | number
{string} A string representing the bandwidth_group.
matchBrowserFromBrowserName(browserName)
matchBrowserFromBrowserName
(
browserName
:
string
)
:
string
|
number
;
Parse the browser from Browser resource.
browserName
string
A fully-qualified path representing Browser resource.
string | number
{string} A string representing the browser.
matchBrowserLanguageFromBrowserLanguageName(browserLanguageName)
matchBrowserLanguageFromBrowserLanguageName
(
browserLanguageName
:
string
)
:
string
|
number
;
Parse the browser_language from BrowserLanguage resource.
browserLanguageName
string
A fully-qualified path representing BrowserLanguage resource.
string | number
{string} A string representing the browser_language.
matchChildPublisherFromChildPublisherName(childPublisherName)
matchChildPublisherFromChildPublisherName
(
childPublisherName
:
string
)
:
string
|
number
;
Parse the child_publisher from ChildPublisher resource.
childPublisherName
string
A fully-qualified path representing ChildPublisher resource.
string | number
{string} A string representing the child_publisher.
matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName)
matchCmsMetadataKeyFromCmsMetadataKeyName
(
cmsMetadataKeyName
:
string
)
:
string
|
number
;
Parse the cms_metadata_key from CmsMetadataKey resource.
cmsMetadataKeyName
string
A fully-qualified path representing CmsMetadataKey resource.
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.
cmsMetadataValueName
string
A fully-qualified path representing CmsMetadataValue resource.
string | number
{string} A string representing the cms_metadata_value.
matchCompanyFromCompanyName(companyName)
matchCompanyFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the company from Company resource.
companyName
string
A fully-qualified path representing Company resource.
string | number
{string} A string representing the company.
matchContactFromContactName(contactName)
matchContactFromContactName
(
contactName
:
string
)
:
string
|
number
;
Parse the contact from Contact resource.
contactName
string
A fully-qualified path representing Contact resource.
string | number
{string} A string representing the contact.
matchContentBundleFromContentBundleName(contentBundleName)
matchContentBundleFromContentBundleName
(
contentBundleName
:
string
)
:
string
|
number
;
Parse the content_bundle from ContentBundle resource.
contentBundleName
string
A fully-qualified path representing ContentBundle resource.
string | number
{string} A string representing the content_bundle.
matchContentFromContentName(contentName)
matchContentFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the content from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the content.
matchContentLabelFromContentLabelName(contentLabelName)
matchContentLabelFromContentLabelName
(
contentLabelName
:
string
)
:
string
|
number
;
Parse the content_label from ContentLabel resource.
contentLabelName
string
A fully-qualified path representing ContentLabel resource.
string | number
{string} A string representing the content_label.
matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName)
matchCreativeTemplateFromCreativeTemplateName
(
creativeTemplateName
:
string
)
:
string
|
number
;
Parse the creative_template from CreativeTemplate resource.
creativeTemplateName
string
A fully-qualified path representing CreativeTemplate resource.
string | number
{string} A string representing the creative_template.
matchCustomFieldFromCustomFieldName(customFieldName)
matchCustomFieldFromCustomFieldName
(
customFieldName
:
string
)
:
string
|
number
;
Parse the custom_field from CustomField resource.
customFieldName
string
A fully-qualified path representing CustomField resource.
string | number
{string} A string representing the custom_field.
matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName)
matchCustomTargetingKeyFromCustomTargetingKeyName
(
customTargetingKeyName
:
string
)
:
string
|
number
;
Parse the custom_targeting_key from CustomTargetingKey resource.
customTargetingKeyName
string
A fully-qualified path representing CustomTargetingKey resource.
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.
customTargetingValueName
string
A fully-qualified path representing CustomTargetingValue resource.
string | number
{string} A string representing the custom_targeting_value.
matchDeviceCapabilityFromDeviceCapabilityName(deviceCapabilityName)
matchDeviceCapabilityFromDeviceCapabilityName
(
deviceCapabilityName
:
string
)
:
string
|
number
;
Parse the device_capability from DeviceCapability resource.
deviceCapabilityName
string
A fully-qualified path representing DeviceCapability resource.
string | number
{string} A string representing the device_capability.
matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName)
matchDeviceCategoryFromDeviceCategoryName
(
deviceCategoryName
:
string
)
:
string
|
number
;
Parse the device_category from DeviceCategory resource.
deviceCategoryName
string
A fully-qualified path representing DeviceCategory resource.
string | number
{string} A string representing the device_category.
matchDeviceManufacturerFromDeviceManufacturerName(deviceManufacturerName)
matchDeviceManufacturerFromDeviceManufacturerName
(
deviceManufacturerName
:
string
)
:
string
|
number
;
Parse the device_manufacturer from DeviceManufacturer resource.
deviceManufacturerName
string
A fully-qualified path representing DeviceManufacturer resource.
string | number
{string} A string representing the device_manufacturer.
matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName)
matchEntitySignalsMappingFromEntitySignalsMappingName
(
entitySignalsMappingName
:
string
)
:
string
|
number
;
Parse the entity_signals_mapping from EntitySignalsMapping resource.
entitySignalsMappingName
string
A fully-qualified path representing EntitySignalsMapping resource.
string | number
{string} A string representing the entity_signals_mapping.
matchGeoTargetFromGeoTargetName(geoTargetName)
matchGeoTargetFromGeoTargetName
(
geoTargetName
:
string
)
:
string
|
number
;
Parse the geo_target from GeoTarget resource.
geoTargetName
string
A fully-qualified path representing GeoTarget resource.
string | number
{string} A string representing the geo_target.
matchLabelFromLabelName(labelName)
matchLabelFromLabelName
(
labelName
:
string
)
:
string
|
number
;
Parse the label from Label resource.
labelName
string
A fully-qualified path representing Label resource.
string | number
{string} A string representing the label.
matchLineItemFromLineItemName(lineItemName)
matchLineItemFromLineItemName
(
lineItemName
:
string
)
:
string
|
number
;
Parse the line_item from LineItem resource.
lineItemName
string
A fully-qualified path representing LineItem resource.
string | number
{string} A string representing the line_item.
matchLinkedDeviceFromLinkedDeviceName(linkedDeviceName)
matchLinkedDeviceFromLinkedDeviceName
(
linkedDeviceName
:
string
)
:
string
|
number
;
Parse the linked_device from LinkedDevice resource.
linkedDeviceName
string
A fully-qualified path representing LinkedDevice resource.
string | number
{string} A string representing the linked_device.
matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName)
matchLiveStreamEventFromLiveStreamEventName
(
liveStreamEventName
:
string
)
:
string
|
number
;
Parse the live_stream_event from LiveStreamEvent resource.
liveStreamEventName
string
A fully-qualified path representing LiveStreamEvent resource.
string | number
{string} A string representing the live_stream_event.
matchMobileCarrierFromMobileCarrierName(mobileCarrierName)
matchMobileCarrierFromMobileCarrierName
(
mobileCarrierName
:
string
)
:
string
|
number
;
Parse the mobile_carrier from MobileCarrier resource.
mobileCarrierName
string
A fully-qualified path representing MobileCarrier resource.
string | number
{string} A string representing the mobile_carrier.
matchMobileDeviceFromMobileDeviceName(mobileDeviceName)
matchMobileDeviceFromMobileDeviceName
(
mobileDeviceName
:
string
)
:
string
|
number
;
Parse the mobile_device from MobileDevice resource.
mobileDeviceName
string
A fully-qualified path representing MobileDevice resource.
string | number
{string} A string representing the mobile_device.
matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName)
matchMobileDeviceSubmodelFromMobileDeviceSubmodelName
(
mobileDeviceSubmodelName
:
string
)
:
string
|
number
;
Parse the mobile_device_submodel from MobileDeviceSubmodel resource.
mobileDeviceSubmodelName
string
A fully-qualified path representing MobileDeviceSubmodel resource.
string | number
{string} A string representing the mobile_device_submodel.
matchNetworkCodeFromAdBreakName(adBreakName)
matchNetworkCodeFromAdBreakName
(
adBreakName
:
string
)
:
string
|
number
;
Parse the network_code from AdBreak resource.
adBreakName
string
A fully-qualified path representing AdBreak resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName)
matchNetworkCodeFromAdReviewCenterAdName
(
adReviewCenterAdName
:
string
)
:
string
|
number
;
Parse the network_code from AdReviewCenterAd resource.
adReviewCenterAdName
string
A fully-qualified path representing AdReviewCenterAd resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromAdUnitName(adUnitName)
matchNetworkCodeFromAdUnitName
(
adUnitName
:
string
)
:
string
|
number
;
Parse the network_code from AdUnit resource.
adUnitName
string
A fully-qualified path representing AdUnit resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromApplicationName(applicationName)
matchNetworkCodeFromApplicationName
(
applicationName
:
string
)
:
string
|
number
;
Parse the network_code from Application resource.
applicationName
string
A fully-qualified path representing Application resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromAudienceSegmentName(audienceSegmentName)
matchNetworkCodeFromAudienceSegmentName
(
audienceSegmentName
:
string
)
:
string
|
number
;
Parse the network_code from AudienceSegment resource.
audienceSegmentName
string
A fully-qualified path representing AudienceSegment resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName)
matchNetworkCodeFromBandwidthGroupName
(
bandwidthGroupName
:
string
)
:
string
|
number
;
Parse the network_code from BandwidthGroup resource.
bandwidthGroupName
string
A fully-qualified path representing BandwidthGroup resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromBrowserLanguageName(browserLanguageName)
matchNetworkCodeFromBrowserLanguageName
(
browserLanguageName
:
string
)
:
string
|
number
;
Parse the network_code from BrowserLanguage resource.
browserLanguageName
string
A fully-qualified path representing BrowserLanguage resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromBrowserName(browserName)
matchNetworkCodeFromBrowserName
(
browserName
:
string
)
:
string
|
number
;
Parse the network_code from Browser resource.
browserName
string
A fully-qualified path representing Browser resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromChildPublisherName(childPublisherName)
matchNetworkCodeFromChildPublisherName
(
childPublisherName
:
string
)
:
string
|
number
;
Parse the network_code from ChildPublisher resource.
childPublisherName
string
A fully-qualified path representing ChildPublisher resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName)
matchNetworkCodeFromCmsMetadataKeyName
(
cmsMetadataKeyName
:
string
)
:
string
|
number
;
Parse the network_code from CmsMetadataKey resource.
cmsMetadataKeyName
string
A fully-qualified path representing CmsMetadataKey resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName)
matchNetworkCodeFromCmsMetadataValueName
(
cmsMetadataValueName
:
string
)
:
string
|
number
;
Parse the network_code from CmsMetadataValue resource.
cmsMetadataValueName
string
A fully-qualified path representing CmsMetadataValue resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCompanyName(companyName)
matchNetworkCodeFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the network_code from Company resource.
companyName
string
A fully-qualified path representing Company resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromContactName(contactName)
matchNetworkCodeFromContactName
(
contactName
:
string
)
:
string
|
number
;
Parse the network_code from Contact resource.
contactName
string
A fully-qualified path representing Contact resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromContentBundleName(contentBundleName)
matchNetworkCodeFromContentBundleName
(
contentBundleName
:
string
)
:
string
|
number
;
Parse the network_code from ContentBundle resource.
contentBundleName
string
A fully-qualified path representing ContentBundle resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromContentLabelName(contentLabelName)
matchNetworkCodeFromContentLabelName
(
contentLabelName
:
string
)
:
string
|
number
;
Parse the network_code from ContentLabel resource.
contentLabelName
string
A fully-qualified path representing ContentLabel resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromContentName(contentName)
matchNetworkCodeFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the network_code from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCreativeTemplateName(creativeTemplateName)
matchNetworkCodeFromCreativeTemplateName
(
creativeTemplateName
:
string
)
:
string
|
number
;
Parse the network_code from CreativeTemplate resource.
creativeTemplateName
string
A fully-qualified path representing CreativeTemplate resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCustomFieldName(customFieldName)
matchNetworkCodeFromCustomFieldName
(
customFieldName
:
string
)
:
string
|
number
;
Parse the network_code from CustomField resource.
customFieldName
string
A fully-qualified path representing CustomField resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName)
matchNetworkCodeFromCustomTargetingKeyName
(
customTargetingKeyName
:
string
)
:
string
|
number
;
Parse the network_code from CustomTargetingKey resource.
customTargetingKeyName
string
A fully-qualified path representing CustomTargetingKey resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName)
matchNetworkCodeFromCustomTargetingValueName
(
customTargetingValueName
:
string
)
:
string
|
number
;
Parse the network_code from CustomTargetingValue resource.
customTargetingValueName
string
A fully-qualified path representing CustomTargetingValue resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromDeviceCapabilityName(deviceCapabilityName)
matchNetworkCodeFromDeviceCapabilityName
(
deviceCapabilityName
:
string
)
:
string
|
number
;
Parse the network_code from DeviceCapability resource.
deviceCapabilityName
string
A fully-qualified path representing DeviceCapability resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromDeviceCategoryName(deviceCategoryName)
matchNetworkCodeFromDeviceCategoryName
(
deviceCategoryName
:
string
)
:
string
|
number
;
Parse the network_code from DeviceCategory resource.
deviceCategoryName
string
A fully-qualified path representing DeviceCategory resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromDeviceManufacturerName(deviceManufacturerName)
matchNetworkCodeFromDeviceManufacturerName
(
deviceManufacturerName
:
string
)
:
string
|
number
;
Parse the network_code from DeviceManufacturer resource.
deviceManufacturerName
string
A fully-qualified path representing DeviceManufacturer resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName)
matchNetworkCodeFromEntitySignalsMappingName
(
entitySignalsMappingName
:
string
)
:
string
|
number
;
Parse the network_code from EntitySignalsMapping resource.
entitySignalsMappingName
string
A fully-qualified path representing EntitySignalsMapping resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromGeoTargetName(geoTargetName)
matchNetworkCodeFromGeoTargetName
(
geoTargetName
:
string
)
:
string
|
number
;
Parse the network_code from GeoTarget resource.
geoTargetName
string
A fully-qualified path representing GeoTarget resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromLabelName(labelName)
matchNetworkCodeFromLabelName
(
labelName
:
string
)
:
string
|
number
;
Parse the network_code from Label resource.
labelName
string
A fully-qualified path representing Label resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromLineItemName(lineItemName)
matchNetworkCodeFromLineItemName
(
lineItemName
:
string
)
:
string
|
number
;
Parse the network_code from LineItem resource.
lineItemName
string
A fully-qualified path representing LineItem resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromLinkedDeviceName(linkedDeviceName)
matchNetworkCodeFromLinkedDeviceName
(
linkedDeviceName
:
string
)
:
string
|
number
;
Parse the network_code from LinkedDevice resource.
linkedDeviceName
string
A fully-qualified path representing LinkedDevice resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromLiveStreamEventName(liveStreamEventName)
matchNetworkCodeFromLiveStreamEventName
(
liveStreamEventName
:
string
)
:
string
|
number
;
Parse the network_code from LiveStreamEvent resource.
liveStreamEventName
string
A fully-qualified path representing LiveStreamEvent resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromMobileCarrierName(mobileCarrierName)
matchNetworkCodeFromMobileCarrierName
(
mobileCarrierName
:
string
)
:
string
|
number
;
Parse the network_code from MobileCarrier resource.
mobileCarrierName
string
A fully-qualified path representing MobileCarrier resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromMobileDeviceName(mobileDeviceName)
matchNetworkCodeFromMobileDeviceName
(
mobileDeviceName
:
string
)
:
string
|
number
;
Parse the network_code from MobileDevice resource.
mobileDeviceName
string
A fully-qualified path representing MobileDevice resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromMobileDeviceSubmodelName(mobileDeviceSubmodelName)
matchNetworkCodeFromMobileDeviceSubmodelName
(
mobileDeviceSubmodelName
:
string
)
:
string
|
number
;
Parse the network_code from MobileDeviceSubmodel resource.
mobileDeviceSubmodelName
string
A fully-qualified path representing MobileDeviceSubmodel resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromNetworkName(networkName)
matchNetworkCodeFromNetworkName
(
networkName
:
string
)
:
string
|
number
;
Parse the network_code from Network resource.
networkName
string
A fully-qualified path representing Network resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromOperatingSystemName(operatingSystemName)
matchNetworkCodeFromOperatingSystemName
(
operatingSystemName
:
string
)
:
string
|
number
;
Parse the network_code from OperatingSystem resource.
operatingSystemName
string
A fully-qualified path representing OperatingSystem resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName)
matchNetworkCodeFromOperatingSystemVersionName
(
operatingSystemVersionName
:
string
)
:
string
|
number
;
Parse the network_code from OperatingSystemVersion resource.
operatingSystemVersionName
string
A fully-qualified path representing OperatingSystemVersion resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromOrderName(orderName)
matchNetworkCodeFromOrderName
(
orderName
:
string
)
:
string
|
number
;
Parse the network_code from Order resource.
orderName
string
A fully-qualified path representing Order resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromPlacementName(placementName)
matchNetworkCodeFromPlacementName
(
placementName
:
string
)
:
string
|
number
;
Parse the network_code from Placement resource.
placementName
string
A fully-qualified path representing Placement resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName)
matchNetworkCodeFromPrivateAuctionDealName
(
privateAuctionDealName
:
string
)
:
string
|
number
;
Parse the network_code from PrivateAuctionDeal resource.
privateAuctionDealName
string
A fully-qualified path representing PrivateAuctionDeal resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromPrivateAuctionName(privateAuctionName)
matchNetworkCodeFromPrivateAuctionName
(
privateAuctionName
:
string
)
:
string
|
number
;
Parse the network_code from PrivateAuction resource.
privateAuctionName
string
A fully-qualified path representing PrivateAuction resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName)
matchNetworkCodeFromProgrammaticBuyerName
(
programmaticBuyerName
:
string
)
:
string
|
number
;
Parse the network_code from ProgrammaticBuyer resource.
programmaticBuyerName
string
A fully-qualified path representing ProgrammaticBuyer resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromReportName(reportName)
matchNetworkCodeFromReportName
(
reportName
:
string
)
:
string
|
number
;
Parse the network_code from Report resource.
reportName
string
A fully-qualified path representing Report resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromRichMediaAdsCompanyName(richMediaAdsCompanyName)
matchNetworkCodeFromRichMediaAdsCompanyName
(
richMediaAdsCompanyName
:
string
)
:
string
|
number
;
Parse the network_code from RichMediaAdsCompany resource.
richMediaAdsCompanyName
string
A fully-qualified path representing RichMediaAdsCompany resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromRoleName(roleName)
matchNetworkCodeFromRoleName
(
roleName
:
string
)
:
string
|
number
;
Parse the network_code from Role resource.
roleName
string
A fully-qualified path representing Role resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromSiteName(siteName)
matchNetworkCodeFromSiteName
(
siteName
:
string
)
:
string
|
number
;
Parse the network_code from Site resource.
siteName
string
A fully-qualified path representing Site resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName)
matchNetworkCodeFromTaxonomyCategoryName
(
taxonomyCategoryName
:
string
)
:
string
|
number
;
Parse the network_code from TaxonomyCategory resource.
taxonomyCategoryName
string
A fully-qualified path representing TaxonomyCategory resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromTeamName(teamName)
matchNetworkCodeFromTeamName
(
teamName
:
string
)
:
string
|
number
;
Parse the network_code from Team resource.
teamName
string
A fully-qualified path representing Team resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromUserName(userName)
matchNetworkCodeFromUserName
(
userName
:
string
)
:
string
|
number
;
Parse the network_code from User resource.
userName
string
A fully-qualified path representing User resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromWebPropertyName(webPropertyName)
matchNetworkCodeFromWebPropertyName
(
webPropertyName
:
string
)
:
string
|
number
;
Parse the network_code from WebProperty resource.
webPropertyName
string
A fully-qualified path representing WebProperty resource.
string | number
{string} A string representing the network_code.
matchOperatingSystemFromOperatingSystemName(operatingSystemName)
matchOperatingSystemFromOperatingSystemName
(
operatingSystemName
:
string
)
:
string
|
number
;
Parse the operating_system from OperatingSystem resource.
operatingSystemName
string
A fully-qualified path representing OperatingSystem resource.
string | number
{string} A string representing the operating_system.
matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName)
matchOperatingSystemVersionFromOperatingSystemVersionName
(
operatingSystemVersionName
:
string
)
:
string
|
number
;
Parse the operating_system_version from OperatingSystemVersion resource.
operatingSystemVersionName
string
A fully-qualified path representing OperatingSystemVersion resource.
string | number
{string} A string representing the operating_system_version.
matchOrderFromOrderName(orderName)
matchOrderFromOrderName
(
orderName
:
string
)
:
string
|
number
;
Parse the order from Order resource.
orderName
string
A fully-qualified path representing Order resource.
string | number
{string} A string representing the order.
matchPlacementFromPlacementName(placementName)
matchPlacementFromPlacementName
(
placementName
:
string
)
:
string
|
number
;
Parse the placement from Placement resource.
placementName
string
A fully-qualified path representing Placement resource.
string | number
{string} A string representing the placement.
matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName)
matchPrivateAuctionDealFromPrivateAuctionDealName
(
privateAuctionDealName
:
string
)
:
string
|
number
;
Parse the private_auction_deal from PrivateAuctionDeal resource.
privateAuctionDealName
string
A fully-qualified path representing PrivateAuctionDeal resource.
string | number
{string} A string representing the private_auction_deal.
matchPrivateAuctionFromPrivateAuctionName(privateAuctionName)
matchPrivateAuctionFromPrivateAuctionName
(
privateAuctionName
:
string
)
:
string
|
number
;
Parse the private_auction from PrivateAuction resource.
privateAuctionName
string
A fully-qualified path representing PrivateAuction resource.
string | number
{string} A string representing the private_auction.
matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName)
matchProgrammaticBuyerFromProgrammaticBuyerName
(
programmaticBuyerName
:
string
)
:
string
|
number
;
Parse the programmatic_buyer from ProgrammaticBuyer resource.
programmaticBuyerName
string
A fully-qualified path representing ProgrammaticBuyer resource.
string | number
{string} A string representing the programmatic_buyer.
matchReportFromReportName(reportName)
matchReportFromReportName
(
reportName
:
string
)
:
string
|
number
;
Parse the report from Report resource.
reportName
string
A fully-qualified path representing Report resource.
string | number
{string} A string representing the report.
matchRichMediaAdsCompanyFromRichMediaAdsCompanyName(richMediaAdsCompanyName)
matchRichMediaAdsCompanyFromRichMediaAdsCompanyName
(
richMediaAdsCompanyName
:
string
)
:
string
|
number
;
Parse the rich_media_ads_company from RichMediaAdsCompany resource.
richMediaAdsCompanyName
string
A fully-qualified path representing RichMediaAdsCompany resource.
string | number
{string} A string representing the rich_media_ads_company.
matchRoleFromRoleName(roleName)
matchRoleFromRoleName
(
roleName
:
string
)
:
string
|
number
;
Parse the role from Role resource.
roleName
string
A fully-qualified path representing Role resource.
string | number
{string} A string representing the role.
matchSiteFromSiteName(siteName)
matchSiteFromSiteName
(
siteName
:
string
)
:
string
|
number
;
Parse the site from Site resource.
siteName
string
A fully-qualified path representing Site resource.
string | number
{string} A string representing the site.
matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName)
matchTaxonomyCategoryFromTaxonomyCategoryName
(
taxonomyCategoryName
:
string
)
:
string
|
number
;
Parse the taxonomy_category from TaxonomyCategory resource.
taxonomyCategoryName
string
A fully-qualified path representing TaxonomyCategory resource.
string | number
{string} A string representing the taxonomy_category.
matchTeamFromTeamName(teamName)
matchTeamFromTeamName
(
teamName
:
string
)
:
string
|
number
;
Parse the team from Team resource.
teamName
string
A fully-qualified path representing Team resource.
string | number
{string} A string representing the team.
matchUserFromUserName(userName)
matchUserFromUserName
(
userName
:
string
)
:
string
|
number
;
Parse the user from User resource.
userName
string
A fully-qualified path representing User resource.
string | number
{string} A string representing the user.
matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName)
matchWebPropertyCodeFromAdReviewCenterAdName
(
adReviewCenterAdName
:
string
)
:
string
|
number
;
Parse the web_property_code from AdReviewCenterAd resource.
adReviewCenterAdName
string
A fully-qualified path representing AdReviewCenterAd resource.
string | number
{string} A string representing the web_property_code.
matchWebPropertyFromWebPropertyName(webPropertyName)
matchWebPropertyFromWebPropertyName
(
webPropertyName
:
string
)
:
string
|
number
;
Parse the web_property from WebProperty resource.
webPropertyName
string
A fully-qualified path representing WebProperty resource.
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.
networkCode
string
mobileCarrier
string
string
{string} Resource name string.
mobileDevicePath(networkCode, mobileDevice)
mobileDevicePath
(
networkCode
:
string
,
mobileDevice
:
string
)
:
string
;
Return a fully-qualified mobileDevice resource name string.
networkCode
string
mobileDevice
string
string
{string} Resource name string.
mobileDeviceSubmodelPath(networkCode, mobileDeviceSubmodel)
mobileDeviceSubmodelPath
(
networkCode
:
string
,
mobileDeviceSubmodel
:
string
)
:
string
;
Return a fully-qualified mobileDeviceSubmodel resource name string.
networkCode
string
mobileDeviceSubmodel
string
string
{string} Resource name string.
networkPath(networkCode)
networkPath
(
networkCode
:
string
)
:
string
;
Return a fully-qualified network resource name string.
networkCode
string
string
{string} Resource name string.
operatingSystemPath(networkCode, operatingSystem)
operatingSystemPath
(
networkCode
:
string
,
operatingSystem
:
string
)
:
string
;
Return a fully-qualified operatingSystem resource name string.
networkCode
string
operatingSystem
string
string
{string} Resource name string.
operatingSystemVersionPath(networkCode, operatingSystemVersion)
operatingSystemVersionPath
(
networkCode
:
string
,
operatingSystemVersion
:
string
)
:
string
;
Return a fully-qualified operatingSystemVersion resource name string.
networkCode
string
operatingSystemVersion
string
string
{string} Resource name string.
orderPath(networkCode, order)
orderPath
(
networkCode
:
string
,
order
:
string
)
:
string
;
Return a fully-qualified order resource name string.
networkCode
string
order
string
string
{string} Resource name string.
placementPath(networkCode, placement)
placementPath
(
networkCode
:
string
,
placement
:
string
)
:
string
;
Return a fully-qualified placement resource name string.
networkCode
string
placement
string
string
{string} Resource name string.
privateAuctionDealPath(networkCode, privateAuctionDeal)
privateAuctionDealPath
(
networkCode
:
string
,
privateAuctionDeal
:
string
)
:
string
;
Return a fully-qualified privateAuctionDeal resource name string.
networkCode
string
privateAuctionDeal
string
string
{string} Resource name string.
privateAuctionPath(networkCode, privateAuction)
privateAuctionPath
(
networkCode
:
string
,
privateAuction
:
string
)
:
string
;
Return a fully-qualified privateAuction resource name string.
networkCode
string
privateAuction
string
string
{string} Resource name string.
programmaticBuyerPath(networkCode, programmaticBuyer)
programmaticBuyerPath
(
networkCode
:
string
,
programmaticBuyer
:
string
)
:
string
;
Return a fully-qualified programmaticBuyer resource name string.
networkCode
string
programmaticBuyer
string
string
{string} Resource name string.
reportPath(networkCode, report)
reportPath
(
networkCode
:
string
,
report
:
string
)
:
string
;
Return a fully-qualified report resource name string.
networkCode
string
report
string
string
{string} Resource name string.
richMediaAdsCompanyPath(networkCode, richMediaAdsCompany)
richMediaAdsCompanyPath
(
networkCode
:
string
,
richMediaAdsCompany
:
string
)
:
string
;
Return a fully-qualified richMediaAdsCompany resource name string.
networkCode
string
richMediaAdsCompany
string
string
{string} Resource name string.
rolePath(networkCode, role)
rolePath
(
networkCode
:
string
,
role
:
string
)
:
string
;
Return a fully-qualified role resource name string.
networkCode
string
role
string
string
{string} Resource name string.
sitePath(networkCode, site)
sitePath
(
networkCode
:
string
,
site
:
string
)
:
string
;
Return a fully-qualified site resource name string.
networkCode
string
site
string
string
{string} Resource name string.
taxonomyCategoryPath(networkCode, taxonomyCategory)
taxonomyCategoryPath
(
networkCode
:
string
,
taxonomyCategory
:
string
)
:
string
;
Return a fully-qualified taxonomyCategory resource name string.
networkCode
string
taxonomyCategory
string
string
{string} Resource name string.
teamPath(networkCode, team)
teamPath
(
networkCode
:
string
,
team
:
string
)
:
string
;
Return a fully-qualified team resource name string.
networkCode
string
team
string
string
{string} Resource name string.
userPath(networkCode, user)
userPath
(
networkCode
:
string
,
user
:
string
)
:
string
;
Return a fully-qualified user resource name string.
networkCode
string
user
string
string
{string} Resource name string.
webPropertyPath(networkCode, webProperty)
webPropertyPath
(
networkCode
:
string
,
webProperty
:
string
)
:
string
;
Return a fully-qualified webProperty resource name string.
networkCode
string
webProperty
string
string
{string} Resource name string.
