AccountsLocationsListOptions

import type { AccountsLocationsListOptions } from "https://googleapis.deno.dev/v1/mybusinessbusinessinformation:v1.ts";

Additional options for MyBusinessBusinessInformation#accountsLocationsList.

interface AccountsLocationsListOptions {

filter?: string;

orderBy?: string;

pageSize?: number;

pageToken?: string;

readMask?: string;

}

§Properties

filter?: string

[src]

Optional. A filter constraining the locations to return. The response includes only entries that match the filter. If filter is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see Work with Location Data Guide.

orderBy?: string

[src]

Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"

pageSize?: number

[src]

Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.

pageToken?: string

[src]

Optional. If specified, it fetches the next page of locations. The page token is returned by previous calls to ListLocations when there were more locations than could fit in the requested page size.

readMask?: string

[src]

Required. Read mask to specify what fields will be returned in the response.