Przykłady biblioteki klienta interfejsu Address Validation API

Na tej stronie znajdziesz przykłady użycia bibliotek klienta interfejsu Address Validation API do wywoływania tych usług:

• validateAddress
• provideValidationFeedback

Instalowanie bibliotek klienta

Instrukcje instalacji znajdziesz w bibliotekach klienta interfejsu Address Validation API.

Uwierzytelnianie

Podczas korzystania z bibliotek klienta do uwierzytelniania używasz domyślnych danych logowania aplikacji. Informacje o konfigurowaniu domyślnego uwierzytelniania aplikacji znajdziesz w artykule Podawanie danych logowania na potrzeby domyślnego uwierzytelniania aplikacji. Więcej informacji o używaniu ADC z bibliotekami klienta znajdziesz w artykule Uwierzytelnianie za pomocą bibliotek klienta.

Do uwierzytelniania w bibliotekach klienta możesz też używać kluczy interfejsu API, np.:

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();

Gdy używasz kluczy interfejsu API w aplikacjach, zadbaj o ich bezpieczeństwo podczas przechowywania i przesyłania. Publiczne udostępnianie kluczy API może prowadzić do nieoczekiwanych opłat na Twoim koncie.

Przykłady na tej stronie korzystają z domyślnego uwierzytelniania aplikacji.

Przykłady

validateAddress

Poniżej znajdziesz przykład wywoływania funkcji validateAddress za pomocą biblioteki klienta .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}");
    }
}

Zdefiniuj obiekt PostalAddress z podzielonymi na komponenty polami adresu, takimi jak RegionCode, Locality i AddressLines. Podczas tworzenia przykładowego żądania ten PostalAddress służy do tworzenia ValidateAddressRequest. Następnie wywoływana jest metoda ValidateAddressAsync, aby wysłać żądanie, a szczegóły z odpowiedzi, takie jak ValidationGranularity i FormattedAddress, są wyświetlane.

provideValidationFeedback

Poniżej znajdziesz przykład wywoływania funkcji provideValidationFeedback za pomocą biblioteki klienta .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}");
    }
}

Utwórz ProvideValidationFeedbackRequest, aby wysłać informacje o ostatecznym wyniku sekwencji weryfikacji adresu. Żądanie wymaga parametru Conclusion, aby określić, czy użyto oryginalnego adresu użytkownika, czy zweryfikowanego adresu Google. Koniecznie musisz też podać ResponseId uzyskany z początkowego ValidateAddressResponse, aby powiązać opinię z odpowiednią transakcją.