Class v1.CustomFieldServiceClient (0.1.0)

Provides methods for handling CustomField objects. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of CustomFieldServiceClient.

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 CustomFieldServiceClient({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;

customFieldServiceStub

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

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.

getCustomField(request, options)

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

API to retrieve a CustomField object.

Parameters
Name	Description
`request`	`IGetCustomFieldRequest` 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.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing CustomField. 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. The resource name of the CustomField.
   *  Format: `networks/{network_code}/customFields/{custom_field_id}`
   */
  // const name = 'abc123'

  // Imports the Admanager library
  const {CustomFieldServiceClient} = require('@google-ads/admanager').v1;

  // Instantiates a client
  const admanagerClient = new CustomFieldServiceClient();

  async function callGetCustomField() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await admanagerClient.getCustomField(request);
    console.log(response);
  }

  callGetCustomField();

getCustomField(request, options, callback)

getCustomField(request: protos.google.ads.admanager.v1.IGetCustomFieldRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetCustomFieldRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

getCustomField(request, callback)

getCustomField(request: protos.google.ads.admanager.v1.IGetCustomFieldRequest, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetCustomFieldRequest`
`callback`	`Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest \| 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.

listCustomFields(request, options)

listCustomFields(request?: protos.google.ads.admanager.v1.IListCustomFieldsRequest, options?: CallOptions): Promise<[
        protos.google.ads.admanager.v1.ICustomField[],
        protos.google.ads.admanager.v1.IListCustomFieldsRequest | null,
        protos.google.ads.admanager.v1.IListCustomFieldsResponse
    ]>;

API to retrieve a list of CustomField objects.

Parameters
Name	Description
`request`	`IListCustomFieldsRequest` 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.ICustomField[],
        protos.google.ads.admanager.v1.IListCustomFieldsRequest | null,
        protos.google.ads.admanager.v1.IListCustomFieldsResponse
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of CustomField. 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 listCustomFieldsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listCustomFields(request, options, callback)

listCustomFields(request: protos.google.ads.admanager.v1.IListCustomFieldsRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.admanager.v1.IListCustomFieldsRequest, protos.google.ads.admanager.v1.IListCustomFieldsResponse | null | undefined, protos.google.ads.admanager.v1.ICustomField>): void;

Parameters
Name	Description
`request`	`IListCustomFieldsRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.ads.admanager.v1.IListCustomFieldsRequest, protos.google.ads.admanager.v1.IListCustomFieldsResponse \| null \| undefined, protos.google.ads.admanager.v1.ICustomField>`

Returns
Type	Description
`void`

listCustomFields(request, callback)

listCustomFields(request: protos.google.ads.admanager.v1.IListCustomFieldsRequest, callback: PaginationCallback<protos.google.ads.admanager.v1.IListCustomFieldsRequest, protos.google.ads.admanager.v1.IListCustomFieldsResponse | null | undefined, protos.google.ads.admanager.v1.ICustomField>): void;

Parameters
Name	Description
`request`	`IListCustomFieldsRequest`
`callback`	`PaginationCallback<protos.google.ads.admanager.v1.IListCustomFieldsRequest, protos.google.ads.admanager.v1.IListCustomFieldsResponse \| null \| undefined, protos.google.ads.admanager.v1.ICustomField>`

Returns
Type	Description
`void`

listCustomFieldsAsync(request, options)

listCustomFieldsAsync(request?: protos.google.ads.admanager.v1.IListCustomFieldsRequest, options?: CallOptions): AsyncIterable<protos.google.ads.admanager.v1.ICustomField>;

Equivalent to listCustomFields, but returns an iterable object.

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

Parameters
Name	Description
`request`	`IListCustomFieldsRequest` 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.ICustomField>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing CustomField. 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.
   */
  /**
   *  Required. The parent, which owns this collection of CustomFields.
   *  Format: `networks/{network_code}`
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of `CustomFields` to return. The service may
   *  return fewer than this value. If unspecified, at most 50 `CustomFields`
   *  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 `ListCustomFields` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListCustomFields` 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 {CustomFieldServiceClient} = require('@google-ads/admanager').v1;

  // Instantiates a client
  const admanagerClient = new CustomFieldServiceClient();

  async function callListCustomFields() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = admanagerClient.listCustomFieldsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListCustomFields();

listCustomFieldsStream(request, options)

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

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name	Description
`request`	`IListCustomFieldsRequest` 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 CustomField 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 listCustomFieldsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.