Struct google_mybusiness4::api::AccountMethods

source ·

pub struct AccountMethods<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

A builder providing access to all methods supported on account resources. It is not used directly, but through the MyBusiness hub.

§Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusiness4 as mybusiness4;
 
use std::default::Default;
use mybusiness4::{MyBusiness, oauth2, hyper, hyper_rustls, chrono, FieldMask};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = MyBusiness::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `admins_create(...)`, `admins_delete(...)`, `admins_list(...)`, `admins_patch(...)`, `create(...)`, `delete_notifications(...)`, `generate_account_number(...)`, `get(...)`, `get_notifications(...)`, `invitations_accept(...)`, `invitations_decline(...)`, `invitations_list(...)`, `list(...)`, `list_recommend_google_locations(...)`, `locations_admins_create(...)`, `locations_admins_delete(...)`, `locations_admins_list(...)`, `locations_admins_patch(...)`, `locations_associate(...)`, `locations_batch_get(...)`, `locations_batch_get_reviews(...)`, `locations_clear_association(...)`, `locations_create(...)`, `locations_delete(...)`, `locations_fetch_verification_options(...)`, `locations_find_matches(...)`, `locations_followers_get_metadata(...)`, `locations_get(...)`, `locations_get_google_updated(...)`, `locations_list(...)`, `locations_local_posts_create(...)`, `locations_local_posts_delete(...)`, `locations_local_posts_get(...)`, `locations_local_posts_list(...)`, `locations_local_posts_patch(...)`, `locations_local_posts_report_insights(...)`, `locations_media_create(...)`, `locations_media_customers_get(...)`, `locations_media_customers_list(...)`, `locations_media_delete(...)`, `locations_media_get(...)`, `locations_media_list(...)`, `locations_media_patch(...)`, `locations_media_start_upload(...)`, `locations_patch(...)`, `locations_questions_answers_delete(...)`, `locations_questions_answers_list(...)`, `locations_questions_answers_upsert(...)`, `locations_questions_create(...)`, `locations_questions_delete(...)`, `locations_questions_list(...)`, `locations_questions_patch(...)`, `locations_report_insights(...)`, `locations_reviews_delete_reply(...)`, `locations_reviews_get(...)`, `locations_reviews_list(...)`, `locations_reviews_update_reply(...)`, `locations_transfer(...)`, `locations_verifications_complete(...)`, `locations_verifications_list(...)`, `locations_verify(...)`, `update(...)` and `update_notifications(...)`
// to build up your call.
let rb = hub.accounts();

Implementations§

source §

impl<'a, S> AccountMethods<'a, S>

source

pub fn admins_create( &self, request: Admin, parent: &str ) -> AccountAdminCreateCall<'a, S>

Create a builder to help you perform the following task:

Invites the specified user to become an administrator for the specified account. The invitee must accept the invitation in order to be granted access to the account. See AcceptInvitation to programmatically accept an invitation.

§Arguments

request - No description provided.
parent - The resource name of the account this admin is created for.

source

pub fn admins_delete(&self, name: &str) -> AccountAdminDeleteCall<'a, S>

Create a builder to help you perform the following task:

Removes the specified admin from the specified account.

§Arguments

name - The resource name of the admin to remove from the account.

source

pub fn admins_list(&self, parent: &str) -> AccountAdminListCall<'a, S>

Create a builder to help you perform the following task:

Lists the admins for the specified account.

§Arguments

parent - The name of the account from which to retrieve a list of admins.

source

pub fn admins_patch( &self, request: Admin, name: &str ) -> AccountAdminPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates the Admin for the specified Account Admin. Only the AdminRole of the Admin can be updated.

§Arguments

request - No description provided.
name - The resource name of the admin to update.

source

pub fn invitations_accept( &self, request: AcceptInvitationRequest, name: &str ) -> AccountInvitationAcceptCall<'a, S>

Create a builder to help you perform the following task:

Accepts the specified invitation.

§Arguments

request - No description provided.
name - The name of the invitation that is being accepted.

source

pub fn invitations_decline( &self, request: DeclineInvitationRequest, name: &str ) -> AccountInvitationDeclineCall<'a, S>

Create a builder to help you perform the following task:

Declines the specified invitation.

§Arguments

request - No description provided.
name - The name of the account invitation that is being declined.

source

pub fn invitations_list(&self, parent: &str) -> AccountInvitationListCall<'a, S>

Create a builder to help you perform the following task:

Lists pending invitations for the specified account.

§Arguments

parent - The name of the account from which the list of invitations is being retrieved.

source

pub fn locations_admins_create( &self, request: Admin, parent: &str ) -> AccountLocationAdminCreateCall<'a, S>

Create a builder to help you perform the following task:

Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location. See AcceptInvitation to programmatically accept an invitation.

§Arguments

request - No description provided.
parent - The resource name of the location this admin is created for.

source

pub fn locations_admins_delete( &self, name: &str ) -> AccountLocationAdminDeleteCall<'a, S>

Create a builder to help you perform the following task:

Removes the specified admin as a manager of the specified location.

§Arguments

name - The resource name of the admin to remove from the location.

source

pub fn locations_admins_list( &self, parent: &str ) -> AccountLocationAdminListCall<'a, S>

Create a builder to help you perform the following task:

Lists all of the admins for the specified location.

§Arguments

parent - The name of the location to list admins of.

source

pub fn locations_admins_patch( &self, request: Admin, name: &str ) -> AccountLocationAdminPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates the Admin for the specified Location Admin. Only the AdminRole of the Admin can be updated.

§Arguments

request - No description provided.
name - The resource name of the admin to update.

source

pub fn locations_followers_get_metadata( &self, name: &str ) -> AccountLocationFollowerGetMetadataCall<'a, S>

Create a builder to help you perform the following task:

Get the followers settings for a location.

NOT_FOUND is returned if either the account or the location doesn’t exist. PRECONDITION_FAILED is returned if the location is not verified nor connected to Maps.

§Arguments

name - The resource name of the location’s followers metadata. accounts/{account_id}/locations/{location_id}/followers/metadata

source

pub fn locations_local_posts_create( &self, request: LocalPost, parent: &str ) -> AccountLocationLocalPostCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new local post associated with the specified location, and returns it.

§Arguments

request - No description provided.
parent - The name of the location in which to create this local post.

source

pub fn locations_local_posts_delete( &self, name: &str ) -> AccountLocationLocalPostDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a local post. Returns NOT_FOUND if the local post does not exist.

§Arguments

name - The name of the local post to delete.

source

pub fn locations_local_posts_get( &self, name: &str ) -> AccountLocationLocalPostGetCall<'a, S>

Create a builder to help you perform the following task:

Gets the specified local post. Returns NOT_FOUND if the local post does not exist.

§Arguments

name - The name of the local post to fetch.

source

pub fn locations_local_posts_list( &self, parent: &str ) -> AccountLocationLocalPostListCall<'a, S>

Create a builder to help you perform the following task:

Returns a list of local posts associated with a location.

§Arguments

parent - The name of the location whose local posts will be listed.

source

pub fn locations_local_posts_patch( &self, request: LocalPost, name: &str ) -> AccountLocationLocalPostPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates the specified local post and returns the updated local post.

§Arguments

request - No description provided.
name - The name of the local post to update.

source

pub fn locations_local_posts_report_insights( &self, request: ReportLocalPostInsightsRequest, name: &str ) -> AccountLocationLocalPostReportInsightCall<'a, S>

Create a builder to help you perform the following task:

Returns insights for a set of local posts associated with a single listing. Which metrics and how they are reported are options specified in the request proto.

§Arguments

request - No description provided.
name - Required. The name of the location for which to fetch insights.

source

pub fn locations_media_customers_get( &self, name: &str ) -> AccountLocationMediaCustomerGetCall<'a, S>

Create a builder to help you perform the following task:

Returns metadata for the requested customer media item.

§Arguments

name - The resource name of the requested customer media item.

source

pub fn locations_media_customers_list( &self, parent: &str ) -> AccountLocationMediaCustomerListCall<'a, S>

Create a builder to help you perform the following task:

Returns a list of media items associated with a location that have been contributed by customers.

§Arguments

parent - The name of the location whose customer media items will be listed.

source

pub fn locations_media_create( &self, request: MediaItem, parent: &str ) -> AccountLocationMediaCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new media item for the location.

§Arguments

request - No description provided.
parent - The resource name of the location where this media item will be created.

source

pub fn locations_media_delete( &self, name: &str ) -> AccountLocationMediaDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes the specified media item.

§Arguments

name - The name of the media item to be deleted.

source

pub fn locations_media_get( &self, name: &str ) -> AccountLocationMediaGetCall<'a, S>

Create a builder to help you perform the following task:

Returns metadata for the requested media item.

§Arguments

name - The name of the requested media item.

source

pub fn locations_media_list( &self, parent: &str ) -> AccountLocationMediaListCall<'a, S>

Create a builder to help you perform the following task:

Returns a list of media items associated with a location.

§Arguments

parent - The name of the location whose media items will be listed.

source

pub fn locations_media_patch( &self, request: MediaItem, name: &str ) -> AccountLocationMediaPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates metadata of the specified media item. This can only be used to update the Category of a media item, with the exception that the new category cannot be COVER or PROFILE.

§Arguments

request - No description provided.
name - The name of the media item to be updated.

source

pub fn locations_media_start_upload( &self, request: StartUploadMediaItemDataRequest, parent: &str ) -> AccountLocationMediaStartUploadCall<'a, S>

Create a builder to help you perform the following task:

Generates a MediaItemDataRef for media item uploading.

§Arguments

request - No description provided.
parent - The resource name of the location this media item is to be added to.

source

pub fn locations_questions_answers_delete( &self, parent: &str ) -> AccountLocationQuestionAnswerDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes the answer written by the current user to a question.

§Arguments

parent - The name of the question to delete an answer for.

source

pub fn locations_questions_answers_list( &self, parent: &str ) -> AccountLocationQuestionAnswerListCall<'a, S>

Create a builder to help you perform the following task:

Returns the paginated list of answers for a specified question.

§Arguments

parent - The name of the question to fetch answers for.

source

pub fn locations_questions_answers_upsert( &self, request: UpsertAnswerRequest, parent: &str ) -> AccountLocationQuestionAnswerUpsertCall<'a, S>

Create a builder to help you perform the following task:

Creates an answer or updates the existing answer written by the user for the specified question. A user can only create one answer per question.

§Arguments

request - No description provided.
parent - The name of the question to write an answer for.

source

pub fn locations_questions_create( &self, request: Question, parent: &str ) -> AccountLocationQuestionCreateCall<'a, S>

Create a builder to help you perform the following task:

Adds a question for the specified location.

§Arguments

request - No description provided.
parent - The name of the location to write a question for.

source

pub fn locations_questions_delete( &self, name: &str ) -> AccountLocationQuestionDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a specific question written by the current user.

§Arguments

name - The name of the question to delete.

source

pub fn locations_questions_list( &self, parent: &str ) -> AccountLocationQuestionListCall<'a, S>

Create a builder to help you perform the following task:

Returns the paginated list of questions and some of its answers for a specified location.

§Arguments

parent - The name of the location to fetch questions for.

source

pub fn locations_questions_patch( &self, request: Question, name: &str ) -> AccountLocationQuestionPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates a specific question written by the current user.

§Arguments

request - No description provided.
name - The name of the question to update.

source

pub fn locations_reviews_delete_reply( &self, name: &str ) -> AccountLocationReviewDeleteReplyCall<'a, S>

Create a builder to help you perform the following task:

Deletes the response to the specified review. This operation is only valid if the specified location is verified.

§Arguments

name - The name of the review reply to delete.

source

pub fn locations_reviews_get( &self, name: &str ) -> AccountLocationReviewGetCall<'a, S>

Create a builder to help you perform the following task:

Returns the specified review. This operation is only valid if the specified location is verified. Returns NOT_FOUND if the review does not exist, or has been deleted.

§Arguments

name - The name of the review to fetch.

source

pub fn locations_reviews_list( &self, parent: &str ) -> AccountLocationReviewListCall<'a, S>

Create a builder to help you perform the following task:

Returns the paginated list of reviews for the specified location. This operation is only valid if the specified location is verified.

§Arguments

parent - The name of the location to fetch reviews for.

source

pub fn locations_reviews_update_reply( &self, request: ReviewReply, name: &str ) -> AccountLocationReviewUpdateReplyCall<'a, S>

Create a builder to help you perform the following task:

Updates the reply to the specified review. A reply is created if one does not exist. This operation is only valid if the specified location is verified.

§Arguments

request - No description provided.
name - The name of the review to respond to.

source

pub fn locations_verifications_complete( &self, request: CompleteVerificationRequest, name: &str ) -> AccountLocationVerificationCompleteCall<'a, S>

Create a builder to help you perform the following task:

Completes a PENDING verification.

It is only necessary for non AUTO verification methods. AUTO verification request is instantly VERIFIED upon creation.

§Arguments

request - No description provided.
name - Resource name of the verification to complete.

source

pub fn locations_verifications_list( &self, parent: &str ) -> AccountLocationVerificationListCall<'a, S>

Create a builder to help you perform the following task:

List verifications of a location, ordered by create time.

§Arguments

parent - Resource name of the location that verification requests belong to.

source

pub fn locations_associate( &self, request: AssociateLocationRequest, name: &str ) -> AccountLocationAssociateCall<'a, S>

Create a builder to help you perform the following task:

Associates a location to a place ID. Any previous association is overwritten. This operation is only valid if the location is unverified. The association must be valid, that is, it appears in the list of FindMatchingLocations.

§Arguments

request - No description provided.
name - The resource name of the location to associate.

source

pub fn locations_batch_get( &self, request: BatchGetLocationsRequest, name: &str ) -> AccountLocationBatchGetCall<'a, S>

Create a builder to help you perform the following task:

Gets all of the specified locations in the given account.

§Arguments

request - No description provided.
name - The name of the account from which to fetch locations.

source

pub fn locations_batch_get_reviews( &self, request: BatchGetReviewsRequest, name: &str ) -> AccountLocationBatchGetReviewCall<'a, S>

Create a builder to help you perform the following task:

Returns the paginated list of reviews for all specified locations. This operation is only valid if the specified locations are verified.

§Arguments

request - No description provided.
name - The name of the account from which to retrieve a list of reviews across multiple locations.

source

pub fn locations_clear_association( &self, request: ClearLocationAssociationRequest, name: &str ) -> AccountLocationClearAssociationCall<'a, S>

Create a builder to help you perform the following task:

Clears an association between a location and its place ID. This operation is only valid if the location is unverified.

§Arguments

request - No description provided.
name - The resource name of the location to disassociate.

source

pub fn locations_create( &self, request: Location, parent: &str ) -> AccountLocationCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new location owned by the specified account, and returns it.

§Arguments

request - No description provided.
parent - The name of the account in which to create this location.

source

pub fn locations_delete(&self, name: &str) -> AccountLocationDeleteCall<'a, S>

Create a builder to help you perform the following task:

Deletes a location.

source

pub fn locations_fetch_verification_options( &self, request: FetchVerificationOptionsRequest, name: &str ) -> AccountLocationFetchVerificationOptionCall<'a, S>

Create a builder to help you perform the following task:

Reports all eligible verification options for a location in a specific language.

§Arguments

request - No description provided.
name - Resource name of the location to verify.

source

pub fn locations_find_matches( &self, request: FindMatchingLocationsRequest, name: &str ) -> AccountLocationFindMatchCall<'a, S>

Create a builder to help you perform the following task:

Finds all of the possible locations that are a match to the specified location. This operation is only valid if the location is unverified.

§Arguments

request - No description provided.
name - The resource name of the location to find matches for.

source

pub fn locations_get(&self, name: &str) -> AccountLocationGetCall<'a, S>

Create a builder to help you perform the following task:

Gets the specified location. Returns NOT_FOUND if the location does not exist.

§Arguments

name - The name of the location to fetch.

source

pub fn locations_get_google_updated( &self, name: &str ) -> AccountLocationGetGoogleUpdatedCall<'a, S>

Create a builder to help you perform the following task:

Gets the Google-updated version of the specified location. Returns NOT_FOUND if the location does not exist.

§Arguments

name - The name of the location to fetch.

source

pub fn locations_list(&self, parent: &str) -> AccountLocationListCall<'a, S>

Create a builder to help you perform the following task:

Lists the locations for the specified account.

§Arguments

parent - The name of the account to fetch locations from. If the Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly.

source

pub fn locations_patch( &self, request: Location, name: &str ) -> AccountLocationPatchCall<'a, S>

Create a builder to help you perform the following task:

Updates the specified location.

Photos are only allowed on a location that has a Google+ page.

Returns NOT_FOUND if the location does not exist.

§Arguments

request - No description provided.
name - The name of the location to update.

source

pub fn locations_report_insights( &self, request: ReportLocationInsightsRequest, name: &str ) -> AccountLocationReportInsightCall<'a, S>

Create a builder to help you perform the following task:

Returns a report containing insights on one or more metrics by location.

§Arguments

request - No description provided.
name - The account resource name.

source

pub fn locations_transfer( &self, request: TransferLocationRequest, name: &str ) -> AccountLocationTransferCall<'a, S>

Create a builder to help you perform the following task:

Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account. Returns the Location with its new resource name.

§Arguments

request - No description provided.
name - The name of the location to transfer.

source

pub fn locations_verify( &self, request: VerifyLocationRequest, name: &str ) -> AccountLocationVerifyCall<'a, S>

Create a builder to help you perform the following task:

Starts the verification process for a location.

§Arguments

request - No description provided.
name - Resource name of the location to verify.

source

pub fn create(&self, request: Account) -> AccountCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates an account with the specified name and type under the given parent.

Personal accounts and Organizations cannot be created.
User Groups cannot be created with a Personal account as primary owner.
Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization.
Location Groups cannot own Location Groups.

§Arguments

request - No description provided.

source

pub fn delete_notifications( &self, name: &str ) -> AccountDeleteNotificationCall<'a, S>

Create a builder to help you perform the following task:

Clears the pubsub notification settings for the account.

§Arguments

name - The resource name for the notification settings to be cleared.

source

pub fn generate_account_number( &self, request: GenerateAccountNumberRequest, name: &str ) -> AccountGenerateAccountNumberCall<'a, S>

Create a builder to help you perform the following task:

Generates an account number for this account. The account number is not provisioned when an account is created. Use this request to create an account number when it is required.

§Arguments

request - No description provided.
name - The name of the account to generate an account number for.

source

pub fn get(&self, name: &str) -> AccountGetCall<'a, S>

Create a builder to help you perform the following task:

Gets the specified account. Returns NOT_FOUND if the account does not exist or if the caller does not have access rights to it.

§Arguments

name - The name of the account to fetch.

source

pub fn get_notifications(&self, name: &str) -> AccountGetNotificationCall<'a, S>

Create a builder to help you perform the following task:

Returns the pubsub notification settings for the account.

§Arguments

name - The notification settings resource name.

source

pub fn list(&self) -> AccountListCall<'a, S>

Create a builder to help you perform the following task:

Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.

source

pub fn list_recommend_google_locations( &self, name: &str ) -> AccountListRecommendGoogleLocationCall<'a, S>

Create a builder to help you perform the following task:

List all the GoogleLocations that have been recommended to the specified GMB account. Recommendations are provided for personal accounts and location groups only, requests for all other account types will result in an error. The recommendations for location groups are based on the locations in that group.

The recommendations for personal accounts are based on all of the locations that the user has access to on Google My Business (which includes locations they can access through location groups), and is a superset of all recommendations generated for the user.