این صفحه نمونه هایی از نحوه استفاده از کتابخانه های سرویس گیرنده Address Validation API برای فراخوانی سرویس های زیر دارد:
کتابخانه های سرویس گیرنده را نصب کنید
برای دستورالعملهای نصب، کتابخانههای سرویس گیرنده Address Validation 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
با استفاده از کتابخانه مشتری آورده شده است.
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
خروجی می شود.
ارائه ValidationFeedback
در زیر مثالی از نحوه فراخوانی provideValidationFeedback
با استفاده از کتابخانه مشتری آورده شده است.
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
اولیه را برای پیوند دادن بازخورد به تراکنش صحیح ارائه دهید.