generateDefault method

Future<LineItem> generateDefault(GenerateDefaultLineItemRequest request, String advertiserId, { String? $fields, })

Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entity_status.

Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.

request - The metadata request object.

Request parameters:

advertiserId - Required. The ID of the advertiser this line item belongs to. Value must have pattern ^\[^/\]+$.

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

Completes with a LineItem.

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<LineItem> generateDefault(
  GenerateDefaultLineItemRequest request,
  core.String advertiserId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/lineItems:generateDefault';

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