Class protos.google.ads.admanager.v1.CustomFieldService (0.7.0)

Represents a CustomFieldService

Inheritance

$protobuf.rpc.Service > protos.google.ads.admanager.v1.CustomFieldService

Package

@google-ads/admanager

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new CustomFieldService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchActivateCustomFields(request, callback)

public batchActivateCustomFields(request: google.ads.admanager.v1.IBatchActivateCustomFieldsRequest, callback: google.ads.admanager.v1.CustomFieldService.BatchActivateCustomFieldsCallback): void;

Calls BatchActivateCustomFields.

Parameters
Name Description
request IBatchActivateCustomFieldsRequest

BatchActivateCustomFieldsRequest message or plain object
callback BatchActivateCustomFieldsCallback

Node-style callback called with the error, if any, and BatchActivateCustomFieldsResponse
Returns
Type Description
void

batchActivateCustomFields(request)

public batchActivateCustomFields(request: google.ads.admanager.v1.IBatchActivateCustomFieldsRequest): Promise<google.ads.admanager.v1.BatchActivateCustomFieldsResponse>;

Calls BatchActivateCustomFields.

Parameter
Name Description
request IBatchActivateCustomFieldsRequest

BatchActivateCustomFieldsRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.BatchActivateCustomFieldsResponse>

Promise

batchCreateCustomFields(request, callback)

public batchCreateCustomFields(request: google.ads.admanager.v1.IBatchCreateCustomFieldsRequest, callback: google.ads.admanager.v1.CustomFieldService.BatchCreateCustomFieldsCallback): void;

Calls BatchCreateCustomFields.

Parameters
Name Description
request IBatchCreateCustomFieldsRequest

BatchCreateCustomFieldsRequest message or plain object
callback BatchCreateCustomFieldsCallback

Node-style callback called with the error, if any, and BatchCreateCustomFieldsResponse
Returns
Type Description
void

batchCreateCustomFields(request)

public batchCreateCustomFields(request: google.ads.admanager.v1.IBatchCreateCustomFieldsRequest): Promise<google.ads.admanager.v1.BatchCreateCustomFieldsResponse>;

Calls BatchCreateCustomFields.

Parameter
Name Description
request IBatchCreateCustomFieldsRequest

BatchCreateCustomFieldsRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.BatchCreateCustomFieldsResponse>

Promise

batchDeactivateCustomFields(request, callback)

public batchDeactivateCustomFields(request: google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest, callback: google.ads.admanager.v1.CustomFieldService.BatchDeactivateCustomFieldsCallback): void;

Calls BatchDeactivateCustomFields.

Parameters
Name Description
request IBatchDeactivateCustomFieldsRequest

BatchDeactivateCustomFieldsRequest message or plain object
callback BatchDeactivateCustomFieldsCallback

Node-style callback called with the error, if any, and BatchDeactivateCustomFieldsResponse
Returns
Type Description
void

batchDeactivateCustomFields(request)

public batchDeactivateCustomFields(request: google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest): Promise<google.ads.admanager.v1.BatchDeactivateCustomFieldsResponse>;

Calls BatchDeactivateCustomFields.

Parameter
Name Description
request IBatchDeactivateCustomFieldsRequest

BatchDeactivateCustomFieldsRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.BatchDeactivateCustomFieldsResponse>

Promise

batchUpdateCustomFields(request, callback)

public batchUpdateCustomFields(request: google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest, callback: google.ads.admanager.v1.CustomFieldService.BatchUpdateCustomFieldsCallback): void;

Calls BatchUpdateCustomFields.

Parameters
Name Description
request IBatchUpdateCustomFieldsRequest

BatchUpdateCustomFieldsRequest message or plain object
callback BatchUpdateCustomFieldsCallback

Node-style callback called with the error, if any, and BatchUpdateCustomFieldsResponse
Returns
Type Description
void

batchUpdateCustomFields(request)

public batchUpdateCustomFields(request: google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest): Promise<google.ads.admanager.v1.BatchUpdateCustomFieldsResponse>;

Calls BatchUpdateCustomFields.

Parameter
Name Description
request IBatchUpdateCustomFieldsRequest

BatchUpdateCustomFieldsRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.BatchUpdateCustomFieldsResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CustomFieldService;

Creates new CustomFieldService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
CustomFieldService

RPC service. Useful where requests and/or responses are streamed.

createCustomField(request, callback)

public createCustomField(request: google.ads.admanager.v1.ICreateCustomFieldRequest, callback: google.ads.admanager.v1.CustomFieldService.CreateCustomFieldCallback): void;

Calls CreateCustomField.

Parameters
Name Description
request ICreateCustomFieldRequest

CreateCustomFieldRequest message or plain object
callback CreateCustomFieldCallback

Node-style callback called with the error, if any, and CustomField
Returns
Type Description
void

createCustomField(request)

public createCustomField(request: google.ads.admanager.v1.ICreateCustomFieldRequest): Promise<google.ads.admanager.v1.CustomField>;

Calls CreateCustomField.

Parameter
Name Description
request ICreateCustomFieldRequest

CreateCustomFieldRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.CustomField>

Promise

getCustomField(request, callback)

public getCustomField(request: google.ads.admanager.v1.IGetCustomFieldRequest, callback: google.ads.admanager.v1.CustomFieldService.GetCustomFieldCallback): void;

Calls GetCustomField.

Parameters
Name Description
request IGetCustomFieldRequest

GetCustomFieldRequest message or plain object
callback GetCustomFieldCallback

Node-style callback called with the error, if any, and CustomField
Returns
Type Description
void

getCustomField(request)

public getCustomField(request: google.ads.admanager.v1.IGetCustomFieldRequest): Promise<google.ads.admanager.v1.CustomField>;

Calls GetCustomField.

Parameter
Name Description
request IGetCustomFieldRequest

GetCustomFieldRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.CustomField>

Promise

listCustomFields(request, callback)

public listCustomFields(request: google.ads.admanager.v1.IListCustomFieldsRequest, callback: google.ads.admanager.v1.CustomFieldService.ListCustomFieldsCallback): void;

Calls ListCustomFields.

Parameters
Name Description
request IListCustomFieldsRequest

ListCustomFieldsRequest message or plain object
callback ListCustomFieldsCallback

Node-style callback called with the error, if any, and ListCustomFieldsResponse
Returns
Type Description
void

listCustomFields(request)

public listCustomFields(request: google.ads.admanager.v1.IListCustomFieldsRequest): Promise<google.ads.admanager.v1.ListCustomFieldsResponse>;

Calls ListCustomFields.

Parameter
Name Description
request IListCustomFieldsRequest

ListCustomFieldsRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.ListCustomFieldsResponse>

Promise

updateCustomField(request, callback)

public updateCustomField(request: google.ads.admanager.v1.IUpdateCustomFieldRequest, callback: google.ads.admanager.v1.CustomFieldService.UpdateCustomFieldCallback): void;

Calls UpdateCustomField.

Parameters
Name Description
request IUpdateCustomFieldRequest

UpdateCustomFieldRequest message or plain object
callback UpdateCustomFieldCallback

Node-style callback called with the error, if any, and CustomField
Returns
Type Description
void

updateCustomField(request)

public updateCustomField(request: google.ads.admanager.v1.IUpdateCustomFieldRequest): Promise<google.ads.admanager.v1.CustomField>;

Calls UpdateCustomField.

Parameter
Name Description
request IUpdateCustomFieldRequest

UpdateCustomFieldRequest message or plain object
Returns
Type Description
Promise<google.ads.admanager.v1.CustomField>

Promise