Method: accounts.locations.list

Belirtilen hesaba ilişkin konumları listeler.

HTTP isteği

GET https://mybusinessbusinessinformation.googleapis.com/v1/{parent=accounts/*}/locations

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Konumların alınacağı hesabın adı. Üst hesap [Account] ise [google.mybusiness.accountmanagement.v1.Account], [AccountType] türünde [google.mybusiness.accountmanagement.v1.Account.AccountType] KİŞİSEL, yalnızca doğrudan Hesaba ait olan Konumlar döndürülür. Aksi takdirde, Hesap'tan erişilebilen tüm konumları doğrudan veya dolaylı olarak döndürecektir.

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlı. Sayfa başına getirilecek konum sayısı. Ayarlanmazsa varsayılan değer 10'dur. Minimum 1, maksimum sayfa boyutu 100'dür.
pageToken

string

İsteğe bağlı. Belirtilirse sonraki page konumu getirir. Sayfa jetonu, istenen sayfa boyutuna sığabilecek daha fazla konum olduğunda önceki locations.list çağrıları tarafından döndürülür.
filter

string

İsteğe bağlı. Döndürülecek konumları kısıtlayan bir filtre. Yanıt yalnızca filtreyle eşleşen girişleri içerir. filter boşsa kısıtlamalar uygulanır ve istenen hesap için tüm konumlar (sayfalara ayrılmış) alınır.

Geçerli alanlar ve örnek kullanım hakkında daha fazla bilgi için Konum Verileriyle Çalışma Kılavuzu'na bakın.
orderBy

string

İsteğe bağlı. İstek için sıralama düzeni. Birden çok alan, SQL söz dizimine uygun şekilde virgülle ayrılmalıdır. Varsayılan sıralama düzeni artan düzendir. Azalan sırayı belirtmek için " azl" eklenmelidir. OrderBy için geçerli olan alanlar title ve storeCode'dur. Örneğin: "başlık, storeCode açıklaması" veya "başlık" veya "storeCode desc"
readMask

string (FieldMask format)

Zorunlu. Yanıtta hangi alanların döndürüleceğini belirtmek için okuma maskesi.

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

locations.ListLocations için yanıt iletisi.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Alanlar
locations[]

object (Location)

Konumlar.
nextPageToken

string

Konum sayısı istenen sayfa boyutunu aşıyorsa bu alan, bir sonraki locations.list çağrısında konumların sonraki sayfasını getirmek için bir jetonla doldurulur. Başka konum yoksa bu alan yanıtta mevcut değildir.
totalSize

integer

Sayfalara ayırmadan bağımsız olarak listedeki yaklaşık Konum sayısı. Bu alan yalnızca sorgu parametresi olarak filter kullanılıyorsa döndürülür.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/business.manage

Daha fazla bilgi için OAuth 2.0 Overview (OAuth 2.0'a Genel Bakış) sayfasına göz atın.