Provides methods for handling AdUnit objects. v1
Package
@google-ads/admanagerConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of AdUnitServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
adUnitServiceStub
adUnitServiceStub?: Promise<{
[name: string]: Function;
}>;
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.
scopes
static get scopes(): never[];
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
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. |
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. |
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. |
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, customTargetingKey, customTargetingValue)
customTargetingValuePath(networkCode: string, customTargetingKey: string, customTargetingValue: string): string;
Return a fully-qualified customTargetingValue resource name string.
Parameters | |
---|---|
Name | Description |
networkCode |
string
|
customTargetingKey |
string
|
customTargetingValue |
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. |
getAdUnit(request, options)
getAdUnit(request?: protos.google.ads.admanager.v1.IGetAdUnitRequest, options?: CallOptions): Promise<[
protos.google.ads.admanager.v1.IAdUnit,
protos.google.ads.admanager.v1.IGetAdUnitRequest | undefined,
{} | undefined
]>;
API to retrieve an AdUnit object.
Parameters | |
---|---|
Name | Description |
request |
IGetAdUnitRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.ads.admanager.v1.IAdUnit,
protos.google.ads.admanager.v1.IGetAdUnitRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AdUnit. 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 AdUnit.
* Format: `networks/{network_code}/adUnits/{ad_unit_id}`
*/
// const name = 'abc123'
// Imports the Admanager library
const {AdUnitServiceClient} = require('@google-ads/admanager').v1;
// Instantiates a client
const admanagerClient = new AdUnitServiceClient();
async function callGetAdUnit() {
// Construct request
const request = {
name,
};
// Run request
const response = await admanagerClient.getAdUnit(request);
console.log(response);
}
callGetAdUnit();
getAdUnit(request, options, callback)
getAdUnit(request: protos.google.ads.admanager.v1.IGetAdUnitRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IAdUnit, protos.google.ads.admanager.v1.IGetAdUnitRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAdUnitRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.ads.admanager.v1.IAdUnit, protos.google.ads.admanager.v1.IGetAdUnitRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAdUnit(request, callback)
getAdUnit(request: protos.google.ads.admanager.v1.IGetAdUnitRequest, callback: Callback<protos.google.ads.admanager.v1.IAdUnit, protos.google.ads.admanager.v1.IGetAdUnitRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAdUnitRequest
|
callback |
Callback<protos.google.ads.admanager.v1.IAdUnit, protos.google.ads.admanager.v1.IGetAdUnitRequest | 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. |
listAdUnits(request, options)
listAdUnits(request?: protos.google.ads.admanager.v1.IListAdUnitsRequest, options?: CallOptions): Promise<[
protos.google.ads.admanager.v1.IAdUnit[],
protos.google.ads.admanager.v1.IListAdUnitsRequest | null,
protos.google.ads.admanager.v1.IListAdUnitsResponse
]>;
API to retrieve a list of AdUnit objects.
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.ads.admanager.v1.IAdUnit[],
protos.google.ads.admanager.v1.IListAdUnitsRequest | null,
protos.google.ads.admanager.v1.IListAdUnitsResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of AdUnit. 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 |
listAdUnits(request, options, callback)
listAdUnits(request: protos.google.ads.admanager.v1.IListAdUnitsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitsRequest, protos.google.ads.admanager.v1.IListAdUnitsResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnit>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitsRequest, protos.google.ads.admanager.v1.IListAdUnitsResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnit>
|
Returns | |
---|---|
Type | Description |
void |
listAdUnits(request, callback)
listAdUnits(request: protos.google.ads.admanager.v1.IListAdUnitsRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitsRequest, protos.google.ads.admanager.v1.IListAdUnitsResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnit>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitsRequest
|
callback |
PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitsRequest, protos.google.ads.admanager.v1.IListAdUnitsResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnit>
|
Returns | |
---|---|
Type | Description |
void |
listAdUnitsAsync(request, options)
listAdUnitsAsync(request?: protos.google.ads.admanager.v1.IListAdUnitsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdUnit>;
Equivalent to listAdUnits
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.ads.admanager.v1.IAdUnit> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AdUnit. 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 AdUnits.
* Format: `networks/{network_code}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of AdUnits to return. The service may return
* fewer than this value. If unspecified, at most 50 ad units will be
* returned. The maximum value is 1000; values above 1000 will be coerced to
* 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListAdUnits` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAdUnits` 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
*/
// 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 {AdUnitServiceClient} = require('@google-ads/admanager').v1;
// Instantiates a client
const admanagerClient = new AdUnitServiceClient();
async function callListAdUnits() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = admanagerClient.listAdUnitsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAdUnits();
listAdUnitSizes(request, options)
listAdUnitSizes(request?: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, options?: CallOptions): Promise<[
protos.google.ads.admanager.v1.IAdUnitSize[],
protos.google.ads.admanager.v1.IListAdUnitSizesRequest | null,
protos.google.ads.admanager.v1.IListAdUnitSizesResponse
]>;
API to retrieve a list of AdUnitSize objects.
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitSizesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.ads.admanager.v1.IAdUnitSize[],
protos.google.ads.admanager.v1.IListAdUnitSizesRequest | null,
protos.google.ads.admanager.v1.IListAdUnitSizesResponse
]> |
{Promise} - The promise which resolves to an array. The first element of the array is Array of AdUnitSize. 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 |
listAdUnitSizes(request, options, callback)
listAdUnitSizes(request: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitSizesRequest, protos.google.ads.admanager.v1.IListAdUnitSizesResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnitSize>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitSizesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitSizesRequest, protos.google.ads.admanager.v1.IListAdUnitSizesResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnitSize>
|
Returns | |
---|---|
Type | Description |
void |
listAdUnitSizes(request, callback)
listAdUnitSizes(request: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitSizesRequest, protos.google.ads.admanager.v1.IListAdUnitSizesResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnitSize>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitSizesRequest
|
callback |
PaginationCallback<protos.google.ads.admanager.v1.IListAdUnitSizesRequest, protos.google.ads.admanager.v1.IListAdUnitSizesResponse | null | undefined, protos.google.ads.admanager.v1.IAdUnitSize>
|
Returns | |
---|---|
Type | Description |
void |
listAdUnitSizesAsync(request, options)
listAdUnitSizesAsync(request?: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.IAdUnitSize>;
Equivalent to listAdUnitSizes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitSizesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.ads.admanager.v1.IAdUnitSize> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing AdUnitSize. 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 AdUnitSizes.
* Format: `networks/{network_code}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of AdUnitSizes to return. The service may
* return fewer than this value. If unspecified, at most 50 ad unit sizes will
* be returned. The maximum value is 1000; values above 1000 will be coerced
* to 1000.
*/
// const pageSize = 1234
/**
* Optional. A page token, received from a previous `ListAdUnitSizes` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListAdUnitSizes` 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
*/
// 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 {AdUnitServiceClient} = require('@google-ads/admanager').v1;
// Instantiates a client
const admanagerClient = new AdUnitServiceClient();
async function callListAdUnitSizes() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = admanagerClient.listAdUnitSizesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAdUnitSizes();
listAdUnitSizesStream(request, options)
listAdUnitSizesStream(request?: protos.google.ads.admanager.v1.IListAdUnitSizesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitSizesRequest
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 AdUnitSize 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 |
listAdUnitsStream(request, options)
listAdUnitsStream(request?: protos.google.ads.admanager.v1.IListAdUnitsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListAdUnitsRequest
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 AdUnit 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 |
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. |
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. |
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. |
matchCustomTargetingKeyFromCustomTargetingValueName(customTargetingValueName)
matchCustomTargetingKeyFromCustomTargetingValueName(customTargetingValueName: string): string | number;
Parse the custom_targeting_key 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_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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |