הפעלת ה-API

מסמך זה מתאר כיצד להשתמש ב-Google Site Verification API.

הפעלת ה-API

פורמט הבקשה

רוב פעולות התמיכה באימות אתר ממופות ישירות לפעלים מסוג HTTP של REST (GET, POST, PUT, DELETE), כפי שמתואר בפעולות ה-API לאימות אתרים של Google.

הפורמט הספציפי ל-URIs של אימות אתר של Google הוא:

https://www.googleapis.com/siteVerification/v1/webResource/resourceID?parameters

כאשר resourceID הוא המזהה של משאב אינטרנט, parameters הם פרמטרים שיחולו על השאילתה. הפרמטרים שבהם תשתמשו בפועל ישתנו בהתאם לפעולה שתבצעו. בנוסף, אם משתמשים ב-OAuth 2.0, יש להגדיר את access_token בפרמטרים האלה.

אין צורך להוסיף ResourceID לשאילתות ברשימה, כך שהפורמט הוא:

https://www.googleapis.com/siteVerification/v1/webResource?parameters

ניתן לבצע קריאה לפעולה getToken באמצעות URI ייחודי משלה. הפורמט של קריאה ל-getToken הוא:

https://www.googleapis.com/siteVerification/v1/token?parameters

פורמט נתונים

ה-Google Sites Verification API מחזיר נתונים בפורמט JSON.

JSON (JavaScript Object Notation) הוא פורמט נתונים נפוץ שאינו תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. מידע נוסף זמין בכתובת json.org.

סיכום פעולות

ניתן להפעיל שש שיטות שונות לגבי אוספים ומשאבים ב-Google Site Verification API, כפי שמתואר בטבלה הבאה. כתובות ה-URL של ה-API הן יחסיות ל-https://www.googleapis.com/siteVerification/v1.

פעולה תיאור כתובת URL ותחביר
list

רשימה של כל המשאבים באוסף 'משתמש מאומת'.

GET /webResource

ראו דוגמה לרשימת אתרים.
insert

אימות אתר או דומיין. הפעולה מתבצעת בהצלחה. המערכת מוסיפה משאב אינטרנט חדש לאוסף של המשתמש.

גוף הבקשה: לעיון במשאב אינטרנט.

פרמטר השאילתה: verificationMethod. שיטת האימות שמשמשת עבור הבקשה הזו. ערכים אפשריים: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /webResource

ראו דוגמה להוספת בקשה.
הורדה

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

GET /webResource/resourceID

דוגמה לבקשת הורדה
עדכון

שינוי רשימת הבעלים של משאב ספציפי.

גוף הבקשה: לעיון במשאב אינטרנט.

הערות:

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

PUT /webResource/resourceID

דוגמה לבקשת עדכון
מחיקה

מסיר משאב מאוסף המשתמשים (מאשר שהאתר שייך למשתמש).

הערות:

  • לפני הקריאה למחיקה, עליך להסיר תחילה את כל האסימונים לאימות בעלות של המשתמש מהאתר או מהדומיין. אם יש אסימונים קיימים, מוחזרת שגיאת HTTP 400 (בקשה שגויה).
  • המחיקה משפיעה על נתוני הבעלות של המשתמש המאומת בלבד. כל שאר המשתמשים, בין אם הם הוענקו להם רישיון או אומתו באופן עצמאי, נשארים הבעלים לאחר המחיקה.

DELETE /webResource/resourceID

דוגמה לבקשת מחיקה
getToken

קבלת אסימון האימות להצבה באתר של המשתמש המאומת.

גוף הבקשה:

  • identifier: כתובת ה-URL או שם הדומיין.
  • type: סוג המשאב לאימות. ערכים אפשריים: SITE, INET_DOMAIN.
  • verificationMethod: השיטה שתשמש לאימות האתר. ערכים אפשריים: FILE, META, ANALYTICS, TAG_MANAGER, DNS_TXT, DNS_CNAME

POST /token

עיינו בדוגמה לבקשת getToken.

קריאות ל-API לדוגמה

קטע זה יוצא מנקודת הנחה שאתם (המפתח) הוא גם המשתמש המאומת, כפי שיקרה קודם כל אם תנסו את ה-API עם נתוני הבדיקה שלכם.

אימות אתר חדש

כדי לאמת אתר,

  1. ראשית, מבקשים אסימון אימות באמצעות קריאה ל-getToken.
  2. מציבים את האסימון באתר בכל שיטה שתבחרו.
  3. מבקשים מ-Google לאמת את האתר שלכם באמצעות הפעולה הוספה.

getToken (מחייב הרשאה)

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token

בקשה:

POST https://www.googleapis.com/siteVerification/v1/token?access_token=oauth2-token
Content-Type: application/json

{
  "verificationMethod": "FILE",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

תשובה:

{
  "token": "google12cfc68677988bb4.html",
  "method": "FILE"
}

הוספה (נדרשת הרשאה)

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token

בקשה:

POST https://www.googleapis.com/siteVerification/v1/webResource?verificationMethod=FILE&access_token=oauth2-token
Content-Type: application/json

{
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

תשובה:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

אחזור מידע עבור משאבי אינטרנט מאומתים

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

רשימה (נדרשת הרשאה)

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

בקשה:

GET https://www.googleapis.com/siteVerification/v1/webResource?access_token=oauth2-token

תשובה:

{
  "items": [
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site1",
        "type": "SITE"
      }
    },
    {
      "owners": [
        "myself@example.com",
      ],
      "id": "http%3A%2F%2Fwww.example.com%2F",
      "site": {
        "identifier": "http://www.example.com/site2",
        "type": "SITE"
      }
    }
  ]
}

קבלת גישה (נדרשת הרשאה)

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

בקשה:

GET https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

תשובה:

{
  "owners": [
    "myself@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

שינוי פרטי האימות

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

עדכון (נדרשת הרשאה)

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

בקשה:

PUT https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token
Content-Type: application/json

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com",
    "type": "SITE"
  }
}

תשובה:

{
  "owners": [
    "myself@example.com",
    "another@example.com",
  ],
  "id": "http%3A%2F%2Fwww.example.com%2F",
  "site": {
    "identifier": "http://www.example.com/",
    "type": "SITE"
  }
}

מחיקה (נדרשת הרשאה)

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

בקשה:

DELETE https://www.googleapis.com/siteVerification/v1/webResource/http%3A%2F%2Fwww.example.com%2F?access_token=oauth2-token

תשובה:

קוד מצב 204 של HTTP (ללא תוכן), המציין הצלחה.