Method: accounts.locations.list

Belirtilen hesapla ilgili 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ı.

  • Belirli Hesap Kimliği: Hesap türü AccountType.PERSONAL ise yanıt yalnızca doğrudan o hesaba ait konumları döndürür. Diğer tüm türler (ör. AccountType.LOCATION_GROUP) için erişilebilir tüm konumları döndürür.

  • Joker karakter (-): accounts/- kullanıldığında kimliği doğrulanmış kullanıcı tanımlanır. Bu kapsam varsayılan olarak AccountType.PERSONAL değerine ayarlanır ancak hem doğrudan hem de dolaylı olarak sahip olunan konumları (ör. üye grupları aracılığıyla erişilebilen konumlar) içerir.

Sorgu parametreleri

Parametreler
pageSize

integer

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

string

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

string

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

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

string

İsteğe bağlıdır. İsteğin sıralama ölçütü. Birden fazla alan, SQL söz dizimine uygun şekilde virgülle ayrılmalıdır. Varsayılan sıralama ölçütü artandır. Azalan sıralamayı belirtmek için " desc" son eki eklenmelidir. orderBy için geçerli alanlar title ve storeCode'dur. Örneğin: "title, storeCode desc" veya "title" ya da "storeCode desc"
readMask

string (FieldMask format)

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

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

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Locations.ListLocations için yanıt mesajı.

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şarsa bu alan, locations.list için sonraki çağrıda bir sonraki konum sayfasını getirecek bir jetonla doldurulur. Başka konum yoksa bu alan yanıtta yer almaz.
totalSize

integer

Sayfalandırmadan bağımsız olarak listedeki yaklaşık konum sayısı. Bu alan yalnızca filter sorgu parametresi olarak kullanıldığında 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 sayfasını inceleyin.