Package google.mybusiness.verifications.v1

אינדקס

אימותים

ה-API הזה מאפשר לנהל את אימותי המיקום ב-Google. באמצעותה אפשר לנהל משאבי [אימות] [google.mybusiness.v1.אימות].

לכל [google.mybusiness.businessinformation.locations.v1.Location] יש אוסף של משאבים בשם locations/*/verifications/* ל[אימות] [google.mybusiness.verifications].

CompleteVerification

rpc CompleteVerification(CompleteVerificationRequest) returns (CompleteVerificationResponse)

השלמת תהליך האימות של PENDING.

האימות נדרש רק בשיטות אימות שאינן מסוג AUTO. בקשת האימות של AUTO מקבלת הרשאה מיידית VERIFIED מיד עם יצירתה.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
FetchVerificationOptions

rpc FetchVerificationOptions(FetchVerificationOptionsRequest) returns (FetchVerificationOptionsResponse)

מדווח על כל אפשרויות האימות המתאימות למיקום בשפה מסוימת.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
ListVerifications

rpc ListVerifications(ListVerificationsRequest) returns (ListVerificationsResponse)

רשימת האימותים של מיקום, מסודרת לפי שעת היצירה.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.
VerifyLocation

rpc VerifyLocation(VerifyLocationRequest) returns (VerifyLocationResponse)

התחלת תהליך האימות של מיקום.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

VoiceOfMerchant

השירות הזה מאפשר למשתמשי צד שלישי לבקש פרטים לגבי הקול של מצב המוכר.

GetVoiceOfMerchantState

rpc GetVoiceOfMerchantState(GetVoiceOfMerchantStateRequest) returns (VoiceOfMerchantState)

מקבל את המצב של VoiceOfMerchant.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/business.manage

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

CompleteVerificationRequest

שליחת בקשה לאימות לצורך אימותs.CompleteAuthenticationAction.

שדות
name

string

חובה. שם המשאב של האימות שצריך להשלים.
pin

string

חובה. קוד האימות שהתקבל מהמוכר כדי להשלים את האימות.

CompleteVerificationResponse

הודעת תשובה עבור verifications.CompleteVerifyAction.

שדות
verification

Verification

האימות הושלם.

ComplyWithGuidelines

מציין שהמיקום לא תואם להנחיות שלנו.

שדות
recommendation_reason

RecommendationReason

הסיבה שבגללה המערכת ממליצה על המיקום כך שלא יציית להנחיות.

RecommendationReason

מציין מדוע המיקום הומלץ ל-ComplyWithGuidelines.

טיפוסים בני מנייה (enums)
RECOMMENDATION_REASON_UNSPECIFIED לא צוין.
BUSINESS_LOCATION_SUSPENDED מיקום העסק מושעה. כדי לפתור את הבעיה, יש לעיין במאמר במרכז העזרה.
BUSINESS_LOCATION_DISABLED מיקום העסק מושבת. כדי לפתור את הבעיה, יש לעיין במאמר במרכז העזרה.

FetchVerificationOptionsRequest

הודעת בקשה עבור verifications.FetchAuthenticationOptions.

שדות
location

string

חובה. המיקום שצריך לאמת.
language_code

string

חובה. קוד השפה BCP 47 שמייצג את השפה שצריך להשתמש בה בתהליך האימות. האפשרויות הזמינות משתנות בהתאם לשפה.
context

ServiceBusinessContext

אפשרות. מידע נוסף על ההקשר של אימות עסקים שמספקים שירותים. ניתן להחיל רק על מיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. ציון כתובת מדויקת עשוי להפעיל אפשרויות נוספות. הערך INVALID_ARGUMENT יוסר אם הוא מוגדר עבור סוגי מיקומים אחרים של עסקים.

FetchVerificationOptionsResponse

הודעת תגובה עבור verifications.FetchAuthenticationOptions.

שדות
options[]

VerificationOption

אפשרויות האימות הזמינות.

GetVoiceOfMerchantStateRequest

בקשת הודעה ל-VoiceOfMerchant.GetVoiceOfMerchantState.

שדות
name

string

חובה. שם המשאב של המיקום.

ListVerificationsRequest

שליחת בקשה לאימות לצורך אימותs.ListAuthentications.

שדות
parent

string

חובה. שם המשאב של המיקום שאליו שייכות בקשות האימות.
page_size

int32

כמה אימותים לכלול בכל דף. ערך המינימום הוא 1, וברירת המחדל וגודל הדף המקסימלי הוא 100.
page_token

string

אם צוין, מחזירה את דף האימותים הבא.

ListVerificationsResponse

הודעת תגובה ל-verifications.ListAuthentications.

שדות
verifications[]

Verification

רשימת האימותים.
next_page_token

string

אם מספר האימותים חורג מגודל הדף המבוקש, השדה הזה יאוכלס באסימון לאחזור דף האימות הבא בשיחה הבאה. אם אין מאפיינים נוספים, השדה הזה לא יופיע בתשובה.

ResolveOwnershipConflict

אין שדות בסוג הזה.

מציין שהמיקום הוא כפילות של מיקום אחר שנמצא במצב ניהול תקין.

ServiceBusinessContext

נתונים נוספים לאימות עסק שמספק שירות.

שדות
address

PostalAddress

הכתובת לאימות של המיקום. הוא משמש להצגת אפשרויות אימות נוספות או לשליחת גלויה.

אימות

אימות מייצג ניסיון אימות של מיקום.

שדות
name

string

שם המשאב של האימות.
method

VerificationMethod

שיטת האימות.
state

State

מצב האימות.
create_time

Timestamp

חותמת הזמן של בקשת האימות.
announcement

string

אפשרות. הודעת התגובה מוגדרת רק אם השיטה היא VETTED_PARTNER.

ארץ

כל מצבי האימות האפשריים.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED ערך ברירת המחדל יגרום לשגיאות.
PENDING האימות בהמתנה.
COMPLETED האימות הושלם.
FAILED האימות נכשל.

VerificationMethod

מציין את התהליכים שבהם Google משתמשת כדי לאמת מיקום.

טיפוסים בני מנייה (enums)
VERIFICATION_METHOD_UNSPECIFIED ערך ברירת המחדל יגרום לשגיאות.
ADDRESS לשלוח גלויה עם קוד אימות (PIN) לכתובת דואר ספציפית. קוד האימות משמש להשלמת האימות ב-Google.
EMAIL לשלוח אימייל עם קוד אימות לאימות לכתובת אימייל ספציפית. קוד האימות משמש להשלמת האימות ב-Google.
PHONE_CALL ביצוע שיחת טלפון עם קוד אימות למספר טלפון ספציפי. קוד האימות משמש להשלמת האימות ב-Google.
SMS לשלוח הודעת SMS עם קוד אימות למספר טלפון ספציפי. קוד האימות משמש להשלמת האימות ב-Google.
AUTO מאמתים את המיקום בלי פעולה נוספת מצד המשתמש. יכול להיות שהאפשרות הזו לא תהיה זמינה בכל המיקומים.
VETTED_PARTNER יכול להיות שהאפשרות הזו לא תהיה זמינה בכל המיקומים.

VerificationOption

אפשרות האימות מייצגת את האופן שבו מאמתים את המיקום (יש לציין את שיטת האימות) ואל המקום שאליו יישלח האימות (לפי נתוני התצוגה).

שדות
verification_method

VerificationMethod

שיטה לאימות המיקום.
שדה איחוד DisplayData. אחד מנתוני התצוגה. הנתונים חייבים להתאים לשיטה. ריק אם לשיטה המתאימה אין נתוני תצוגה. הערך של DisplayData יכול להיות רק אחת מהאפשרויות הבאות:
phone_number

string

הגדר רק אם השיטה היא PHONE_CALL או SMS. מספר הטלפון שאליו יישלח קוד האימות.
address_data

AddressVerificationData

יש להגדיר רק אם השיטה היא MAIL.
email_data

EmailVerificationData

יש להגדיר רק אם השיטה היא EMAIL.
announcement

string

יש להגדיר רק אם השיטה היא VETTED_PARTNER.

AddressVerificationData

הצגת נתונים לאימות באמצעות גלויה.

שדות
business

string

שם העסק של המוכר.
address

PostalAddress

כתובת שאליה ניתן לשלוח גלויה.
expected_delivery_days_region

int32

מספר הימים הנדרשים למשלוח גלויה לאזור הכתובת.

EmailVerificationData

הצגת נתונים לאימות באימייל.

שדות
domain

string

שם הדומיין בכתובת האימייל. למשל "gmail.com" ב-foo@gmail.com
user

string

שם המשתמש בכתובת האימייל. למשל "foo" בכתובת foo@gmail.com
is_user_name_editable

bool

האם ללקוח מותר לספק שם משתמש אחר.

VerificationToken

האסימון נוצר על ידי שותף נבדק.

שדות
token_string

string

מחרוזת האסימון.

אימות

שדה זה מציין שהמיקום מחייב אימות. מידע על פעולות האימות הנוכחיות שמתבצעות במיקום.

שדות
has_pending_verification

bool

שדה זה מציין אם כבר התחיל תהליך אימות ואפשר להשלים אותו במיקום הגיאוגרפי.

VerifyLocationRequest

שליחת בקשה לאימות לצורך אימותs.VerifyLocation.

שדות
name

string

חובה. שם המשאב של המיקום שצריך לאמת.
method

VerificationMethod

חובה. שיטת האימות.
language_code

string

אפשרות. קוד השפה BCP 47 שמייצג את השפה שצריך להשתמש בה בתהליך האימות.
context

ServiceBusinessContext

אפשרות. מידע נוסף על ההקשר של אימות עסקים שמספקים שירותים. הוא נדרש רק עבור המיקומים שסוג העסק שלהם הוא CUSTOMER_LOCATION_ONLY. לאימות ADDRESS, הכתובת תשמש לשליחת גלויה. בכל שיטה אחרת, השיטה הזו צריכה להיות זהה לזו שמועברת אל GetAuthenticationOptions. הערך INVALID_ARGUMENT יופעל אם הוא מוגדר עבור סוגים אחרים של מיקומי עסקים.
שדה איחוד RequestData. נתוני קלט של משתמשים לשיטה ספציפית בנוסף לנתוני התצוגה. הנתונים חייבים להתאים לשיטה המבוקשת. אם אין צורך בנתונים, משאירים אותו ריק. הערך של RequestData יכול להיות רק אחת מהאפשרויות הבאות:
email_address

string

אפשרות. הקלט לשיטת EMAIL. כתובת האימייל שאליה יש לשלוח את מספר ה-PIN.

ניתן להשתמש בכתובת אימייל רק אם היא אחת מהכתובות שסופקו על ידי FetchAuthenticationOptions. אם הערך של [EmailAuthenticationData] [google.mybusiness-verifications.v1.AuthenticationOption.EmailAuthenticationData] הוגדר כ-'true', הלקוח יכול לציין שם משתמש אחר (local-part), אבל חייב להתאים לשם הדומיין.
mailer_contact

string

אפשרות. הקלט עבור שיטת ADDRESS. שם איש הקשר שאליו יש לשלוח את הדואר.
phone_number

string

אפשרות. הקלט לשיטת PHONE_CALL/SMS מספר הטלפון שאליו יש להתקשר או לשלוח אליו SMS. הוא צריך להיות אחד ממספרי הטלפון שמופיעים באפשרויות המתאימות.
token

VerificationToken

אפשרות. הקלט עבור שיטת VETTED_PARTNER זמין לpartners. נבחרים. הקלט לא נדרש לחשבון שנבדק. אסימון שמשויך למיקום. אסימון שמשויך למיקום.

VerifyLocationResponse

הודעת תגובה עבור verifications.VerifyLocation.

שדות
verification

Verification

בקשת האימות שנוצרה.

VoiceOfMerchantState

הודעת תגובה ל-VoiceOfMerchant.GetVoiceOfMerchantState.

שדות
has_voice_of_merchant

bool

מציין אם המיקום מנוהל באופן תקין ובעל שליטה על העסק ב-Google. כל שינוי שיבוצע במיקום יופץ במפות Google לאחר שיעברו את שלב הבדיקה.
has_business_authority

bool

מציין אם למיקום יש סמכות (בעלות) על העסק ב-Google. אם הערך הוא true, מיקום אחר לא יכול לתפוס שליטה על המיקום ולהפוך לרישום הדומיננטי במפות Google. עם זאת, שינויי עריכה לא יהפכו לזמינים אלא אם נקבל מידע נוסף מ-Voice of Merchant (כלומר, has_voice_of_merchant נכון).
שדה איחוד gain_voice_of_merchant_action. הפעולה המומלצת לגבי המיקום כדי לקבל שליטה על העסק ב-Google. הערך של gain_voice_of_merchant_action יכול להיות רק אחת מהאפשרויות הבאות:
wait_for_voice_of_merchant

WaitForVoiceOfMerchant

מחכים ל-Voice of Merchant. המיקום בבדיקה למטרות איכות.
verify

Verify

מתחילים או ממשיכים את תהליך האימות.
resolve_ownership_conflict

ResolveOwnershipConflict

המיקום הזה משכפל מיקום אחר שנמצא במצב ניהול תקין. אם יש לך גישה למיקום במצב ניהול תקין, השתמש במזהה של מיקום זה כדי לבצע פעולות. אחרת, עליך לבקש הרשאת גישה מהבעלים הנוכחי.
comply_with_guidelines

ComplyWithGuidelines

המיקום מפר את ההנחיות שלנו ונדרשים שלבים נוספים כדי להחזיר אותו. כדי לפתור את הבעיה, יש לעיין במאמר במרכז העזרה.

WaitForVoiceOfMerchant

אין שדות בסוג הזה.

מציין שהמיקום יקבל קול של מוכר אחרי שהוא יעבור את הבדיקה.