patch method

Future<GuaranteedOrder> patch(GuaranteedOrder request, String guaranteedOrderId, { String? advertiserId, String? partnerId, String? updateMask, String? $fields, })

Updates an existing guaranteed order.

Returns the updated guaranteed order if successful.

request - The metadata request object.

Request parameters:

guaranteedOrderId - Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacy_guaranteed_order_id}. Value must have pattern ^\[^/\]+$.

advertiserId - The ID of the advertiser that the request is being made within.

partnerId - The ID of the partner that the request is being made within.

updateMask - Required. The mask to control which fields to update.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GuaranteedOrder.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GuaranteedOrder> patch(
  GuaranteedOrder request,
  core.String guaranteedOrderId, {
  core.String? advertiserId,
  core.String? partnerId,
  core.String? updateMask,
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if (advertiserId != null) 'advertiserId': [advertiserId],
    if (partnerId != null) 'partnerId': [partnerId],
    if (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v2/guaranteedOrders/' + core.Uri.encodeFull('$guaranteedOrderId');

  final response_ = await _requester.request(
    url_,
    'PATCH',
    body: body_,
    queryParams: queryParams_,
  );
  return GuaranteedOrder.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}