Provides methods for handling Order
objects. v1
Package
@google-ads/admanagerConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of OrderServiceClient.
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 OrderServiceClient({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
;
};
orderServiceStub
orderServiceStub
?:
Promise
< {
[
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.
networkCode
string
adUnit
string
string
{string} Resource name string.
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
companyPath(networkCode, company)
companyPath
(
networkCode
:
string
,
company
:
string
)
:
string
;
Return a fully-qualified company resource name string.
networkCode
string
company
string
string
{string} Resource name string.
contactPath(networkCode, contact)
contactPath
(
networkCode
:
string
,
contact
:
string
)
:
string
;
Return a fully-qualified contact resource name string.
networkCode
string
contact
string
string
{string} Resource name string.
customFieldPath(networkCode, customField)
customFieldPath
(
networkCode
:
string
,
customField
:
string
)
:
string
;
Return a fully-qualified customField resource name string.
networkCode
string
customField
string
string
{string} Resource name string.
customTargetingKeyPath(networkCode, customTargetingKey)
customTargetingKeyPath
(
networkCode
:
string
,
customTargetingKey
:
string
)
:
string
;
Return a fully-qualified customTargetingKey resource name string.
networkCode
string
customTargetingKey
string
string
{string} Resource name string.
customTargetingValuePath(networkCode, customTargetingKey, customTargetingValue)
customTargetingValuePath
(
networkCode
:
string
,
customTargetingKey
:
string
,
customTargetingValue
:
string
)
:
string
;
Return a fully-qualified customTargetingValue resource name string.
networkCode
string
customTargetingKey
string
customTargetingValue
string
string
{string} Resource name string.
entitySignalsMappingPath(networkCode, entitySignalsMapping)
entitySignalsMappingPath
(
networkCode
:
string
,
entitySignalsMapping
:
string
)
:
string
;
Return a fully-qualified entitySignalsMapping resource name string.
networkCode
string
entitySignalsMapping
string
string
{string} Resource name string.
getOrder(request, options)
getOrder
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IGetOrderRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
,
protos
.
google
.
ads
.
admanager
.
v1
.
IGetOrderRequest
|
undefined
,
{}
|
undefined
]>;
API to retrieve an Order object.
request
options
Promise
<[ protos.google.ads.admanager.v1.IOrder
, protos.google.ads.admanager.v1.IGetOrderRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Order . 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 Order.
* Format: `networks/{network_code}/orders/{order_id}`
*/
// const name = 'abc123'
// Imports the Admanager library
const
{
OrderServiceClient
}
=
require
(
' @google-ads/admanager
'
).
v1
;
// Instantiates a client
const
admanagerClient
=
new
OrderServiceClient
();
async
function
callGetOrder
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
admanagerClient
.
getOrder
(
request
);
console
.
log
(
response
);
}
callGetOrder
();
getOrder(request, options, callback)
getOrder
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IGetOrderRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
,
protos
.
google
.
ads
.
admanager
.
v1
.
IGetOrderRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.ads.admanager.v1.IOrder
, protos.google.ads.admanager.v1.IGetOrderRequest
| null | undefined, {} | null | undefined>
void
getOrder(request, callback)
getOrder
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IGetOrderRequest
,
callback
:
Callback<protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
,
protos
.
google
.
ads
.
admanager
.
v1
.
IGetOrderRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.ads.admanager.v1.IOrder
, protos.google.ads.admanager.v1.IGetOrderRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
labelPath(networkCode, label)
labelPath
(
networkCode
:
string
,
label
:
string
)
:
string
;
Return a fully-qualified label resource name string.
networkCode
string
label
string
string
{string} Resource name string.
listOrders(request, options)
listOrders
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
[],
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
|
null
,
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersResponse
]>;
API to retrieve a list of Order
objects.
Fields used for literal matching in filter string: * order_id
* display_name
* external_order_id
request
options
Promise
<[ protos.google.ads.admanager.v1.IOrder
[], protos.google.ads.admanager.v1.IListOrdersRequest
| null, protos.google.ads.admanager.v1.IListOrdersResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Order
. 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 listOrdersAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listOrders(request, options, callback)
listOrders
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersResponse
|
null
|
undefined
,
protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.ads.admanager.v1.IListOrdersRequest
, protos.google.ads.admanager.v1.IListOrdersResponse
| null | undefined, protos.google.ads.admanager.v1.IOrder
>
void
listOrders(request, callback)
listOrders
(
request
:
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
callback
:
PaginationCallback<protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersResponse
|
null
|
undefined
,
protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
> )
:
void
;
request
callback
PaginationCallback
< protos.google.ads.admanager.v1.IListOrdersRequest
, protos.google.ads.admanager.v1.IListOrdersResponse
| null | undefined, protos.google.ads.admanager.v1.IOrder
>
void
listOrdersAsync(request, options)
listOrdersAsync
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
ads
.
admanager
.
v1
.
IOrder
> ;
Equivalent to listOrders
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.ads.admanager.v1.IOrder
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Order . 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 Orders.
* Format: `networks/{network_code}`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of `Orders` to return. The service may return
* fewer than this value. If unspecified, at most 50 `Orders` 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 `ListOrders` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListOrders` 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
{
OrderServiceClient
}
=
require
(
' @google-ads/admanager
'
).
v1
;
// Instantiates a client
const
admanagerClient
=
new
OrderServiceClient
();
async
function
callListOrders
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
admanagerClient
.
listOrdersAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListOrders
();
listOrdersStream(request, options)
listOrdersStream
(
request
?:
protos
.
google
.
ads
.
admanager
.
v1
.
IListOrdersRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Order
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 listOrdersAsync()
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.
adUnitName
string
A fully-qualified path representing AdUnit resource.
string | number
{string} A string representing the ad_unit.
matchCompanyFromCompanyName(companyName)
matchCompanyFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the company from Company resource.
companyName
string
A fully-qualified path representing Company resource.
string | number
{string} A string representing the company.
matchContactFromContactName(contactName)
matchContactFromContactName
(
contactName
:
string
)
:
string
|
number
;
Parse the contact from Contact resource.
contactName
string
A fully-qualified path representing Contact resource.
string | number
{string} A string representing the contact.
matchCustomFieldFromCustomFieldName(customFieldName)
matchCustomFieldFromCustomFieldName
(
customFieldName
:
string
)
:
string
|
number
;
Parse the custom_field from CustomField resource.
customFieldName
string
A fully-qualified path representing CustomField resource.
string | number
{string} A string representing the custom_field.
matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName)
matchCustomTargetingKeyFromCustomTargetingKeyName
(
customTargetingKeyName
:
string
)
:
string
|
number
;
Parse the custom_targeting_key from CustomTargetingKey resource.
customTargetingKeyName
string
A fully-qualified path representing CustomTargetingKey resource.
string | number
{string} A string representing the custom_targeting_key.
matchCustomTargetingKeyFromCustomTargetingValueName(customTargetingValueName)
matchCustomTargetingKeyFromCustomTargetingValueName
(
customTargetingValueName
:
string
)
:
string
|
number
;
Parse the custom_targeting_key from CustomTargetingValue resource.
customTargetingValueName
string
A fully-qualified path representing CustomTargetingValue resource.
string | number
{string} A string representing the custom_targeting_key.
matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName)
matchCustomTargetingValueFromCustomTargetingValueName
(
customTargetingValueName
:
string
)
:
string
|
number
;
Parse the custom_targeting_value from CustomTargetingValue resource.
customTargetingValueName
string
A fully-qualified path representing CustomTargetingValue resource.
string | number
{string} A string representing the custom_targeting_value.
matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName)
matchEntitySignalsMappingFromEntitySignalsMappingName
(
entitySignalsMappingName
:
string
)
:
string
|
number
;
Parse the entity_signals_mapping from EntitySignalsMapping resource.
entitySignalsMappingName
string
A fully-qualified path representing EntitySignalsMapping resource.
string | number
{string} A string representing the entity_signals_mapping.
matchLabelFromLabelName(labelName)
matchLabelFromLabelName
(
labelName
:
string
)
:
string
|
number
;
Parse the label from Label resource.
labelName
string
A fully-qualified path representing Label resource.
string | number
{string} A string representing the label.
matchNetworkCodeFromAdUnitName(adUnitName)
matchNetworkCodeFromAdUnitName
(
adUnitName
:
string
)
:
string
|
number
;
Parse the network_code from AdUnit resource.
adUnitName
string
A fully-qualified path representing AdUnit resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCompanyName(companyName)
matchNetworkCodeFromCompanyName
(
companyName
:
string
)
:
string
|
number
;
Parse the network_code from Company resource.
companyName
string
A fully-qualified path representing Company resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromContactName(contactName)
matchNetworkCodeFromContactName
(
contactName
:
string
)
:
string
|
number
;
Parse the network_code from Contact resource.
contactName
string
A fully-qualified path representing Contact resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCustomFieldName(customFieldName)
matchNetworkCodeFromCustomFieldName
(
customFieldName
:
string
)
:
string
|
number
;
Parse the network_code from CustomField resource.
customFieldName
string
A fully-qualified path representing CustomField resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName)
matchNetworkCodeFromCustomTargetingKeyName
(
customTargetingKeyName
:
string
)
:
string
|
number
;
Parse the network_code from CustomTargetingKey resource.
customTargetingKeyName
string
A fully-qualified path representing CustomTargetingKey resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName)
matchNetworkCodeFromCustomTargetingValueName
(
customTargetingValueName
:
string
)
:
string
|
number
;
Parse the network_code from CustomTargetingValue resource.
customTargetingValueName
string
A fully-qualified path representing CustomTargetingValue resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName)
matchNetworkCodeFromEntitySignalsMappingName
(
entitySignalsMappingName
:
string
)
:
string
|
number
;
Parse the network_code from EntitySignalsMapping resource.
entitySignalsMappingName
string
A fully-qualified path representing EntitySignalsMapping resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromLabelName(labelName)
matchNetworkCodeFromLabelName
(
labelName
:
string
)
:
string
|
number
;
Parse the network_code from Label resource.
labelName
string
A fully-qualified path representing Label resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromNetworkName(networkName)
matchNetworkCodeFromNetworkName
(
networkName
:
string
)
:
string
|
number
;
Parse the network_code from Network resource.
networkName
string
A fully-qualified path representing Network resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromOrderName(orderName)
matchNetworkCodeFromOrderName
(
orderName
:
string
)
:
string
|
number
;
Parse the network_code from Order resource.
orderName
string
A fully-qualified path representing Order resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromPlacementName(placementName)
matchNetworkCodeFromPlacementName
(
placementName
:
string
)
:
string
|
number
;
Parse the network_code from Placement resource.
placementName
string
A fully-qualified path representing Placement resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromReportName(reportName)
matchNetworkCodeFromReportName
(
reportName
:
string
)
:
string
|
number
;
Parse the network_code from Report resource.
reportName
string
A fully-qualified path representing Report resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromRoleName(roleName)
matchNetworkCodeFromRoleName
(
roleName
:
string
)
:
string
|
number
;
Parse the network_code from Role resource.
roleName
string
A fully-qualified path representing Role resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName)
matchNetworkCodeFromTaxonomyCategoryName
(
taxonomyCategoryName
:
string
)
:
string
|
number
;
Parse the network_code from TaxonomyCategory resource.
taxonomyCategoryName
string
A fully-qualified path representing TaxonomyCategory resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromTeamName(teamName)
matchNetworkCodeFromTeamName
(
teamName
:
string
)
:
string
|
number
;
Parse the network_code from Team resource.
teamName
string
A fully-qualified path representing Team resource.
string | number
{string} A string representing the network_code.
matchNetworkCodeFromUserName(userName)
matchNetworkCodeFromUserName
(
userName
:
string
)
:
string
|
number
;
Parse the network_code from User resource.
userName
string
A fully-qualified path representing User resource.
string | number
{string} A string representing the network_code.
matchOrderFromOrderName(orderName)
matchOrderFromOrderName
(
orderName
:
string
)
:
string
|
number
;
Parse the order from Order resource.
orderName
string
A fully-qualified path representing Order resource.
string | number
{string} A string representing the order.
matchPlacementFromPlacementName(placementName)
matchPlacementFromPlacementName
(
placementName
:
string
)
:
string
|
number
;
Parse the placement from Placement resource.
placementName
string
A fully-qualified path representing Placement resource.
string | number
{string} A string representing the placement.
matchReportFromReportName(reportName)
matchReportFromReportName
(
reportName
:
string
)
:
string
|
number
;
Parse the report from Report resource.
reportName
string
A fully-qualified path representing Report resource.
string | number
{string} A string representing the report.
matchRoleFromRoleName(roleName)
matchRoleFromRoleName
(
roleName
:
string
)
:
string
|
number
;
Parse the role from Role resource.
roleName
string
A fully-qualified path representing Role resource.
string | number
{string} A string representing the role.
matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName)
matchTaxonomyCategoryFromTaxonomyCategoryName
(
taxonomyCategoryName
:
string
)
:
string
|
number
;
Parse the taxonomy_category from TaxonomyCategory resource.
taxonomyCategoryName
string
A fully-qualified path representing TaxonomyCategory resource.
string | number
{string} A string representing the taxonomy_category.
matchTeamFromTeamName(teamName)
matchTeamFromTeamName
(
teamName
:
string
)
:
string
|
number
;
Parse the team from Team resource.
teamName
string
A fully-qualified path representing Team resource.
string | number
{string} A string representing the team.
matchUserFromUserName(userName)
matchUserFromUserName
(
userName
:
string
)
:
string
|
number
;
Parse the user from User resource.
userName
string
A fully-qualified path representing User resource.
string | number
{string} A string representing the user.
networkPath(networkCode)
networkPath
(
networkCode
:
string
)
:
string
;
Return a fully-qualified network resource name string.
networkCode
string
string
{string} Resource name string.
orderPath(networkCode, order)
orderPath
(
networkCode
:
string
,
order
:
string
)
:
string
;
Return a fully-qualified order resource name string.
networkCode
string
order
string
string
{string} Resource name string.
placementPath(networkCode, placement)
placementPath
(
networkCode
:
string
,
placement
:
string
)
:
string
;
Return a fully-qualified placement resource name string.
networkCode
string
placement
string
string
{string} Resource name string.
reportPath(networkCode, report)
reportPath
(
networkCode
:
string
,
report
:
string
)
:
string
;
Return a fully-qualified report resource name string.
networkCode
string
report
string
string
{string} Resource name string.
rolePath(networkCode, role)
rolePath
(
networkCode
:
string
,
role
:
string
)
:
string
;
Return a fully-qualified role resource name string.
networkCode
string
role
string
string
{string} Resource name string.
taxonomyCategoryPath(networkCode, taxonomyCategory)
taxonomyCategoryPath
(
networkCode
:
string
,
taxonomyCategory
:
string
)
:
string
;
Return a fully-qualified taxonomyCategory resource name string.
networkCode
string
taxonomyCategory
string
string
{string} Resource name string.
teamPath(networkCode, team)
teamPath
(
networkCode
:
string
,
team
:
string
)
:
string
;
Return a fully-qualified team resource name string.
networkCode
string
team
string
string
{string} Resource name string.
userPath(networkCode, user)
userPath
(
networkCode
:
string
,
user
:
string
)
:
string
;
Return a fully-qualified user resource name string.
networkCode
string
user
string
string
{string} Resource name string.
