Примеры клиентской библиотеки API проверки адресов

На этой странице приведены примеры использования клиентских библиотек API проверки адресов для вызова следующих сервисов:

• validateAddress
• provideValidationFeedback

Установите клиентские библиотеки.

Инструкции по установке см. в разделе клиентских библиотек API проверки адресов .

Аутентификация

При использовании клиентских библиотек для аутентификации используются учетные данные приложения по умолчанию (ADC) . Информацию о настройке ADC см. в разделе «Предоставление учетных данных для учетных данных приложения по умолчанию ». Информацию об использовании ADC с клиентскими библиотеками см. в разделе «Аутентификация с помощью клиентских библиотек» .

Для аутентификации в клиентских библиотеках можно также использовать ключи API, например:

using Google.Maps.AddressValidation.V1;
using Google.Api.Gax.Grpc;
using Grpc.Core;
...
// Create settings to pass the API key as a header in every request.
var apiHeader = CallSettings.FromHeader("X-Goog-Api-Key", "API_KEY");
var defaultSettings = AddressValidationSettings.GetDefault();
var settings = new AddressValidationSettings
{
    ValidateAddressSettings = defaultSettings.ValidateAddressSettings.MergedWith(apiHeader),
    ProvideValidationFeedbackSettings = defaultSettings.ProvideValidationFeedbackSettings.MergedWith(apiHeader)
};
// Create a client builder with the custom settings.
AddressValidationClientBuilder builder = new AddressValidationClientBuilder
{
    Settings = settings,
    // Use SslCredentials to create a secure channel for API key authentication.
    ChannelCredentials = new SslCredentials()
};
AddressValidationClient client = await builder.BuildAsync();

При использовании API-ключей в ваших приложениях убедитесь, что они надежно хранятся и передаются. Публичное раскрытие ваших API-ключей может привести к неожиданным списаниям средств с вашего счета.

В примерах на этой странице используются учетные данные приложения по умолчанию.

Примеры

validateAddress

Ниже приведён пример вызова функции validateAddress с использованием клиентской библиотеки .NET.

using Google.Maps.AddressValidation.V1;
using Google.Type;
...
private static async Task CallAddressValidation()
{
    // Create the Address Validation Client
    AddressValidationClient client = await AddressValidationClient.CreateAsync();
    // Define the request with the address to be validated
    var request = new ValidateAddressRequest
    {
        Address = new PostalAddress
        {
            RegionCode = "US",
            LanguageCode = "en",
            PostalCode = "94043",
            AdministrativeArea = "CA",
            Locality = "Mountain View",
            AddressLines = { "1600 Amphitheatre Parkway" }
        }
    };
    try
    {
        // Call the API asynchronously
        ValidateAddressResponse response = await client.ValidateAddressAsync(request);
        // Process the results
        Console.WriteLine($"Validation Granularity: {response.Result.Verdict.ValidationGranularity}");
        Console.WriteLine($"Formatted Address: {response.Result.Address.FormattedAddress}");
        Console.WriteLine($"Response ID: {response.ResponseId}");
    }
    catch (Exception ex)
    {
        Console.WriteLine($"An error occurred: {ex.Message}");
    }
}

Определите объект PostalAddress с компонентными полями адреса, такими как RegionCode , Locality и AddressLines . При создании примера запроса этот PostalAddress используется для создания объекта ValidateAddressRequest . Затем вызывается метод ValidateAddressAsync для выполнения запроса, и из ответа выводятся такие данные, как ValidationGranularity и FormattedAddress .

provideValidationFeedback

Ниже приведён пример вызова метода provideValidationFeedback с использованием клиентской библиотеки .NET.

using Google.Maps.AddressValidation.V1;
...
private static async Task ProvideValidationFeedback()
{
    AddressValidationClient client = await AddressValidationClient.CreateAsync();

    var feedbackRequest = new ProvideValidationFeedbackRequest
    {
        // Set the conclusion based on the user's choice. This exampels uses ValidatedVersionUsed
        Conclusion = ProvideValidationFeedbackRequest.Types.ValidationConclusion.ValidatedVersionUsed,
        // Provide the ID from the validation response.
        ResponseId = "Response_ID"
    };
    try
    {
        Console.WriteLine("Sending feedback to the API");
        // This call returns an empty response on success.
        await client.ProvideValidationFeedbackAsync(feedbackRequest);
        Console.WriteLine(" -> Feedback sent successfully!");
    }
    catch (Exception ex)
    {
        Console.WriteLine($"An error occurred: {ex.Message}");
    }
}

Создайте запрос ProvideValidationFeedbackRequest для отправки информации о конечном результате последовательности проверки адреса. Запрос должен содержать Conclusion , указывающее, был ли использован исходный адрес пользователя или адрес, проверенный Google. Крайне важно также указать ResponseId , полученный из первоначального запроса ValidateAddressResponse , чтобы связать обратную связь с соответствующей транзакцией.