Package google.mybusiness.placeactions.v1

Dizin

PlaceActions

Bu API, işletme konumlarının PlaceAction bağlantılarının yönetilmesini sağlar.

ListPlaceActionTypeMetadata

rpc ListPlaceActionTypeMetadata(ListPlaceActionTypeMetadataRequest) returns (ListPlaceActionTypeMetadataResponse)

Bir konum veya ülke için kullanılabilir yer işlemi türlerinin listesini döndürü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.

CreatePlaceActionLinkRequest

PlaceActions.CreatePlaceActionLink için mesaj isteyin.

Alanlar
parent

string

Zorunlu. Bu yer işlemi bağlantısının oluşturulacağı konumun kaynak adı. locations/{location_id}.

DeletePlaceActionLinkRequest

PlaceActions.DeletePlaceActionLink için mesaj isteyin.

Alanlar
name

string

Zorunlu. Konumdan kaldırılacak yer işlemi bağlantısının kaynak adı.

ErrorCode

Dahili hatalar için hata kodları.

Sıralamalar
ERROR_CODE_UNSPECIFIED Belirtilmemiş hata kodu.
UNVERIFIED_LOCATION Konum doğrulanmamış.
INVALID_LOCATION_CATEGORY Konum kategorisi, yer işlem türü için uygun değil. Hataya neden olan yer işlemi türü, anahtar olarak "place_action_type" ve değer olarak PlaceActionType enum değer dizesiyle meta veride döndürülür.
INVALID_URL URL hatalı/geçersiz. Geçersiz yer işlemi URL'si meta veride, anahtar olarak "url" dizesi ve değer olarak url olacak şekilde döndürülür.
URL_PROVIDER_NOT_ALLOWED URL'de izin verilmeyen bir sağlayıcı var. İzin verilmeyen yer işlemi URL'si, anahtar olarak "url" ve değer olarak url dizesiyle meta veride döndürülür.
TOO_MANY_VALUES Yer işlem türü için çok fazla değer ayarlandı. Sınıra ulaşılan tür, anahtar olarak "place_action_type" dizesi ve değer olarak PlaceActionType sıralama değeri dizesi olmak üzere meta veride döndürülür.

GetPlaceActionLinkRequest

PlaceActions.GetPlaceActionLink için mesaj isteyin.

Alanlar
name

string

Zorunlu. Getirme işlemi için kullanılacak yer işlemi bağlantısının adı.

ListPlaceActionLinksRequest

PlaceActions.ListPlaceActionLinks için mesaj isteyin. Bu, bir konumla ilgili yer işlemi bağlantılarını belirli bir sıra olmadan listeler. Bu işlem, yakın zamanda (son 24 saat içinde) oluşturulan bağlantıları Google Benim İşletmem web sitesi gibi diğer platformlardan döndüremeyebilir. 24 saatten uzun bir süre önce oluşturulan tüm bağlantılar bu API üzerinden gösterilir.

Alanlar
parent

string

Zorunlu. Yer işlemi bağlantıları listelenecek konumun adı. locations/{location_id}.
filter

string

İsteğe bağlı. Döndürülecek yer işlemi bağlantılarını sınırlayan bir filtre. Yanıt, filtreyle eşleşen girişleri içerir. Yalnızca şu filtre desteklenmektedir: 1. Place_action_type=XYZ, burada XYZ geçerli bir PlaceActionType'tır.
page_size

int32

İsteğe bağlı. Sayfa başına döndürülecek yer işlemi bağlantısı sayısı. Varsayılan değer 10'dur. Minimum değer 1'dir.
page_token

string

İsteğe bağlı. Belirtilmişse, yer işlemi bağlantılarının sonraki sayfasını döndürür.

ListPlaceActionLinksResponse

PlaceActions.ListPlaceActionLinks için yanıt mesajı.

Alanlar
next_page_token

string

İstenen sayfa boyutundan daha fazla yer işlemi bağlantısı varsa bu alan, sonraki sonuç sayfasını getirmek için bir jetonla doldurulur.

ListPlaceActionTypeMetadataRequest

PlaceActions.ListPlaceActionTypeMetadata için istek mesajı. Sonuçlar belirli bir sıra olmadan döndürülür.

Alanlar
language_code

string

İsteğe bağlı. Görünen adları almak için kullanılacak dilin IETF BCP-47 kodu. Bu dil mevcut değilse, mesajlar İngilizce olarak sağlanır.
page_size

int32

İsteğe bağlı. Sayfa başına eklenecek işlem türü sayısı. Varsayılan değer 10, minimum değer 1'dir.
page_token

string

İsteğe bağlı. Belirtilirse yer işlem türü meta verilerinin sonraki sayfası alınır. placeActionTypeMetadata.list için yapılan bir çağrı, istenen sayfa boyutuna sığabilecek daha fazla sonuç döndürdüğünde pageToken döndürülür.
filter

string

İsteğe bağlı. Meta veri döndürülecek yer işlem türlerini sınırlayan bir filtre. Yanıt, filtreyle eşleşen girişleri içerir. Yalnızca şu filtreler desteklenmektedir: 1. konum=XYZ. Burada XYZ, bir konumun kaynak adını belirten, locations/{location_id} biçimindeki bir dizedir. 2. bölge_kodu=XYZ. Burada XYZ, kullanılabilir işlem türlerini bulmak için bir Unicode CLDR bölge kodudur.

Filtre sağlanmazsa tüm yer işlem türleri döndürülür.

ListPlaceActionTypeMetadataResponse

PlaceActions.ListPlaceActionTypeMetadata için yanıt mesajı.

Alanlar
place_action_type_metadata[]

PlaceActionTypeMetadata

Kullanılabilir yer işlemi türleri için meta veri koleksiyonu.
next_page_token

string

İşlem türlerinin sayısı istenen sayfa boyutunu aşıyorsa bu alan, sonraki bir placeActionTypeMetadata.list çağrısında sonraki sayfayı getirmek için bir jetonla doldurulur. Başka sonuç yoksa bu alan yanıtta yer almaz.

ProviderType

Bağlantı sağlayıcının türü yalnızca okunabilir.

Sıralamalar
PROVIDER_TYPE_UNSPECIFIED Belirtilmedi.
MERCHANT Satıcı gibi bir birinci taraf sağlayıcı veya satıcı adına bir ajans.
AGGREGATOR_3P Reserve with Google iş ortağı gibi bir üçüncü taraf toplayıcı.

PlaceActionType

Bağlantı kullanılarak gerçekleştirilebilecek yer işleminin türü.

Sıralamalar
PLACE_ACTION_TYPE_UNSPECIFIED Belirtilmedi.
APPOINTMENT İşlem türü randevu almadır.
ONLINE_APPOINTMENT İşlem türü, online randevu alma.
DINING_RESERVATION İşlem türü, yemek rezervasyonu yapıyor.
FOOD_ORDERING İşlem türü, yemek siparişi ve/veya paket servisi için yemek siparişi verilmesidir.
FOOD_DELIVERY İşlem türü, teslimat için yemek sipariş etmektir.
FOOD_TAKEOUT İşlem türü, paket servisi için yemek sipariş etmektir.
SHOP_ONLINE İşlem türü alışveriştir. Bu seçenek teslimat ve/veya teslim alma olabilir.

PlaceActionTypeMetadata

Desteklenen yer işlemi türleri için meta veriler.

Alanlar
place_action_type

PlaceActionType

Yer işleminin türü.
display_name

string

Varsa özelliğin yerelleştirilmiş görünen adı; aksi takdirde İngilizce görünen ad.

UpdatePlaceActionLinkRequest

PlaceActions.UpdatePlaceActionLink için mesaj isteyin.

Alanlar
update_mask

FieldMask

Zorunlu. Güncellenecek belirli alanlar. Yalnızca uri, place_action_type ve is_preferred düzenlenebilir. Güncellenen bağlantı, aynı place_action_type ve uri ile aynı konumda zaten varsa ALREADY_EXISTS hatasıyla başarısız olur.