ProductStatuses リソース

[アーティクル]
10/04/2023

注:

ストアリソースは、クローズドベータ参加者のみが使用できます。クローズドベータプログラムまたはオープンベータプログラムへの参加については、アカウントマネージャーにお問い合わせください。

すべてのストアプログラミング要素とドキュメントは、ベータ期間中に変更される可能性があります。

ProductStatuses リソースを使用して、ストア内の製品オファーの状態を取得します。

ベース URI

テンプレートを追加するベース URI を次に示します。

https://content.api.ads.microsoft.com/v9.1/bmc

たとえば、ストア内の製品オファーの状態の概要ビューを取得するには、次のエンドポイントを使用します。

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

テンプレート

これらは、HTTP エンドポイントを作成するためにベース URI に追加するテンプレートです。

/stores/{merchantId}/productstatusessummary

HTTP 動詞	説明	リソース
取得	ストア内の製品オファーの状態の概要ビューを取得します。このサービスは、ストアで承認、不承認、期限切れになったオファーの数を返します。状態を取得するストアの ID に設定 `{merchantId}` します。オファーの状態が変化してからサマリービューに反映されるまでに最大で 2 時間かかることがあります。	要求: N/A 応答: ProductStatusesSummary

/stores/{merchantId}/productstatuses

HTTP 動詞	説明	リソース
取得	ストア内の製品オファーの状態の詳細ビューを取得します。詳細は、ステータスが [不承認] または [警告] の製品に対してのみ返されます。状態を取得するストアの ID に設定 `{merchantId}` します。 max-results クエリパラメーターは、サービスから返されるオファーの数を決定します。すべてのオファーをページングするには、継続トークンクエリパラメーターを使用します。	要求: N/A 応答: ProductStatuses

クエリパラメーター

要求には、次のクエリパラメーターが含まれる場合があります。

パラメーター説明

max-results オプション。を使用して、などの /stores/{merchantId}/productstatusesList 要求で返す項目の最大数を指定します。指定できる最大値は 250 です。既定値は 25 です。

continuation-token オプション。を使用して、ストアの製品ステータスの一覧を表示します。トークンは、返される製品の状態の次のページを識別します。最初の List 要求では、このパラメーターを指定しないでください。ストアに要求された製品数を超える製品が含まれている場合 ( max-results クエリパラメーターを参照)、応答にはフィールドが nextPageToken 含まれます。次の要求で、 継続トークン をのトークン値に nextPageToken設定します。

パラメーター	説明
max-results	オプション。を使用して、などの `/stores/{merchantId}/productstatuses`List 要求で返す項目の最大数を指定します。指定できる最大値は 250 です。既定値は 25 です。
continuation-token	オプション。を使用して、ストアの製品ステータスの一覧を表示します。トークンは、返される製品の状態の次のページを識別します。最初の List 要求では、このパラメーターを指定しないでください。ストアに要求された製品数を超える製品が含まれている場合 ( max-results クエリパラメーターを参照)、応答にはフィールドが `nextPageToken` 含まれます。次の要求で、継続トークンをのトークン値に `nextPageToken`設定します。

ヘッダー

要求ヘッダーと応答ヘッダーを次に示します。

ヘッダー	説明
AuthenticationToken	要求ヘッダー。このヘッダーを OAuth アクセストークンに設定します。アクセストークンの取得については、「資格情報の認証」を参照してください。
Content-Type	要求ヘッダー。すべての POST 要求でこのヘッダーを指定する必要があり、をに設定する `application/json`必要があります。
CustomerAccountId	要求ヘッダー。ヘッダーで `CustomerId` 指定された顧客に代わって管理する任意のアカウントのアカウント ID。指定したアカウントは関係ありません。このヘッダーは、顧客の代わりにアカウントを管理する場合にのみ指定します。
Customerid	要求ヘッダー。ストアを管理する顧客の顧客 ID。このヘッダーは、顧客の代わりにストアを管理する場合にのみ指定します。このヘッダーを設定する場合は、ヘッダーも設定する `CustomerAccountId` 必要があります。
DeveloperToken	要求ヘッダー。クライアントアプリケーションの開発者トークン。各要求には、このヘッダーを含める必要があります。トークンの取得の詳細については、「Microsoft Advertising の資格情報と開発者トークンはありますか?」を参照してください。
WebRequestActivityId	応答ヘッダー。要求の詳細を含むログエントリの ID。エラーが発生した場合は、常にこの ID をキャプチャする必要があります。問題を特定して解決できない場合は、この ID をサポートチームに提供する他の情報と共に含めます。

要求オブジェクトと応答オブジェクト

API で使用される要求オブジェクトと応答オブジェクトを次に示します。

オブジェクト	説明
Error	エラーを定義します。
ErrorResponse	最上位レベルのエラーオブジェクトを定義します。
ProductStatus	製品オファーの状態を定義します。
ProductStatuses	問題がある製品オファーの一覧を定義します。
ProductStatusesSummary	ストア内の製品オファーの状態の概要ビューを定義します。
ProductStatusItemLevelIssue	製品オファーに関する問題を定義します。

エラー

エラーを定義します。

名前	値	型
code	要求が失敗した理由。	String
message	エラーの説明。	String

ErrorResponse

最上位レベルのエラーオブジェクトを定義します。

名前	値	型
エラー	要求の処理中に発生したエラーの一覧。	エラー[]

ProductStatus

製品オファーの状態を定義します。

名前	値	型
Creationdate	製品オファーが作成された日時。	DateTime
expirationDate	製品オファーが期限切れに設定されている日付と時刻。	DateTime
itemLevelIssues	製品オファーに関する問題の一覧。	ProductStatusItemLevelIssue[]
lastUpdateDate	製品オファーが最後に更新された日時。	DateTime
Productid	製品の ID。	String
status	製品の承認状態。使用可能な値は次のとおりです。不承認警告不承認の製品は提供されません。警告は、製品に対処する必要がある問題があることを示しますが、製品オファーが提供されるのを妨げるわけではありません。問題を修正し、製品オファーを再送信する必要があります。	String
title	製品のタイトル	String