このガイドでは、RTB のトラブルシューティングに関するリソースについて説明します。これらのリソースは、
リアルタイム入札キャンペーンの指標も
RTB 解析ツール(
認定バイヤーの管理画面をご覧ください。これには、bidders.filterSets
、bidders.accounts.filterSets
、
その下のすべてのリソースが階層化されます。
RTB のトラブルシューティング リソースから得られる指標を使用して、逃した機会に関するインサイトを得る インプレッションを獲得して、リアルタイム ビッダー キャンペーンの最適化に役立てることができます。
API の構造とスタイルの変更
RTB のトラブルシューティング リソースには、所有権を明示的に示し、 API から返されるデータをより詳細に制御して、 Google API の設計プラクティス。
ビッダーレベルとアカウント単位のリソース
リソースは bidders
と bidders.accounts
の両方で構造化されています。これを使用すると
API 呼び出しがビッダー(親アカウント)をターゲットとしているかどうかと、関連付けられているすべての
子アカウントまたは個々の認定バイヤーアカウントで
管理できますRTB のコンテキスト
トラブルシューティング。bidders.filterSets
で構造化されたリソースは、集計された指標を返します
対象となるすべての子アカウントの
エンティティが表示されますこれに対して
bidders.accounts.filterSets
は、指定したアカウントの指標のみを返します。指標には
ビッダーと子アカウントのどちらであるかも指定できます。
注: 別の購入者に入札を委任しているアカウントはビッダー アカウントではありません。
ビッダーレベルのリソースにアクセスできません。また、入札者以外のアカウントで
アカウント単位のimpressionMetrics
、filteredBidResponses
、bidResponseErrors
、
bidResponsesWithoutBids
個のリソース。
一意の識別子としてのリソース名の導入
リソース名は、 整数や文字列の ID ではなく、一意の識別子を使用します。特定のインスタンスの新しいインスタンスを 使用する場合は、Terraform Registry の 相対 リソースの URI パスの後に優先リソース ID を付加したものを使用します。「 RTB トラブルシューティングのリソースに関連する名前の例を次に示します。
リソース | 名前の例 |
---|---|
bidders.filterSets | bidders/12345678/filterSets/fset_1 |
bidders.accounts.filterSets | bidders/12345678/accounts/87654321/filterSets/fset_2 |
注: 名前の bidders
に指定されたリソース ID は、ビッダーの ID である必要があります
認定バイヤーのアカウント ID。accounts
の場合、リソース ID は次のいずれかのアカウント ID にする必要があります。
そのビッダーが管理している子アカウント。どの認定バイヤーが
Google アカウントに関連付けられている場合は、
accounts.list メソッドで確認できます。
フィルタセット
フィルタセットは、使用可能なフィルタ オプションを表し、 追加することもできますRTB トラブルシューティングの結果の一覧をフィルタリングするために使用します。 リアルタイム ビッダー キャンペーンの指標を取得するリソースです。
指標の取得時に適用されるフィルタは、指定した
フィルタセットを指定しますリストフィルタ(platforms
など)は、リスト内の各項目の結合として解釈されます。
入札者(ビッダー)とアカウント単位のフィルタセットは区別され、 作成に使用されたアカウントに関係なく、一意の ID が生成されます。ビッダーと子アカウントの共有 フィルタセットはアカウント レベルで作成されますが、ビッダーのみが 有効にします次の表は、ビッダー アカウントと子アカウントがリソースにアクセスする方法をまとめたものです。 次のどちらかのレベルに設定できます
bidders.filterSets | bidders.accounts.filterSets | |
---|---|---|
ビッダー アカウント | ビッダーレベルのフィルタセットにのみ影響する API 呼び出し。 | アカウント レベルのフィルタセットにのみ影響する API 呼び出し。 |
お子様のアカウント | この API 呼び出しではエラー レスポンスが返されます。 | アカウント レベルのフィルタセットにのみ影響する API 呼び出し。 |
フィルタセットを作成する
フィルタセットを作成するときは、期間を relativeDateRange
、
absoluteDateRange
または realtimeTimeRange
。指標を取得する際、
デフォルトの動作では、期間全体のすべてのデータが提供されます。メッセージを受け取る
期間にわたる時系列の内訳。timeSeriesGranularity
を指定できます。
HOURLY
または DAILY
間隔を示します。
フィルタ設定を短期間のみ必要な場合は、isTransient
クエリ パラメータを true
に設定します。これは、フィルタセットが一時的なもの、つまり無期限に存続しないことを示します。一時的なフィルタセットは、作成後少なくとも 1 時間は利用できますが、最終的に削除されます。デフォルトでは、フィルタセットは一時的なものではありません。
ビッダーレベルの例
入札者レベルの新しいフィルタセットを作成するには、bidders.filterSets
リソース URI に次の形式の POST
リクエストを送信します。
https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/filterSets
警告: ビッダーレベルのフィルタセットでは、クリエイティブ ID や取引 ID によるフィルタは使用できません。ビッダーレベルのフィルタセットを作成する際にこれらのフィルタを指定すると、エラーが返されます。
リクエスト一時的でないビッダーレベルのフィルタセットを作成する POST
リクエストの例を次に示します。
POST https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/filterSets Authorization: Bearer access token here Content-Type: application/json { "name": "bidders/12345678/filterSets/bidder-fs", "format": "DISPLAY", "environment": "APP", "platforms": ["TABLET", "MOBILE"], "absoluteDateRange": { "startDate": { "month": 11, "day": 26, "year": 2017 }, "endDate": { "month": 12, "day": 3, "year": 2017 } }, "timeSeriesGranularity": "DAILY" }
リクエストが成功すると、サーバーはレスポンスとして 200 OK ステータス コードを返します。レスポンスの本文には、作成されたフィルタセット リソースが含まれます。これは、リクエストで送信されたフィルタセットと同じものです。
アカウント単位の例
アカウント単位のフィルタセットを新規作成するには、POST
リクエストを
bidders.accounts.filterSets
リソース URI。次の形式になります。
https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/accounts/{account resource ID}/filterSets
注: accounts
に指定されたリソース ID は、
ビッダーがアクセスできる認定バイヤー アカウントのアカウント ID
URI で指定されたアカウント(ビッダー アカウント自体も含まれます)
次に示すのは、一時的ではないアカウント単位のフィルタセットを作成する POST
リクエストの例です。
POST https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/accounts/87654321/filterSets Authorization: Bearer access token here Content-Type: application/json { "name": "bidders/12345678/accounts/87654321/filterSets/account-fs", "format": "VIDEO", "environment": "WEB", "platforms": ["DESKTOP"], "absoluteDateRange": { "startDate": { "month": 11, "day": 26, "year": 2017 }, "endDate": { "month": 12, "day": 3, "year": 2017 } }, "timeSeriesGranularity": "DAILY" }
リクエストが成功すると、サーバーはレスポンスとして 200 OK ステータス コードを返します。レスポンス本文は 作成されたフィルタセット リソースが含まれます。このリソースは、 表示されます。
フィルタセットを取得する
get メソッドでは、作成されたフィルタセットのみを取得できます。たとえばビッダーは
アカウントでは、bidders.accounts.filterSets.get
を使用してアカウントで作成されたフィルタセットを取得する必要がある
bidders.filterSets.get
メソッドよりも効率的です。
ビッダーレベル
ビッダーレベルのフィルタセットを取得するには、次のような形式の HTTP GET リクエストを bidders.filterSets
リソース URI に送信します。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/filterSets/{filter set resource ID}
次の例をご覧ください。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/filterSets/bidder-fs
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと取得したフィルタセットを返します。
{ "name": "bidders/12345678/filterSets/bidder-fs", "format": "DISPLAY", "environment": "APP", "platforms": ["TABLET", "MOBILE"], "absoluteDateRange": { "startDate": { "month": 11, "day": 26, "year": 2017 }, "endDate": { "month": 12, "day": 3, "year": 2017 } }, "timeSeriesGranularity": "DAILY" }
アカウント単位
アカウント単位のフィルタセットを取得するには、次の形式の HTTP GET
リクエストを bidders.accounts.filterSets
リソース URI に送信します。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/accounts/{account resource ID}/filterSets/{filter set resource ID}
次の例をご覧ください。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/accounts/87654321/filterSets/account-fs
リクエストが成功すると、サーバーは 200 OK
HTTP ステータス コードと取得したフィルタセットを返します。
{ "name": "bidders/12345678/accounts/87654321/filterSets/account-fs", "format": "VIDEO", "environment": "WEB", "platforms": ["DESKTOP"], "absoluteDateRange": { "startDate": { "month": 11, "day": 26, "year": 2017 }, "endDate": { "month": 12, "day": 3, "year": 2017 } }, "timeSeriesGranularity": "DAILY" }
フィルタセットを一覧表示する
list メソッドは、呼び出されているレベルからアクセス可能なフィルタセットのみを返します。
たとえば、ビッダーのアカウントには、
bidders.filterSets.list
の呼び出し時に bidders.accounts.filterSets.create
。
ビッダーレベル
HTTP GET
を送信することで、特定のビッダーについてビッダーレベルのすべてのフィルタセットを取得できます。
次の形式の bidders.filtersets
リソース URI に送信します。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/filterSets
次の例では、アカウント ID が 12345678 のビッダーについて、ビッダー単位のフィルタセットがすべて一覧表示されます。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/filterSets
{ "filterSets": [{ "filterSetId": "99994", "name": "bidders/12345678/filterSets/test-b-1", "relativeDateRange": { "durationDays": 30 } }, { "realtimeTimeRange": { "startTimeStamp": "2017-11-15T12:30:30.072831583Z" }, "filterSetId": "99995", "name": "bidders/12345678/filterSets/test-b-2", "timeSeriesGranularity": "HOURLY" }, { "absoluteDateRange": { "endDate": { "day": 12, "month": 3, "year": 2017 }, "startDate": { "day": 26, "month": 11, "year": 2017 } }, "filterSetId": "99996", "name": "bidders/12345678/filterSets/bidder-fs", "timeSeriesGranularity": "DAILY", "platforms": ["TABLET", "MOBILE"], "environment": "APP", "format": "DISPLAY" } ] }
アカウント単位
HTTP GET
を送信することで、特定のアカウントについてアカウント単位のすべてのフィルタセットを取得できます。
次の形式の bidders.accounts.filtersets
リソース URI に送信します。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/accounts/{account resource ID}/filterSets
次の例では、アカウント ID が 87654321 の子アカウントについて、アカウント単位のフィルタセットをすべて一覧表示しています。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/accounts/87654321/filterSets
{ "filterSets": [{ "realtimeTimeRange": { "startTimeStamp": "2017-11-19T04:24:43.252893487Z" }, "filterSetId": "99997", "name": "bidders/12345678/accounts/87654321/filterSets/test-a-1", "timeSeriesGranularity": "DAILY" }, { "absoluteDateRange": { "endDate": { "day": 3, "month": 12, "year": 2017 }, "startDate": { "day": 26, "month": 11, "year": 2017 } }, "filterSetId": "99998", "name": "bidders/12345678/accounts/87654321/filterSets/account-fs", "timeSeriesGranularity": "DAILY", "platforms": ["DESKTOP"], "environment": "WEB", "format": "VIDEO" } ] }
フィルタセットを削除する
delete
メソッドを使用して、一時的なものではないフィルタセットを削除できます。
時間が長くなります。呼び出されているレベルからアクセス可能なフィルタセットのみを削除できます。
たとえば、ビッダー アカウントでは bidders.accounts.filterSets.create
で作成されたフィルタセットを削除できません
bidders.filterSets.delete
に置き換えます。
ビッダーレベル
特定のアカウントに設定されたビッダーレベルのフィルタを削除するには、HTTP DELETE
リクエストを送信します
次の形式を持つ bidders.filtersets
リソース URI にマッピングします。
DELETE https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/filterSets/{filter set resource ID}
ビッダー単位のフィルタセットを削除する例を次に示します。
DELETE https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/filterSets/test-b-2
成功すると、リクエスト本文は空になります。指定したフィルタセットにはアクセスできなくなります。
アカウント単位
特定のアカウントに設定されたアカウント単位のフィルタを削除するには、HTTP DELETE
を送信します
次の形式の bidders.accounts.filtersets
リソース URI に送信します。
DELETE https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/accounts/{account resource ID}/filterSets/{filter set resource ID}
次に、アカウント単位のフィルタセットを削除する例を示します。
DELETE https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/accounts/87654321/filterSets/test-a-1
成功すると、リクエスト本文は空になります。指定したフィルタセットにはアクセスできなくなります。
RTB トラブルシューティングの指標を取得する
指標を取得するために使用する RTB のトラブルシューティング リソースもすべて同じように機能します。
filterSetName
パスで指定されたフィルタセットの指標を一覧表示する単一のメソッド
パラメータを指定します。指定したフィルタセットによって、いつ適用されるフィルタと設定が決まります
実行することもできます。ビッダーレベルでこれらのリソースを呼び出すと、集計指標が返されます
ビッダーのアカウントとそれに関連するすべての子アカウントから
個々のアカウントの指標のみが返されます。
入札単価の指標
bidMetrics
リソースは、特定の期間で測定された指標を取得するために使用されます。
決定しますたとえば、1 日を通しての入札の総数を
特定の期間、オークションで除外されなかったインプレッションを
獲得したインプレッションの数、
指標の収集に使用する他の RTB トラブルシューティング リソースと同様に、list
メソッドのみが含まれています。
ビッダーレベルの入札指標を一覧表示する
HTTP GET
を送信することで、特定のフィルタセットに対するビッダーレベルの入札指標を一覧表示できます。
次の形式の bidders.filtersets.bidMetrics
リソース URI に送信します。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/filterSets/{filter set resource ID}/bidMetrics
以下は、ビッダーレベルの入札指標を一覧表示する例です。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/filterSets/bidder-fs/bidMetrics
リクエストが成功すると、サーバーは 200 OK
ステータス コードと、指定した分割項目と粒度の指標行を含む本文を返します。
{ "bidMetricsRows": [{ "bids": { "value": "6160" }, "bidsInAuction": { "value": "5698" }, "billedImpressions": { "value": "1196" }, "impressionsWon": { "value": "2920" }, "measurableImpressions": { "value": "1160" }, "rowDimensions": { "timeInterval": { "endTime": "2017-11-29T08:00:00Z", "startTime": "2017-11-28T08:00:00Z" } }, "viewableImpressions": { "value": "683" } }, { "bids": { "value": "104288" }, "bidsInAuction": { "value": "94016" }, "billedImpressions": { "value": "99" }, "impressionsWon": { "value": "125" }, "measurableImpressions": { "value": "94" }, "rowDimensions": { "timeInterval": { "endTime": "2017-11-30T08:00:00Z", "startTime": "2017-11-29T08:00:00Z" } }, "viewableImpressions": { "value": "87" } }, { "bids": { "value": "3999" }, "bidsInAuction": { "value": "3631" }, "billedImpressions": { "value": "618" }, "impressionsWon": { "value": "1819" }, "measurableImpressions": { "value": "604" }, "rowDimensions": { "timeInterval": { "endTime": "2017-12-01T08:00:00Z", "startTime": "2017-11-30T08:00:00Z" } }, "viewableImpressions": { "value": "369" } }, { "bids": { "value": "15" }, "bidsInAuction": { "value": "3" }, "billedImpressions": {}, "impressionsWon": { "value": "3" }, "measurableImpressions": {}, "rowDimensions": { "timeInterval": { "endTime": "2017-12-02T08:00:00Z", "startTime": "2017-12-01T08:00:00Z" } }, "viewableImpressions": {} } ] }
注: 特定の指標で 0 に設定されているフィールドはレスポンスに表示されません。
上の空の billedImpressions
指標と measurableImpressions
指標
値と分散の両方が 0 に設定されていることを示しています。
警告: レスポンスのデータの内訳については、レスポンスは
ゼロ以外の指標が 1 つも含まれていない場合は行を含める。たとえば、
timeSeriesGranularity
が指定されている場合、レスポンスには
フィルタセットで指定された期間全体(すべての指標がゼロ)の timeInterval
。
アカウント単位の入札単価の指標を一覧表示する
HTTP GET
を送信することで、特定のフィルタセットに対するアカウント単位の入札指標を一覧表示できます。
bidders.accounts.filtersets.bidMetrics
リソース URI。この URI には、
次の形式にします。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/{bidder resource ID}/accounts/{account resource ID}/filterSets/{filter set resource ID}/bidMetrics
以下は、アカウント単位の入札単価の指標を一覧表示する例です。
GET https://adexchangebuyer.googleapis.com/v2beta1/bidders/12345678/accounts/87654321/filterSets/account-fs/bidMetrics
リクエストが成功すると、サーバーは 200 OK
ステータス コードと、指定した分割項目と粒度の指標行を含む本文を返します。
{ "bidMetricsRows": [{ "bids": { "value": "1748" }, "bidsInAuction": { "value": "1421" }, "billedImpressions": { "value": "301" }, "impressionsWon": { "value": "915" }, "measurableImpressions": { "value": "298" }, "rowDimensions": { "timeInterval": { "endTime": "2017-12-01T08:00:00Z", "startTime": "2017-11-30T08:00:00Z" } }, "viewableImpressions": { "value": "172" } }, { "bids": { "value": "6" }, "bidsInAuction": { "value": "2" }, "billedImpressions": {}, "impressionsWon": { "value": "1" }, "measurableImpressions": {}, "rowDimensions": { "timeInterval": { "endTime": "2017-12-02T08:00:00Z", "startTime": "2017-12-01T08:00:00Z" } }, "viewableImpressions": {} } ] }
注: 特定の指標で 0 に設定されているフィールドはレスポンスに表示されません。「
上の空の billedImpressions
と measurableImpressions
の指標は、
値と分散の両方が 0 に設定されていることを確認できます。
警告: レスポンスのデータの内訳では、レスポンスには含まれません。
0 以外の指標が 1 つも含まれていない場合はたとえば、
timeSeriesGranularity
が指定されている場合、レスポンスには
フィルタセットで指定された期間全体(すべての指標がゼロ)の timeInterval
。