Interface GoogleBusinessProfileNodeParameters

Source
interface GoogleBusinessProfileNodeParameters {
    account?: { mode: "list" | "name"; value: string };
    additionalOptions?:
        | {
            callToActionType?: | "ACTION_TYPE_UNSPECIFIED"
            | "BOOK"
            | "CALL"
            | "LEARN_MORE"
            | "ORDER"
            | "SHOP"
            | "SIGN_UP";
            couponCode?: string;
            languageCode?: string;
            redeemOnlineUrl?: string;
            termsConditions?: string;
            url?: string;
        }
        | {
            callToActionType?: | "ACTION_TYPE_UNSPECIFIED"
            | "BOOK"
            | "LEARN_MORE"
            | "ORDER"
            | "SHOP"
            | "SIGN_UP"
            | "GET_OFFER";
            couponCode?: string;
            endDate?: string;
            endDateTime?: string;
            languageCode?: string;
            redeemOnlineUrl?: string;
            startDate?: string;
            startDateTime?: string;
            summary?: string;
            termsConditions?: string;
            title?: string;
            url?: string;
        };
    alertType?: "COVID_19";
    endDate?: string;
    endDateTime?: string;
    limit?: number;
    location?: { mode: "list"
    | "name"; value: string };
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "reply";
    post?: { mode: "list"
    | "name"; value: string };
    postType?: "EVENT" | "STANDARD" | "OFFER" | "ALERT";
    reply?: string;
    resource?: "post" | "review";
    returnAll?: boolean;
    review?: {
        mode: "id" | "list" | "name";
        value: string;
    };
    startDate?: string;
    startDateTime?: string;
    summary?: string;
    title?: string;
}

Properties§

Source§

readonly account?: { mode: "list" | "name"; value: string }

The Google Business Profile account Default: {"mode":"list","value":""}

Source§

readonly additionalOptions?:
    | {
        callToActionType?: | "ACTION_TYPE_UNSPECIFIED"
        | "BOOK"
        | "CALL"
        | "LEARN_MORE"
        | "ORDER"
        | "SHOP"
        | "SIGN_UP";
        couponCode?: string;
        languageCode?: string;
        redeemOnlineUrl?: string;
        termsConditions?: string;
        url?: string;
    }
    | {
        callToActionType?: | "ACTION_TYPE_UNSPECIFIED"
        | "BOOK"
        | "LEARN_MORE"
        | "ORDER"
        | "SHOP"
        | "SIGN_UP"
        | "GET_OFFER";
        couponCode?: string;
        endDate?: string;
        endDateTime?: string;
        languageCode?: string;
        redeemOnlineUrl?: string;
        startDate?: string;
        startDateTime?: string;
        summary?: string;
        termsConditions?: string;
        title?: string;
        url?: string;
    }

Default: {}

Source§

readonly alertType?: "COVID_19"

The sub-type of the alert Default: "COVID_19"

Source§

readonly endDate?: string

The end date of the offer

Source§

readonly endDateTime?: string

The end date and time of the event

Source§

readonly limit?: number

Max number of results to return Default: 20 Type options: {"minValue":1}

Source§

readonly location?: { mode: "list" | "name"; value: string }

The specific location or business associated with the account Default: {"mode":"list","value":""}

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "delete" | "reply"

Default: "create"

Source§

readonly post?: { mode: "list" | "name"; value: string }

Select the post to retrieve its details Default: {"mode":"list","value":""}

Source§

readonly postType?: "EVENT" | "STANDARD" | "OFFER" | "ALERT"

The type of post to create (standard, event, offer, or alert) Default: "STANDARD"

Source§

readonly reply?: string

The body of the reply (up to 4096 characters) Type options: {"rows":5}

Source§

readonly resource?: "post" | "review"

Default: "post"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly review?: { mode: "id" | "list" | "name"; value: string }

Select the review to retrieve its details Default: {"mode":"list","value":""}

Source§

readonly startDate?: string

The start date of the offer

Source§

readonly startDateTime?: string

The start date and time of the event

Source§

readonly summary?: string

The main text of the post

Source§

readonly title?: string

E.g. Sales this week.