get method

Future<Creative> get(
  1. String name, {
  2. String? view,
  3. String? $fields,
})

Gets a creative.

Request parameters:

name - Required. Name of the creative to retrieve. See creative.name. Value must have pattern ^buyers/\[^/\]+/creatives/\[^/\]+$.

view - Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL". Possible string values are:

  • "CREATIVE_VIEW_UNSPECIFIED" : Not specified, equivalent to SERVING_DECISION_ONLY.
  • "SERVING_DECISION_ONLY" : Only creativeServingDecision is included in the response.
  • "FULL" : The entire creative resource (including the declared fields and the creative content) is included in the response.

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

Completes with a Creative.

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

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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