patch method

Future<FirstAndThirdPartyAudience> patch(FirstAndThirdPartyAudience request, String firstAndThirdPartyAudienceId, { String? advertiserId, String? updateMask, String? $fields, })

Updates an existing FirstAndThirdPartyAudience.

Only supported for the following audience_type: * CUSTOMER_MATCH_CONTACT_INFO * CUSTOMER_MATCH_DEVICE_ID

request - The metadata request object.

Request parameters:

firstAndThirdPartyAudienceId - Output only. The unique ID of the first and third party audience. Assigned by the system. Value must have pattern ^\[^/\]+$.

advertiserId - Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.

updateMask - Required. The mask to control which fields to update. Updates are only supported for the following fields: * displayName * description * membershipDurationDays

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

Completes with a FirstAndThirdPartyAudience.

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<FirstAndThirdPartyAudience> patch(
  FirstAndThirdPartyAudience request,
  core.String firstAndThirdPartyAudienceId, {
  core.String? advertiserId,
  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 (updateMask != null) 'updateMask': [updateMask],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/firstAndThirdPartyAudiences/' +
      core.Uri.encodeFull('$firstAndThirdPartyAudienceId');

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