メソッド: ampUrls.batchGet

AMP URL と対応する AMP キャッシュ URL を返します。

HTTP リクエスト

POST https://acceleratedmobilepageurl.googleapis.com/v1/ampUrls:batchGet

この URL は Google API HTTP アノテーション構文を使用します。

リクエストの本文

リクエストの本文には次の構造のデータが含まれます。

JSON 表現 

{
  "urls": [
    string
  ]
  "lookupStrategy": enum(LookupStrategy),
}
項目
urls[]

string

ペア設定された AMP URL をルックアップするための URL のリスト。URL の大文字と小文字は区別されます。1 回で最大 50 個の URL をルックアップできます（使用制限を参照）。
lookupStrategy

enum(LookupStrategy)

リクエスト対象の lookupStrategy。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

AMP URL のバッチ レスポンス。

JSON 表現 

{
  "ampUrls": [
    {
      object(AmpUrl)
    }
  ],
  "urlErrors": [
    {
      object(AmpUrlError)
    }
  ],
}
項目
ampUrls[]

object(AmpUrl)

BatchAmpUrlsRequest の各 URL に対する URL レスポンス。レスポンスはバッチ リクエストの URL の順序と同じにならない場合があります。BatchAmpUrlsRequest に重複する URL が含まれている場合、AmpUrl は一度だけ生成されます。
urlErrors[]

object(AmpUrlError)

リクエストの URL に AMP URL が含まれていないエラー。

LookupStrategy

列挙型
FETCH_LIVE_DOC FETCH_LIVE_DOC 戦略では、インデックス内に見つからない URL のライブ ドキュメントの取得が行われます。インデックス内に見つからないリクエスト URL はすべてリアルタイムでクロールされ、対応する AMP URL が存在するかどうかが検証されます。この戦略の範囲は広範にわたりますが、リアルタイムのクロールによって余分な遅延が生じます。これがデフォルトの戦略です。この戦略を使用するアプリでは、API 呼び出しの HTTP タイムアウトを長く設定する必要があります。
IN_INDEX_DOC IN_INDEX_DOC 戦略では、インデックス内に見つからない URL のライブ ドキュメントの取得がスキップされます。低遅延が求められるアプリでは、IN_INDEX_DOC 戦略を使用することをおすすめします。

AmpUrl

リクエストの URL に対する AMP URL レスポンス。

JSON 表現 

{
  "originalUrl": string,
  "ampUrl": string,
  "cdnAmpUrl": string,
}
項目
originalUrl

string

元の非 AMP URL。
ampUrl

string

サイト運営者のウェブサーバーを指す AMP URL。

cdnAmpUrl

string

Google AMP Cache 内にキャッシュされたドキュメントを指す AMP Cache URL。

AmpUrlError

リクエストの URL が見つからなかった場合の AMP URL エラーのリソース。

JSON 表現 

{
  "errorCode": enum(ErrorCode),
  "errorMessage": string,
  "originalUrl": string,
}
項目
errorCode

enum(ErrorCode)

API 呼び出しのエラーコード。
errorMessage

string

説明的なエラー メッセージ（オプション）。
originalUrl

string

元の非 AMP URL。

ErrorCode

AMP URL のバッチ ルックアップのエラーコード。

列挙型
ERROR_CODE_UNSPECIFIED 未指定のエラー。
INPUT_URL_NOT_FOUND リクエストの URL がインデックス内に見つからないことを示します。原因としては、URL が見つからない、Googlebot がアクセスできない、その他のなんらかのエラーが考えられます。
NO_AMP_URL リクエストの URL に対応する AMP URL が見つからなかったことを示します。
APPLICATION_ERROR サーバーでなんらかのアプリケーション エラーが発生し、クライアントから再試行するよう忠告されたことを示します。
URL_IS_VALID_AMP 廃止: リクエストの URL が有効な AMP URL であることを示します。これはエラー状態ではないため、成功または失敗のしるしとして使用しないでください。このエラーコードは API の将来のバージョンで削除される予定です。
URL_IS_INVALID_AMP リクエスト URL に対応する AMP URL が見つかったものの、有効な AMP HTML ではないことを示します。

試してみる