Struct gpapi::Gpapi

pub struct Gpapi { /* fields omitted */ }

The Gpapi object is the sole way to interact with the Play Store API. It abstracts the logic of low-level communication with Google’s Play Store servers.

Implementations

impl Gpapi

pub fn new<S: Into<String>>(locale: S, timezone: S, device_codename: S) -> Self

Returns a Gpapi struct with locale, timezone, and the device codename specified.

Arguments

• locale - A string type specifying the device locale, e.g. “en_US”
• timezone - A string type specifying the timezone , e.g. “UTC”
• device_codename - A string type specifying the device codename, e.g. “hero2lte”

pub async fn login<S: Into<String> + Clone>(
    &mut self,
    username: S,
    password: S
) -> Result<(), GpapiError>

Log in to Google’s Play Store API. This is required for most other actions.

Arguments

• username - A string type specifying the login username, usually a full email
• password - A string type specifying an app password, created from your Google account settings.

pub async fn download<S: Into<String>>(
    &self,
    pkg_name: S,
    version_code: Option<i32>,
    dst_path: &Path
) -> Result<(), GpapiError>

Download a package, given a package ID, optional version code, and filesystem path.

Arguments

• pkg_name - A string type specifying the package’s app ID, e.g. com.instagram.android
• version_code - An optinal version code, given in i32. If omitted, the latest version will be used
• dst_path - A path to download the file to.

Errors

If the file already exists for this download, an Err(Error) result is returned with an [ErrorKind] of FileExists. If the specified directory is misssing, an Err(Error) result is returned with an [ErrorKind] of DirectoryMissing.

pub async fn get_download_url<S: Into<String>>(
    &self,
    pkg_name: S,
    version_code: Option<i32>
) -> Result<Option<String>, GpapiError>

Retrieve the download URL for a package, given a package ID and optional version code.

Arguments

• pkg_name - A string type specifying the package’s app ID, e.g. com.instagram.android
• version_code - An optinal version code, given in i32. If omitted, the latest version will be used

pub async fn details<S: Into<String>>(
    &self,
    pkg_name: S
) -> Result<Option<DetailsResponse>, GpapiError>

Play Store package detail request (provides more detail than bulk requests).

Arguments

• pkg_name - A string type specifying the package’s app ID, e.g. com.instagram.android

pub async fn bulk_details(
    &self,
    pkg_names: &[&str]
) -> Result<Option<BulkDetailsResponse>, GpapiError>

Play Store bulk detail request for multiple apps.

Arguments

• pkg_names - An array of string types specifying package app IDs

Trait Implementations

impl Debug for Gpapi

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

Formats the value using the given formatter.