AdX Seller REST API からの移行

Google アド マネージャーでは、レポート作成と入稿エンティティ(LineItems など)の操作の両方に SOAP API を提供しています。クライアント ライブラリは複数の言語で提供されています。AdX Seller API と同様に、Ad Manager API は 認証に OAuth2 を使用します。

最初のリクエストを開始するには、スタートガイドをご覧ください。

Ad Manager API のレポート

アド マネージャー API の ReportService には、レポートの実行とダウンロードを行う 2 つの方法があります。

  1. UI でクエリを作成し、ID に基づいて実行する。
  2. アドホック ReportQuery を構築します。

どちらのオプションでも、API ワークフローは次の 4 つのステップで構成されます。

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

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

レポートのタイムゾーン

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

AdX からアド マネージャーへの指標とディメンションのマッピング

サポートされているすべての Ad Exchange Seller REST API の指標とディメンションが、アド マネージャーの Reporting API に含まれるようになりました。一部の名前が変更され、一部の名前は非推奨になりました。詳しくは、以下の表をご覧ください。

指標 / 列

次の表に、AdX の指標とアド マネージャーの列のマッピングを示します。

AdX 指標アド マネージャーの列アド マネージャー クエリツールの名前
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 広告リクエスト クリック率
AD_REQUESTS_RPM AD_EXCHANGE_AD_REQUEST_ECPM 広告リクエスト eCPM
クリック数 AD_EXCHANGE_CLICKS クリック数
COST_PER_CLICK AD_EXCHANGE_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 取引の一致したリクエスト数
収益 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 動画の四分位 1
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

サイズ

この表は、AdX ディメンションをアド マネージャーのディメンションにマッピングしたものです。

AdX ディメンションアド マネージャーのディメンションアド マネージャー クエリツールの名前
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 チャンネル
日付 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 帯域幅
月 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 価格設定ルール