Struct google_dfareporting3d2::api::CreativeListCall [−][src]
Retrieves a list of creatives, possibly filtered. This method supports paging.
A builder for the list method supported by a creative resource.
It is not used directly, but through a CreativeMethods
instance.
Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and // execute the final call using `doit()`. // Values shown here are possibly random and not representative ! let result = hub.creatives().list("profileId") .add_types("ipsum") .studio_creative_id("accusam") .sort_order("dolores") .sort_field("consetetur") .add_size_ids("no") .search_string("justo") .add_rendering_ids("sadipscing") .page_token("diam") .max_results(-10) .add_ids("ipsum") .add_creative_field_ids("Stet") .add_companion_creative_ids("gubergren") .campaign_id("ipsum") .archived(true) .advertiser_id("sit") .active(true) .doit().await;
Implementations
impl<'a, C> CreativeListCall<'a, C> where
C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>,
[src]
C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>,
pub async fn doit(self) -> Result<(Response<Body>, CreativesListResponse)>
[src]
Perform the operation you have build so far.
pub fn profile_id(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
User profile ID associated with this request.
Sets the profile id path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn add_types(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with these creative types.
Append the given value to the types query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
pub fn studio_creative_id(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives corresponding to this Studio creative ID.
Sets the studio creative id query property to the given value.
pub fn sort_order(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Order of sorted results.
Sets the sort order query property to the given value.
pub fn sort_field(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Field by which to sort the list.
Sets the sort field query property to the given value.
pub fn add_size_ids(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with these size IDs.
Append the given value to the size ids query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
pub fn search_string(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Allows searching for objects by name or ID. Wildcards () are allowed. For example, “creative2015” will return objects with names like “creative June 2015”, “creative April 2015”, or simply “creative 2015”. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of “creative” will match objects with name “my creative”, “creative 2015”, or simply “creative”.
Sets the search string query property to the given value.
pub fn add_rendering_ids(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with these rendering IDs.
Append the given value to the rendering ids query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
pub fn page_token(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Value of the nextPageToken from the previous result page.
Sets the page token query property to the given value.
pub fn max_results(self, new_value: i32) -> CreativeListCall<'a, C>
[src]
Maximum number of results to return.
Sets the max results query property to the given value.
pub fn add_ids(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with these IDs.
Append the given value to the ids query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
pub fn add_creative_field_ids(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with these creative field IDs.
Append the given value to the creative field ids query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
pub fn add_companion_creative_ids(
self,
new_value: &str
) -> CreativeListCall<'a, C>
[src]
self,
new_value: &str
) -> CreativeListCall<'a, C>
Select only in-stream video creatives with these companion IDs.
Append the given value to the companion creative ids query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
pub fn campaign_id(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with this campaign ID.
Sets the campaign id query property to the given value.
pub fn archived(self, new_value: bool) -> CreativeListCall<'a, C>
[src]
Select only archived creatives. Leave blank to select archived and unarchived creatives.
Sets the archived query property to the given value.
pub fn advertiser_id(self, new_value: &str) -> CreativeListCall<'a, C>
[src]
Select only creatives with this advertiser ID.
Sets the advertiser id query property to the given value.
pub fn active(self, new_value: bool) -> CreativeListCall<'a, C>
[src]
Select only active creatives. Leave blank to select active and inactive creatives.
Sets the active query property to the given value.
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> CreativeListCall<'a, C>
[src]
self,
new_value: &'a mut dyn Delegate
) -> CreativeListCall<'a, C>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
pub fn param<T>(self, name: T, value: T) -> CreativeListCall<'a, C> where
T: AsRef<str>,
[src]
T: AsRef<str>,
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- alt (query-string) - Data format for the response.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- userIp (query-string) - Deprecated. Please use quotaUser instead.
pub fn add_scope<T, S>(self, scope: T) -> CreativeListCall<'a, C> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead the default Scope
variant
Scope::Dfatrafficking
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
Trait Implementations
impl<'a, C> CallBuilder for CreativeListCall<'a, C>
[src]
Auto Trait Implementations
impl<'a, C> !RefUnwindSafe for CreativeListCall<'a, C>
impl<'a, C> !Send for CreativeListCall<'a, C>
impl<'a, C> !Sync for CreativeListCall<'a, C>
impl<'a, C> Unpin for CreativeListCall<'a, C>
impl<'a, C> !UnwindSafe for CreativeListCall<'a, C>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,