Struct GetAdMetadata

pub struct GetAdMetadata {
    pub ad_token: String,
    pub optional: HashMap<String, Value>,
}

Retrieve the metadata for the associated advertisement token (usually provided by one of the other methods responsible for retrieving the playlist).

Name	Type	Description
adToken	string	The adToken to retrieve the metadata for. (see Retrieve playlist)
returnAdTrackingTokens	boolean	(optional - but the adTrackingTokens are required by Register advertisement )
supportAudioAds	boolean	audioUrl links for the ads are included in the results if set to ‘True’. (optional)
includeBannerAd	boolean	bannerAdMap containing an HTML fragment that can be embedded in web pages is included in the results if set to ‘True’. (optional)

Fields

ad_token: String

The ad token associated with the ad for which metadata is being requested.

optional: HashMap<String, Value>

Optional parameters on the call

Implementations

impl GetAdMetadata

pub fn and_boolean_option(self, option: &str, value: bool) -> Self

Convenience function for setting boolean flags in the request. (Chaining call)

pub fn return_ad_tracking_tokens(self, value: bool) -> Self

Whether request should include ad tracking tokens in the response. (Chaining call)

pub fn support_audio_ads(self, value: bool) -> Self

Inform pandora whether audio ads are supported. (Chaining call)

pub fn include_banner_ad(self, value: bool) -> Self

Whether request should include banner ads in the response. (Chaining call)

Trait Implementations

impl Clone for GetAdMetadata

fn clone(&self) -> GetAdMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetAdMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<TS: ToString> From<&TS> for GetAdMetadata

fn from(ad_token: &TS) -> Self

Converts to this type from the input type.

impl PandoraJsonApiRequest for GetAdMetadata

type Response = GetAdMetadataResponse

The type that the json response will be deserialized to.

type Error = Error

The Error type to be returned by fallible calls on this trait.

fn encrypt_request(&self) -> bool

Whether the json body of the API call is expected to be encrypted before transmission.

fn get_method(&self) -> String

Returns the name of the Pandora JSON API call in the form that it must appear when making that call.

fn get_json(&self) -> Result<Value, Self::Error>

Returns the root json Value that should be serialized into the body of the API call.

fn request( &self, session: &mut PandoraSession, ) -> Result<RequestBuilder, Self::Error>

Generate an HTTP request that, when send() is called on it, will submit the built request.

fn response<'life0, 'life1, 'async_trait>( &'life0 self, session: &'life1 mut PandoraSession, ) -> Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Build the request, submit it, and extract the response content from the body json, and deserialize it into the Self::Response type.

impl Serialize for GetAdMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.