Reminder: v201708 will be sunset on August 31, 2018.

AdX Seller REST API から移行する

DoubleClick for Publishers では、SOAP API を使って、LineItems といった入稿エンティティについてレポート作成と操作の両方を行うことができます。 クライアント ライブラリも複数の言語で利用可能です。AdX Seller API と同様に、DFP API での認証には OAuth 2.0 が使用されます。

最初の API リクエストを設定するにあたっては、スタートガイドをご覧ください。

DFP API でレポートを作成する

DFP API の ReportService では、レポートの実行とダウンロードを次の 2 つの方法で行うことができます。

  1. 管理画面でクエリを作成し、その ID に基づいてクエリを実行する。
  2. 1 回限り(アドホック)の ReportQuery を作成する。

いずれの方法でも、API の処理は次の 4 段階で行うことになります。

  1. runReportJob を呼び出します。
  2. getReportJobStatus を使ってレポートのステータスを取得します。
  3. getReportDownloadUrlWithOptions を使って、完成したレポートの URL を取得します。
  4. 返された URL からレポートをダウンロードします。

詳しくは、レポート機能のガイドをご覧ください。

レポートのタイムゾーン

Ad Exchange Seller REST API とは異なり、DFP API レポートではデフォルトでネットワークのタイムゾーンが使用されます。タイムゾーンを変更するには、TimeZoneType フィールドを設定します。

古い API のバージョンでは、このフィールドは使用できません。タイムゾーンは API のバージョンによって決まります。詳しくは下記の表をご覧ください。

バージョン Ad Exchange レポートのタイムゾーン DFP レポートのタイムゾーン
201802 TimeZoneType で指定されたタイムゾーン TimeZoneType で指定されたタイムゾーン
201711 米国太平洋標準時間(PST) ネットワークのタイムゾーン
201708 ネットワークのタイムゾーン ネットワークのタイムゾーン
201705 ネットワークのタイムゾーン ネットワークのタイムゾーン

AdX と DFP の指標およびディメンションの対応表

Ad Exchange Seller REST API でサポートされている指標とディメンションはすべて、DFP Reporting API v201705 以降で利用できます。ただし、名前が変わったものとサポートが終了したものがあります。詳しくは下記の表をご覧ください。

指標 / 表示項目

Ad Exchange の指標と DFP の表示項目の対応表を以下に示します。

AdX の指標DFP の表示項目DFP クエリツールの項目名
ACTIVE_VIEW_ELIGIBLE_COUNT AD_EXCHANGE_ACTIVE_VIEW_ENABLED_IMPRESSIONS アクティブ ビュー対象インプレッション数
ACTIVE_VIEW_MEASURABLE_COUNT AD_EXCHANGE_ACTIVE_VIEW_MEASURED_IMPRESSIONS アクティブ ビュー測定インプレッション数
ACTIVE_VIEW_MEASURABLE_RATIO (サポート終了) (サポート終了)
ACTIVE_VIEW_VIEWABLE_COUNT AD_EXCHANGE_ACTIVE_VIEW_VIEWED_IMPRESSIONS アクティブ ビュー視認インプレッション数
ACTIVE_VIEW_VIEWABLE_RATIO (サポート終了) (サポート終了)
ACTIVE_VIEW_VIEWABLE_TIME AD_EXCHANGE_AVERAGE_VIEWABLE_TIME 平均視認可能時間(秒)
AD_IMPRESSIONS AD_EXCHANGE_IMPRESSIONS 広告のインプレッション数
AD_IMPRESSIONS_RPM AD_EXCHANGE_AD_ECPM 広告 eCPM
AD_REQUESTS AD_EXCHANGE_AD_REQUESTS 広告リクエスト数
AD_REQUESTS_COVERAGE AD_EXCHANGE_COVERAGE カバレッジ
AD_REQUESTS_CTR AD_EXCHANGE_AD_REQUEST_CTR 広告リクエスト CTR
AD_REQUESTS_RPM AD_EXCHANGE_AD_REQUEST_ECPM 広告リクエスト RPM
CLICKS AD_EXCHANGE_CLICKS クリック数
COST_PER_CLICK AD_EXCHANGE_CPC CPC
DEALS_AD_REQUESTS AD_EXCHANGE_DEALS_AD_REQUESTS 取引の広告リクエスト数
DEALS_BID_RESPONSES AD_EXCHANGE_DEALS_BID_RESPONSES 取引の入札レスポンス
DEALS_MATCH_RATE AD_EXCHANGE_DEALS_MATCH_RATE 取引の一致率
DEALS_MATCHED_REQUESTS AD_EXCHANGE_DEALS_MATCHED_REQUESTS 一致した取引リクエスト
EARNINGS AD_EXCHANGE_ESTIMATED_REVENUE 推定収益
INDIVIDUAL_AD_IMPRESSIONS (サポート終了) (サポート終了)
INDIVIDUAL_AD_IMPRESSIONS_CTR AD_EXCHANGE_AD_CTR 広告 CTR
INDIVIDUAL_AD_IMPRESSIONS_RPM (今後推奨) AD_EXCHANGE_AD_ECPM (今後推奨)広告 eCPM
LIFT_RATE AD_EXCHANGE_LIFT 伸び
MATCHED_AD_REQUESTS AD_EXCHANGE_MATCHED_REQUESTS 一致したリクエスト
MATCHED_AD_REQUESTS_CTR AD_EXCHANGE_CTR クリック率
MATCHED_AD_REQUESTS_RPM AD_EXCHANGE_MATCHED_ECPM 一致した eCPM
VIDEO_AD_ABANDONMENT_RATIO AD_EXCHANGE_VIDEO_ABANDONMENT_RATE 動画の放棄率
VIDEO_AD_DROPOFF_RATIO AD_EXCHANGE_VIDEO_DROPOFF_RATE 動画の離脱率
VIDEO_AD_QUARTILE_ONE AD_EXCHANGE_VIDEO_QUARTILE_1 動画の 25%
VIDEO_AD_QUARTILE_THREE AD_EXCHANGE_VIDEO_QUARTILE_3 動画の 75%
VIDEO_AD_SKIPPABLE_SKIP_RATIO AD_EXCHANGE_VIDEO_TRUEVIEW_SKIP_RATE TrueView のスキップ率
VIDEO_AD_SKIPPABLE_VIEWS AD_EXCHANGE_VIDEO_TRUEVIEW_VIEWS TrueView 視聴数
VIDEO_AD_SKIPPABLE_VTR AD_EXCHANGE_VIDEO_TRUEVIEW_VTR TrueView VTR

ディメンション

Ad Exchange のディメンションと DFP のディメンションの対応表を以下に示します。

AdX のディメンションDFP のディメンションDFP クエリツールの項目名
AD_CLIENT_ID AD_EXCHANGE_WEB_PROPERTY_CODE ウェブ プロパティ
AD_LOCATION AD_EXCHANGE_AD_LOCATION 広告掲載位置
AD_TAG_NAME AD_EXCHANGE_TAG_NAME タグ
AD_UNIT_SIZE_CODE AD_EXCHANGE_INVENTORY_SIZE_CODE (利用不可)
AD_UNIT_SIZE_NAME AD_EXCHANGE_INVENTORY_SIZE 広告枠のサイズ
ADVERTISER_DOMAIN AD_EXCHANGE_ADVERTISER_DOMAIN 広告主のドメイン
ADVERTISER_NAME AD_EXCHANGE_ADVERTISER_NAME 広告主
ADVERTISER_VERTICAL AD_EXCHANGE_ADVERTISER_VERTICAL 広告主のカテゴリ
AGENCY_NAME AD_EXCHANGE_AGENCY 代理店
BID_TYPE_CODE AD_EXCHANGE_BID_TYPE_CODE (利用不可)
BRAND_NAME AD_EXCHANGE_BRAND_NAME ブランド
BRANDING_TYPE_CODE AD_EXCHANGE_BRANDING_TYPE_CODE (利用不可)
BRANDING_TYPE_NAME AD_EXCHANGE_BRANDING_TYPE ブランディング タイプ
BUYER_NETWORK_ID AD_EXCHANGE_BUYER_NETWORK_ID (利用不可)
BUYER_NETWORK_NAME AD_EXCHANGE_BUYER_NETWORK_NAME 購入者ネットワーク
COUNTRY_CODE AD_EXCHANGE_COUNTRY_CODE (利用不可)
COUNTRY_NAME AD_EXCHANGE_COUNTRY_NAME
CREATIVE_SIZE AD_EXCHANGE_CREATIVE_SIZES クリエイティブのサイズ
CUSTOM_CHANNEL_CODE AD_EXCHANGE_CUSTOM_CHANNEL_CODE (利用不可)
CUSTOM_CHANNEL_ID AD_EXCHANGE_CUSTOM_CHANNEL_ID (利用不可)
CUSTOM_CHANNEL_NAME AD_EXCHANGE_CHANNEL_NAME チャネル
DATE AD_EXCHANGE_DATE
DEAL_ID AD_EXCHANGE_DEAL_ID 取引 ID
DEAL_NAME AD_EXCHANGE_DEAL_NAME 取引名
DFP_AD_UNIT_ID AD_EXCHANGE_DFP_AD_UNIT_ID (利用不可)
DFP_AD_UNITS AD_EXCHANGE_DFP_AD_UNIT DFP 広告ユニット
DFP_REQUEST_SOURCE AD_EXCHANGE_REQUEST_SOURCES リクエスト元
DOMAIN_NAME AD_EXCHANGE_SITE_NAME サイト
DSP_NAME AD_EXCHANGE_DSP_BUYER_NETWORK_NAME DSP
EXPANSION_TYPE_NAME AD_EXCHANGE_EXPANSION_TYPE エキスパンド タイプ
INVENTORY_OWNERSHIP AD_EXCHANGE_INVENTORY_OWNERSHIP 広告枠の所有権
INVENTORY_PARTNER_NAME AD_EXCHANGE_NETWORK_PARTNER_NAME ネットワーク パートナー名
MOBILE_APP_NAME AD_EXCHANGE_MOBILE_APP_NAME アプリ名
MOBILE_CARRIER_NAME AD_EXCHANGE_MOBILE_CARRIER_NAME 携帯通信会社名
MOBILE_DEVICE_NAME AD_EXCHANGE_MOBILE_DEVICE_NAME デバイス
MOBILE_INVENTORY_TYPE AD_EXCHANGE_MOBILE_INVENTORY_TYPE 広告枠タイプ
MOBILE_OS_VERSION AD_EXCHANGE_OPERATING_SYSTEM オペレーティング システム
MOBILE_USER_BANDWIDTH AD_EXCHANGE_USER_BANDWIDTH_NAME 帯域幅
MONTH AD_EXCHANGE_MONTH
PLATFORM_TYPE_NAME AD_EXCHANGE_DEVICE_CATEGORY デバイス カテゴリ
PRODUCT_CODE AD_EXCHANGE_PRODUCT_CODE (利用不可)
PRODUCT_NAME AD_EXCHANGE_PRODUCT_NAME 商品
TARGETING_TYPE_CODE AD_EXCHANGE_TARGETING_TYPE_CODE (利用不可)
TARGETING_TYPE_NAME AD_EXCHANGE_TARGETING_TYPE ターゲティング タイプ
TRANSACTION_TYPE_CODE AD_EXCHANGE_TRANSACTION_TYPE_CODE (利用不可)
TRANSACTION_TYPE_NAME AD_EXCHANGE_TRANSACTION_TYPE トランザクション タイプ
URL_CHANNEL_ID AD_EXCHANGE_URL_ID (利用不可)
URL_CHANNEL_NAME AD_EXCHANGE_URL URL
VIDEO_AD_DURATION AD_EXCHANGE_VIDEO_AD_DURATION (利用不可)
VIDEO_AD_DURATION_RAW AD_EXCHANGE_VIDEO_AD_DURATION_RAW 動画広告の再生時間
VIDEO_AD_FORMAT AD_EXCHANGE_VIDEO_AD_TYPE 動画広告タイプ
WEEK AD_EXCHANGE_WEEK
WINNING_BID_RULE_ID AD_EXCHANGE_PRICING_RULE_ID (利用不可)
WINNING_BID_RULE_NAME AD_EXCHANGE_PRICING_RULE_NAME 価格設定ルール

フィードバックを送信...

DoubleClick for Publishers API
DoubleClick for Publishers API
ご不明な点がありましたら、Google のサポートページをご覧ください。