Struct google_youtubeanalytics2::ReportQueryCall [−][src]
pub struct ReportQueryCall<'a, C, A> where
C: 'a,
A: 'a, { /* fields omitted */ }
Retrieve your YouTube Analytics reports.
A builder for the query method supported by a report resource.
It is not used directly, but through a ReportMethods
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.reports().query() .start_index(-35) .start_date("sea") .sort("nonumy") .metrics("dolores") .max_results(-61) .include_historical_channel_data(false) .ids("aliquyam") .filters("ea") .end_date("no") .dimensions("justo") .currency("justo") .doit();
Methods
impl<'a, C, A> ReportQueryCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
[src]
impl<'a, C, A> ReportQueryCall<'a, C, A> where
C: BorrowMut<Client>,
A: GetToken,
pub fn doit(self) -> Result<(Response, QueryResponse)>
[src]
pub fn doit(self) -> Result<(Response, QueryResponse)>
Perform the operation you have build so far.
pub fn start_index(self, new_value: i32) -> ReportQueryCall<'a, C, A>
[src]
pub fn start_index(self, new_value: i32) -> ReportQueryCall<'a, C, A>
An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter (one-based, inclusive).", minValue: 1
Sets the start index query property to the given value.
pub fn start_date(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn start_date(self, new_value: &str) -> ReportQueryCall<'a, C, A>
The start date for fetching YouTube Analytics data. The value should be in
YYYY-MM-DD
format.
required: true, pattern: "[0-9]{4}-[0-9]{2}-[0-9]{2}
Sets the start date query property to the given value.
pub fn sort(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn sort(self, new_value: &str) -> ReportQueryCall<'a, C, A>
A comma-separated list of dimensions or metrics that determine the sort
order for YouTube Analytics data. By default the sort order is ascending.
The '-
' prefix causes descending sort order.",
pattern: [-0-9a-zA-Z,]+
Sets the sort query property to the given value.
pub fn metrics(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn metrics(self, new_value: &str) -> ReportQueryCall<'a, C, A>
A comma-separated list of YouTube Analytics metrics, such as views
or
likes,dislikes
. See the
Available Reports document for
a list of the reports that you can retrieve and the metrics
available in each report, and see the
Metrics document for definitions of
those metrics.
required: true, pattern: [0-9a-zA-Z,]+
Sets the metrics query property to the given value.
pub fn max_results(self, new_value: i32) -> ReportQueryCall<'a, C, A>
[src]
pub fn max_results(self, new_value: i32) -> ReportQueryCall<'a, C, A>
The maximum number of rows to include in the response.", minValue: 1
Sets the max results query property to the given value.
pub fn include_historical_channel_data(
self,
new_value: bool
) -> ReportQueryCall<'a, C, A>
[src]
pub fn include_historical_channel_data(
self,
new_value: bool
) -> ReportQueryCall<'a, C, A>
If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.",
Sets the include historical channel data query property to the given value.
pub fn ids(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn ids(self, new_value: &str) -> ReportQueryCall<'a, C, A>
Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.
- To request data for a YouTube user, set the
ids
parameter value tochannel==CHANNEL_ID
, whereCHANNEL_ID
specifies the unique YouTube channel ID. - To request data for a YouTube CMS content owner, set the
ids
parameter value tocontentOwner==OWNER_NAME
, whereOWNER_NAME
is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-zA-Z0-9_+-]+
Sets the ids query property to the given value.
pub fn filters(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn filters(self, new_value: &str) -> ReportQueryCall<'a, C, A>
A list of filters that should be applied when retrieving YouTube Analytics
data. The Available Reports
document identifies the dimensions that can be used to filter each report,
and the Dimensions document defines
those dimensions. If a request uses multiple filters, join them together
with a semicolon (;
), and the returned result table will satisfy both
filters. For example, a filters parameter value of
video==dMH0bHeiRNg;country==IT
restricts the result set to include data
for the given video in Italy.",
Sets the filters query property to the given value.
pub fn end_date(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn end_date(self, new_value: &str) -> ReportQueryCall<'a, C, A>
The end date for fetching YouTube Analytics data. The value should be in
YYYY-MM-DD
format.
required: true, pattern: [0-9]{4}-[0-9]{2}-[0-9]{2}
Sets the end date query property to the given value.
pub fn dimensions(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn dimensions(self, new_value: &str) -> ReportQueryCall<'a, C, A>
A comma-separated list of YouTube Analytics dimensions, such as views
or
ageGroup,gender
. See the Available
Reports document for a list of
the reports that you can retrieve and the dimensions used for those
reports. Also see the Dimensions
document for definitions of those dimensions."
pattern: [0-9a-zA-Z,]+
Sets the dimensions query property to the given value.
pub fn currency(self, new_value: &str) -> ReportQueryCall<'a, C, A>
[src]
pub fn currency(self, new_value: &str) -> ReportQueryCall<'a, C, A>
The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.", pattern: [A-Z]{3}
Sets the currency query property to the given value.
pub fn delegate(self, new_value: &'a mut Delegate) -> ReportQueryCall<'a, C, A>
[src]
pub fn delegate(self, new_value: &'a mut Delegate) -> ReportQueryCall<'a, C, A>
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) -> ReportQueryCall<'a, C, A> where
T: AsRef<str>,
[src]
pub fn param<T>(self, name: T, value: T) -> ReportQueryCall<'a, C, A> where
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 paramters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- access_token (query-string) - OAuth access token.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- callback (query-string) - JSONP
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- 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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
- alt (query-string) - Data format for response.
- $.xgafv (query-string) - V1 error format.
pub fn add_scope<T, S>(self, scope: T) -> ReportQueryCall<'a, C, A> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
pub fn add_scope<T, S>(self, scope: T) -> ReportQueryCall<'a, C, A> where
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::YoutubeReadonly
.
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, A> CallBuilder for ReportQueryCall<'a, C, A>
[src]
impl<'a, C, A> CallBuilder for ReportQueryCall<'a, C, A>
Auto Trait Implementations
impl<'a, C, A> !Send for ReportQueryCall<'a, C, A>
impl<'a, C, A> !Send for ReportQueryCall<'a, C, A>
impl<'a, C, A> !Sync for ReportQueryCall<'a, C, A>
impl<'a, C, A> !Sync for ReportQueryCall<'a, C, A>