Struct googapis::google::actions::sdk::v2::AccountLinking

pub struct AccountLinking {
    pub enable_account_creation: bool,
    pub linking_type: i32,
    pub auth_grant_type: i32,
    pub app_client_id: String,
    pub authorization_url: String,
    pub token_url: String,
    pub scopes: Vec<String>,
    pub learn_more_url: String,
    pub use_basic_auth_header: bool,
}

AccountLinking allows Google to guide the user to sign-in to the App’s web services.

For Google Sign In and OAuth + Google Sign In linking types, Google generates a client ID identifying your App to Google (“Client ID issued by Google to your Actions” on Console UI). This field is read-only and can be checked by navigating to the Console UI’s Account Linking page. See: https://developers.google.com/assistant/identity/google-sign-in

Note: For all account linking setting types (except for Google Sign In), you must provide a username and password for a test account in Settings.testing_instructions for the review team to review the app (they will not be visible to users).

Fields

enable_account_creation: bool

Required. If true, users are allowed to sign up for new accounts via voice. If false, account creation is only allowed on your website. Select this option if you want to display your terms of service or obtain user consents during sign-up. linking_type cannot be GOOGLE_SIGN_IN when this is false. linking_type cannot be OAUTH when this is true.

linking_type: i32

Required. The linking type to use. See https://developers.google.com/assistant/identity for further details on the linking types.

auth_grant_type: i32

Optional. Indicates the type of authentication for OAUTH linking_type.

app_client_id: String

Optional. Client ID issued by your App to Google. This is the OAuth2 Client ID identifying Google to your service. Only set when using OAuth.

authorization_url: String

Optional. Endpoint for your sign-in web page that supports OAuth2 code or implicit flows. URL must use HTTPS. Only set when using OAuth.

token_url: String

Optional. OAuth2 endpoint for token exchange. URL must use HTTPS. This is not set when only using OAuth with IMPLICIT grant as the linking type. Only set when using OAuth.

scopes: Vec<String>

Optional. List of permissions the user must consent to in order to use your service. Only set when using OAuth. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.

learn_more_url: String

Optional. This is the web page on your service which describes the permissions the user is granting to Google. Only set if using OAuth and Google Sign In. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.

use_basic_auth_header: bool

Optional. If true, allow Google to transmit client ID and secret via HTTP basic auth header. Otherwise, Google uses the client ID and secret inside the post body. Only set when using OAuth. Make sure to provide a Terms of Service in the directory information in LocalizedSettings.terms_of_service_url section if specifying this field.

Implementations

impl AccountLinking

pub fn linking_type(&self) -> LinkingType

Returns the enum value of linking_type, or the default if the field is set to an invalid enum value.

pub fn set_linking_type(&mut self, value: LinkingType)

Sets linking_type to the provided enum value.

pub fn auth_grant_type(&self) -> AuthGrantType

Returns the enum value of auth_grant_type, or the default if the field is set to an invalid enum value.

pub fn set_auth_grant_type(&mut self, value: AuthGrantType)

Sets auth_grant_type to the provided enum value.

Trait Implementations

impl Clone for AccountLinking

fn clone(&self) -> AccountLinking

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountLinking

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

Formats the value using the given formatter.

impl Default for AccountLinking

fn default() -> Self

Returns the “default value” for a type.

impl Message for AccountLinking

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<AccountLinking> for AccountLinking

fn eq(&self, other: &AccountLinking) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AccountLinking) -> bool

This method tests for !=.

impl StructuralPartialEq for AccountLinking