Class v1.UserListDirectLicenseServiceClient (1.0.0)

1.0.0 (latest) 0.5.0 0.4.0 0.3.0 0.1.0

Service for managing user list direct licenses. Delete is not a supported operation for UserListDirectLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.

This feature is only available to data partners. v1

Package

@google-ads/datamanager

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of UserListDirectLicenseServiceClient.

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 UserListDirectLicenseServiceClient({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.

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;

userListDirectLicenseServiceStub

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

warn

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

Methods

accountPath(accountType, account)

accountPath(accountType: string, account: string): string;

Return a fully-qualified account resource name string.

Parameters
Name	Description
accountType	string
account	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.

createUserListDirectLicense(request, options)

createUserListDirectLicense(request?: protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest, options?: CallOptions): Promise<[
        protos.google.ads.datamanager.v1.IUserListDirectLicense,
        (protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest | undefined),
        {} | undefined
    ]>;

Creates a user list direct license.

This feature is only available to data partners.

Parameters
Name	Description
request	ICreateUserListDirectLicenseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.ads.datamanager.v1.IUserListDirectLicense, (protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserListDirectLicense. 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 account that owns the user list being licensed. Should be in
   *  the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
   */
  // const parent = 'abc123'
  /**
   *  Required. The user list direct license to create.
   */
  // const userListDirectLicense = {}

  // Imports the Datamanager library
  const {UserListDirectLicenseServiceClient} = require('@google-ads/datamanager').v1;

  // Instantiates a client
  const datamanagerClient = new UserListDirectLicenseServiceClient();

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

    // Run request
    const response = await datamanagerClient.createUserListDirectLicense(request);
    console.log(response);
  }

  callCreateUserListDirectLicense();

createUserListDirectLicense(request, options, callback)

createUserListDirectLicense(request: protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest, options: CallOptions, callback: Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateUserListDirectLicenseRequest
options	CallOptions
callback	Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createUserListDirectLicense(request, callback)

createUserListDirectLicense(request: protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest, callback: Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateUserListDirectLicenseRequest
callback	Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.ICreateUserListDirectLicenseRequest | 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

getUserListDirectLicense(request, options)

getUserListDirectLicense(request?: protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest, options?: CallOptions): Promise<[
        protos.google.ads.datamanager.v1.IUserListDirectLicense,
        (protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest | undefined),
        {} | undefined
    ]>;

Retrieves a user list direct license.

This feature is only available to data partners.

Parameters
Name	Description
request	IGetUserListDirectLicenseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.ads.datamanager.v1.IUserListDirectLicense, (protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserListDirectLicense. 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 user list direct license.
   */
  // const name = 'abc123'

  // Imports the Datamanager library
  const {UserListDirectLicenseServiceClient} = require('@google-ads/datamanager').v1;

  // Instantiates a client
  const datamanagerClient = new UserListDirectLicenseServiceClient();

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

    // Run request
    const response = await datamanagerClient.getUserListDirectLicense(request);
    console.log(response);
  }

  callGetUserListDirectLicense();

getUserListDirectLicense(request, options, callback)

getUserListDirectLicense(request: protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest, options: CallOptions, callback: Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetUserListDirectLicenseRequest
options	CallOptions
callback	Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getUserListDirectLicense(request, callback)

getUserListDirectLicense(request: protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest, callback: Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetUserListDirectLicenseRequest
callback	Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IGetUserListDirectLicenseRequest | null | undefined, {} | null | 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.

listUserListDirectLicenses(request, options)

listUserListDirectLicenses(request?: protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, options?: CallOptions): Promise<[
        protos.google.ads.datamanager.v1.IUserListDirectLicense[],
        protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest | null,
        protos.google.ads.datamanager.v1.IListUserListDirectLicensesResponse
    ]>;

Lists all user list direct licenses owned by the parent account.

This feature is only available to data partners.

Parameters
Name	Description
request	IListUserListDirectLicensesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.ads.datamanager.v1.IUserListDirectLicense[], protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest | null, protos.google.ads.datamanager.v1.IListUserListDirectLicensesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of UserListDirectLicense. 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 listUserListDirectLicensesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listUserListDirectLicenses(request, options, callback)

listUserListDirectLicenses(request: protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, options: CallOptions, callback: PaginationCallback<protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, protos.google.ads.datamanager.v1.IListUserListDirectLicensesResponse | null | undefined, protos.google.ads.datamanager.v1.IUserListDirectLicense>): void;

Parameters
Name	Description
request	IListUserListDirectLicensesRequest
options	CallOptions
callback	PaginationCallback<protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, protos.google.ads.datamanager.v1.IListUserListDirectLicensesResponse | null | undefined, protos.google.ads.datamanager.v1.IUserListDirectLicense>

Returns
Type	Description
void

listUserListDirectLicenses(request, callback)

listUserListDirectLicenses(request: protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, callback: PaginationCallback<protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, protos.google.ads.datamanager.v1.IListUserListDirectLicensesResponse | null | undefined, protos.google.ads.datamanager.v1.IUserListDirectLicense>): void;

Parameters
Name	Description
request	IListUserListDirectLicensesRequest
callback	PaginationCallback<protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, protos.google.ads.datamanager.v1.IListUserListDirectLicensesResponse | null | undefined, protos.google.ads.datamanager.v1.IUserListDirectLicense>

Returns
Type	Description
void

listUserListDirectLicensesAsync(request, options)

listUserListDirectLicensesAsync(request?: protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, options?: CallOptions): AsyncIterable<protos.google.ads.datamanager.v1.IUserListDirectLicense>;

Equivalent to listUserListDirectLicenses, but returns an iterable object.

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

Parameters
Name	Description
request	IListUserListDirectLicensesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.ads.datamanager.v1.IUserListDirectLicense>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing UserListDirectLicense. 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 account whose licenses are being queried. Should be in the
   *  format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
   */
  // const parent = 'abc123'
  /**
   *  Optional. A filter string (https://google.aip.dev/160) to apply to the
   *  list request. All fields need to be on the left hand side of each condition
   *  (for example: `user_list_id = 123`). Fields must be specified using either
   *  all camel case (https://en.wikipedia.org/wiki/Camel_case) or all snake
   *  case (https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
   *  camel case and snake case.
   *  **Supported Operations:**
   *  - `AND`
   *  - `=`
   *  - `!=`
   *  - `>`
   *  - `>=`
   *  - `<` *="" -=""><=` *="" **supported="" functions:**="" *="" -="" `in(field,="" value1,="" value2,="" ...)`:="" returns="" true="" if="" the="" field="" matches="" any="" *="" of="" the="" values.="" example:="" `in(user_list_id,="" 123,="" 456)`="" *="" **unsupported="" fields:**="" *="" -="" `name`="" (use="" get="" method="" instead)="" *="" -="" `historical_pricings`="" and="" all="" its="" subfields="" *="" -="" `pricing.start_time`="" *="" -="" `pricing.end_time`="" */="" const="" filter='abc123' *="" *="" optional.="" the="" maximum="" number="" of="" licenses="" to="" return="" per="" page.="" the="" service="" *="" may="" return="" fewer="" than="" this="" value.="" if="" unspecified,="" at="" most="" 50="" licenses="" 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="" *="" `listuserlistdirectlicense`="" call.="" provide="" this="" to="" retrieve="" the="" subsequent="" *="" page.="" *="" when="" paginating,="" all="" other="" parameters="" provided="" to="" *="" `listuserlistdirectlicense`="" must="" match="" the="" call="" that="" provided="" the="" page="" *="" token.="" */="" const="" pagetoken='abc123' imports="" the="" datamanager="" library="" const="" {userlistdirectlicenseserviceclient}="require('@google-ads/datamanager').v1;" instantiates="" a="" client="" const="" datamanagerclient="new" userlistdirectlicenseserviceclient();="" async="" function="" calllistuserlistdirectlicenses()="" {="" construct="" request="" const="" request="{" parent,="" };="" run="" request="" const="" iterable="datamanagerClient.listUserListDirectLicensesAsync(request);" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistuserlistdirectlicenses();="">

listUserListDirectLicensesStream(request, options)

listUserListDirectLicensesStream(request?: protos.google.ads.datamanager.v1.IListUserListDirectLicensesRequest, options?: CallOptions): Transform;

Equivalent to listUserListDirectLicenses, but returns a NodeJS Stream object.

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

matchAccountFromAccountName(accountName)

matchAccountFromAccountName(accountName: string): string | number;

Parse the account from Account resource.

Parameter
Name	Description
accountName	string A fully-qualified path representing Account resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromPartnerLinkName(partnerLinkName)

matchAccountFromPartnerLinkName(partnerLinkName: string): string | number;

Parse the account from PartnerLink resource.

Parameter
Name	Description
partnerLinkName	string A fully-qualified path representing PartnerLink resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromUserListDirectLicenseName(userListDirectLicenseName)

matchAccountFromUserListDirectLicenseName(userListDirectLicenseName: string): string | number;

Parse the account from UserListDirectLicense resource.

Parameter
Name	Description
userListDirectLicenseName	string A fully-qualified path representing UserListDirectLicense resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName)

matchAccountFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName: string): string | number;

Parse the account from UserListGlobalLicenseCustomerInfo resource.

Parameter
Name	Description
userListGlobalLicenseCustomerInfoName	string A fully-qualified path representing UserListGlobalLicenseCustomerInfo resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromUserListGlobalLicenseName(userListGlobalLicenseName)

matchAccountFromUserListGlobalLicenseName(userListGlobalLicenseName: string): string | number;

Parse the account from UserListGlobalLicense resource.

Parameter
Name	Description
userListGlobalLicenseName	string A fully-qualified path representing UserListGlobalLicense resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountFromUserListName(userListName)

matchAccountFromUserListName(userListName: string): string | number;

Parse the account from UserList resource.

Parameter
Name	Description
userListName	string A fully-qualified path representing UserList resource.

Returns
Type	Description
string | number	{string} A string representing the account.

matchAccountTypeFromAccountName(accountName)

matchAccountTypeFromAccountName(accountName: string): string | number;

Parse the account_type from Account resource.

Parameter
Name	Description
accountName	string A fully-qualified path representing Account resource.

Returns
Type	Description
string | number	{string} A string representing the account_type.

matchAccountTypeFromPartnerLinkName(partnerLinkName)

matchAccountTypeFromPartnerLinkName(partnerLinkName: string): string | number;

Parse the account_type from PartnerLink resource.

Parameter
Name	Description
partnerLinkName	string A fully-qualified path representing PartnerLink resource.

Returns
Type	Description
string | number	{string} A string representing the account_type.

matchAccountTypeFromUserListDirectLicenseName(userListDirectLicenseName)

matchAccountTypeFromUserListDirectLicenseName(userListDirectLicenseName: string): string | number;

Parse the account_type from UserListDirectLicense resource.

Parameter
Name	Description
userListDirectLicenseName	string A fully-qualified path representing UserListDirectLicense resource.

Returns
Type	Description
string | number	{string} A string representing the account_type.

matchAccountTypeFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName)

matchAccountTypeFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName: string): string | number;

Parse the account_type from UserListGlobalLicenseCustomerInfo resource.

Parameter
Name	Description
userListGlobalLicenseCustomerInfoName	string A fully-qualified path representing UserListGlobalLicenseCustomerInfo resource.

Returns
Type	Description
string | number	{string} A string representing the account_type.

matchAccountTypeFromUserListGlobalLicenseName(userListGlobalLicenseName)

matchAccountTypeFromUserListGlobalLicenseName(userListGlobalLicenseName: string): string | number;

Parse the account_type from UserListGlobalLicense resource.

Parameter
Name	Description
userListGlobalLicenseName	string A fully-qualified path representing UserListGlobalLicense resource.

Returns
Type	Description
string | number	{string} A string representing the account_type.

matchAccountTypeFromUserListName(userListName)

matchAccountTypeFromUserListName(userListName: string): string | number;

Parse the account_type from UserList resource.

Parameter
Name	Description
userListName	string A fully-qualified path representing UserList resource.

Returns
Type	Description
string | number	{string} A string representing the account_type.

matchLicenseCustomerInfoFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName)

matchLicenseCustomerInfoFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName: string): string | number;

Parse the license_customer_info from UserListGlobalLicenseCustomerInfo resource.

Parameter
Name	Description
userListGlobalLicenseCustomerInfoName	string A fully-qualified path representing UserListGlobalLicenseCustomerInfo resource.

Returns
Type	Description
string | number	{string} A string representing the license_customer_info.

matchPartnerLinkFromPartnerLinkName(partnerLinkName)

matchPartnerLinkFromPartnerLinkName(partnerLinkName: string): string | number;

Parse the partner_link from PartnerLink resource.

Parameter
Name	Description
partnerLinkName	string A fully-qualified path representing PartnerLink resource.

Returns
Type	Description
string | number	{string} A string representing the partner_link.

matchUserListDirectLicenseFromUserListDirectLicenseName(userListDirectLicenseName)

matchUserListDirectLicenseFromUserListDirectLicenseName(userListDirectLicenseName: string): string | number;

Parse the user_list_direct_license from UserListDirectLicense resource.

Parameter
Name	Description
userListDirectLicenseName	string A fully-qualified path representing UserListDirectLicense resource.

Returns
Type	Description
string | number	{string} A string representing the user_list_direct_license.

matchUserListFromUserListName(userListName)

matchUserListFromUserListName(userListName: string): string | number;

Parse the user_list from UserList resource.

Parameter
Name	Description
userListName	string A fully-qualified path representing UserList resource.

Returns
Type	Description
string | number	{string} A string representing the user_list.

matchUserListGlobalLicenseFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName)

matchUserListGlobalLicenseFromUserListGlobalLicenseCustomerInfoName(userListGlobalLicenseCustomerInfoName: string): string | number;

Parse the user_list_global_license from UserListGlobalLicenseCustomerInfo resource.

Parameter
Name	Description
userListGlobalLicenseCustomerInfoName	string A fully-qualified path representing UserListGlobalLicenseCustomerInfo resource.

Returns
Type	Description
string | number	{string} A string representing the user_list_global_license.

matchUserListGlobalLicenseFromUserListGlobalLicenseName(userListGlobalLicenseName)

matchUserListGlobalLicenseFromUserListGlobalLicenseName(userListGlobalLicenseName: string): string | number;

Parse the user_list_global_license from UserListGlobalLicense resource.

Parameter
Name	Description
userListGlobalLicenseName	string A fully-qualified path representing UserListGlobalLicense resource.

Returns
Type	Description
string | number	{string} A string representing the user_list_global_license.

partnerLinkPath(accountType, account, partnerLink)

partnerLinkPath(accountType: string, account: string, partnerLink: string): string;

Return a fully-qualified partnerLink resource name string.

Parameters
Name	Description
accountType	string
account	string
partnerLink	string

Returns
Type	Description
string	{string} Resource name string.

updateUserListDirectLicense(request, options)

updateUserListDirectLicense(request?: protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest, options?: CallOptions): Promise<[
        protos.google.ads.datamanager.v1.IUserListDirectLicense,
        (protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest | undefined),
        {} | undefined
    ]>;

Updates a user list direct license.

This feature is only available to data partners.

Parameters
Name	Description
request	IUpdateUserListDirectLicenseRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.ads.datamanager.v1.IUserListDirectLicense, (protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest | undefined), {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing UserListDirectLicense. 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 licenses' `name` field is used to identify the license to
   *  update.
   */
  // const userListDirectLicense = {}
  /**
   *  Optional. The list of fields to update. The special character `*` is not
   *  supported and an `INVALID_UPDATE_MASK` error will be thrown if used.
   */
  // const updateMask = {}

  // Imports the Datamanager library
  const {UserListDirectLicenseServiceClient} = require('@google-ads/datamanager').v1;

  // Instantiates a client
  const datamanagerClient = new UserListDirectLicenseServiceClient();

  async function callUpdateUserListDirectLicense() {
    // Construct request
    const request = {
      userListDirectLicense,
    };

    // Run request
    const response = await datamanagerClient.updateUserListDirectLicense(request);
    console.log(response);
  }

  callUpdateUserListDirectLicense();

updateUserListDirectLicense(request, options, callback)

updateUserListDirectLicense(request: protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest, options: CallOptions, callback: Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateUserListDirectLicenseRequest
options	CallOptions
callback	Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateUserListDirectLicense(request, callback)

updateUserListDirectLicense(request: protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest, callback: Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateUserListDirectLicenseRequest
callback	Callback<protos.google.ads.datamanager.v1.IUserListDirectLicense, protos.google.ads.datamanager.v1.IUpdateUserListDirectLicenseRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

userListDirectLicensePath(accountType, account, userListDirectLicense)

userListDirectLicensePath(accountType: string, account: string, userListDirectLicense: string): string;

Return a fully-qualified userListDirectLicense resource name string.

Parameters
Name	Description
accountType	string
account	string
userListDirectLicense	string

Returns
Type	Description
string	{string} Resource name string.

userListGlobalLicenseCustomerInfoPath(accountType, account, userListGlobalLicense, licenseCustomerInfo)

userListGlobalLicenseCustomerInfoPath(accountType: string, account: string, userListGlobalLicense: string, licenseCustomerInfo: string): string;

Return a fully-qualified userListGlobalLicenseCustomerInfo resource name string.

Parameters
Name	Description
accountType	string
account	string
userListGlobalLicense	string
licenseCustomerInfo	string

Returns
Type	Description
string	{string} Resource name string.

userListGlobalLicensePath(accountType, account, userListGlobalLicense)

userListGlobalLicensePath(accountType: string, account: string, userListGlobalLicense: string): string;

Return a fully-qualified userListGlobalLicense resource name string.

Parameters
Name	Description
accountType	string
account	string
userListGlobalLicense	string

Returns
Type	Description
string	{string} Resource name string.

userListPath(accountType, account, userList)

userListPath(accountType: string, account: string, userList: string): string;

Return a fully-qualified userList resource name string.

Parameters
Name	Description
accountType	string
account	string
userList	string

Returns
Type	Description
string	{string} Resource name string.