listPlannableUserLists method

Future<GoogleAdsSearchads360V23ServicesListPlannableUserListsResponse> listPlannableUserLists(
  1. GoogleAdsSearchads360V23ServicesListPlannableUserListsRequest request, {
  2. String? $fields,
})

Returns the list of plannable user lists with their plannable status.

User lists may not be plannable for a number of reasons, including: - They are less than 10 days old. - They have a membership lifespan that is less than 30 days - They have less than 10,000 or more than 700,000 users. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]()

request - The metadata request object.

Request parameters:

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

Completes with a GoogleAdsSearchads360V23ServicesListPlannableUserListsResponse.

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<GoogleAdsSearchads360V23ServicesListPlannableUserListsResponse>
listPlannableUserLists(
  GoogleAdsSearchads360V23ServicesListPlannableUserListsRequest request, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  const url_ = 'v23:listPlannableUserLists';

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