ディスプレイ＆ビデオ 360 サービス

ディスプレイ＆ビデオ 360（DV360）サービスを使用すると、Apps Script で DV360 API を使用できます。この API を使用すると、Display & Video API にプログラムでアクセスできます。

注: これは、使用前に有効にする必要がある高度なサービスです。

リファレンス

このサービスの詳細については、DV360 API のリファレンス ドキュメントをご覧ください。Apps Script のすべての高度なサービスと同様に、DV360 サービスでは、公開 API と同じオブジェクト、メソッド、パラメータを使用します。詳細については、メソッド シグネチャの決定方法をご覧ください。

問題を報告したり、その他のサポートを見つけたりするには、ディスプレイ＆ビデオ 360 サポートガイドをご覧ください。

サンプルコード

次のサンプルコードでは、API のバージョン 4 を使用します。

パートナーのリストを取得する

このサンプルでは、アカウントで使用可能なすべてのパートナーをログに記録します。

advanced/displayvideo.gs

GitHub で表示

/**
 * Logs all of the partners available in the account.
 */
function listPartners() {
  // Retrieve the list of available partners
  try {
    const partners = DisplayVideo.Partners.list();

    if (partners.partners) {
      // Print out the ID and name of each
      for (let i = 0; i < partners.partners.length; i++) {
        const partner = partners.partners[i];
        console.log('Found partner with ID %s and name "%s".',
            partner.partnerId, partner.displayName);
      }
    }
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

有効なキャンペーンのリストを取得する

このサンプルでは、すべてのアクティブなキャンペーンの名前と ID をログに記録します。ページング トークンを使用してリスト全体を取得していることに注意してください。

advanced/displayvideo.gs

GitHub で表示

/**
 * Logs names and ID's of all active campaigns.
 * Note the use of paging tokens to retrieve the whole list.
 */
function listActiveCampaigns() {
  const advertiserId = '1234567'; // Replace with your advertiser ID.
  let result;
  let pageToken;
  try {
    do {
      result = DisplayVideo.Advertisers.Campaigns.list(advertiserId, {
        'filter': 'entityStatus="ENTITY_STATUS_ACTIVE"',
        'pageToken': pageToken
      });
      if (result.campaigns) {
        for (let i = 0; i < result.campaigns.length; i++) {
          const campaign = result.campaigns[i];
          console.log('Found campaign with ID %s and name "%s".',
              campaign.campaignId, campaign.displayName);
        }
      }
      pageToken = result.nextPageToken;
    } while (pageToken);
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

広告申込情報の表示名を更新する

このサンプルでは、広告申込情報の表示名を更新します。

advanced/displayvideo.gs

GitHub で表示

/**
 * Updates the display name of a line item
 */
function updateLineItemName() {
  const advertiserId = '1234567'; // Replace with your advertiser ID.
  const lineItemId = '123456789'; //Replace with your line item ID.
  const updateMask = "displayName";

  const lineItemDef = {displayName: 'New Line Item Name (updated from Apps Script!)'};

  try {
    const lineItem = DisplayVideo.Advertisers.LineItems
        .patch(lineItemDef, advertiserId, lineItemId, {updateMask:updateMask});


  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}