Method: projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus

ドメインの所有権の証明ステータスを含むターゲット サイトのリストを返します。このメソッドは、現時点では BASIC_SITE_SEARCH 状態のデータストアでのみ呼び出すことができます。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
siteSearchEngine

string

必須。すべてのドメイン所有権確認のステータスを取得するサイト検索エンジン リソース。projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine。

クエリ パラメータ

パラメータ
pageSize

integer

リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。

このフィールドが負の数の場合、INVALID_ARGUMENT エラーが返されます。
pageToken

string

前回の siteSearchEngine.fetchDomainVerificationStatus 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、siteSearchEngine.fetchDomainVerificationStatus に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

SiteSearchEngineService.FetchDomainVerificationStatus メソッドに対するレスポンス メッセージ。

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

JSON 表現 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
フィールド
targetSites[]

object (TargetSite)

サイトの確認ステータスを含む TargetSite のリスト。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
totalSize

integer

リクエストに一致するアイテムの総数。この値はレスポンスに常に入力されます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

siteSearchEngine リソースに対する次の IAM 権限が必要です。

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

詳細については、IAM のドキュメントをご覧ください。