get method

Future<CustomBiddingScript> get(
  1. String customBiddingAlgorithmId,
  2. String customBiddingScriptId, {
  3. String? advertiserId,
  4. String? partnerId,
  5. String? $fields,
})

Gets a custom bidding script.

Request parameters:

customBiddingAlgorithmId - Required. The ID of the custom bidding algorithm owns the script. Value must have pattern ^\[^/\]+$.

customBiddingScriptId - Required. The ID of the custom bidding script to fetch. Value must have pattern ^\[^/\]+$.

advertiserId - The ID of the advertiser that owns the parent custom bidding algorithm.

partnerId - The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.

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

Completes with a CustomBiddingScript.

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<CustomBiddingScript> get(
  core.String customBiddingAlgorithmId,
  core.String customBiddingScriptId, {
  core.String? advertiserId,
  core.String? partnerId,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (advertiserId != null) 'advertiserId': [advertiserId],
    if (partnerId != null) 'partnerId': [partnerId],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v3/customBiddingAlgorithms/' +
      core.Uri.encodeFull('$customBiddingAlgorithmId') +
      '/scripts/' +
      core.Uri.encodeFull('$customBiddingScriptId');

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