Method: accounts.locations.list

Belirtilen hesap için 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 [google.mybusiness.accountmanagement.v1.Account], [AccountType] [google.mybusiness.accountmanagement.v1.Account.AccountType] KİŞİSEL ise yalnızca doğrudan Hesabın sahibi olduğu Konumlar döndürülür. Aksi takdirde, doğrudan veya dolaylı olarak Hesap'taki erişilebilir tüm konumları döndürür.

Sorgu parametreleri

Parametreler
pageSize

integer

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

string

İsteğe bağlı. Belirtilmişse konumların sonraki page tanesini getirir. Sayfa jetonu, istenen sayfa boyutuna sığabilecek 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öndürülecek konumları sınırlayan 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ı. İsteğin sıralama düzeni. Birden fazla alan, SQL söz dizimine uygun şekilde virgülle ayrılmalıdır. Varsayılan sıralama düzeni artan düzendedir. Azalan sırayı belirtmek için " azalan" son eki eklenmelidir. orderBy için geçerli olan alanlar, title ve storeCode alanlarıdır. Örneğin: "title, storeCode desc", "title" veya "storeCode desc"
readMask

string (FieldMask format)

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

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

Location.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şıyorsa bu alan, sonraki bir 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 bulunmaz.
totalSize

integer

Sayfalara ayırmadan bağımsız olarak listedeki Konumların yaklaşık sayısı. Bu alan yalnızca filter, sorgu parametresi olarak kullanılırsa 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'a Genel Bakış başlıklı makaleye bakın.