広告表示オプション

Google 広告スクリプトでは、次の広告表示オプションがサポートされています。

広告表示オプションについて詳しくは、ヘルプセンターをご覧ください。

Google 広告スクリプトを使用すると、アカウントでサポートされている広告表示オプションにアクセスできます。 たとえば、次のコード スニペットはサイトリンクにアクセスします。

const sitelinkIterator = AdsApp.extensions().sitelinks().get();
for (const sitelink of sitelinkIterator) {
  // Do something with each sitelink
}

その他の広告表示オプションも、それぞれのイテレータを使用して同様に取得できます。

動画を作成

Google 広告スクリプトでは、サポートされている広告表示オプションを作成できます。たとえば次のコード スニペットでは、電話番号ビルダーを使用してアカウントに電話番号を作成しています。

const phoneNumberBuilder = AdsApp.extensions().newPhoneNumberBuilder();
const newPhoneNumber = phoneNumberBuilder
  .withCountry("US")
  .withPhoneNumber("6502530000")
  .withCallOnly(false)
  .build()
  .getResult();

build() が呼び出されると、アカウントに電話番号が作成されますが、現時点では広告とともに表示されることはありません。まず、次のように、キャンペーンや広告グループに電話番号を追加する必要があります。

// Add a phone number to a campaign.
campaign.addPhoneNumber(newPhoneNumber);

// Add a phone number to an ad group.
adGroup.addPhoneNumber(newPhoneNumber);

その他のサポートされている広告表示オプションも、それぞれのビルダーを使って作成し、キャンペーンまたは広告グループに関連付けることができます。

掲載結果データを取得する

Google 広告スクリプトを使用すると、サポートされている広告表示オプションの統計情報をアカウント、キャンペーン、広告グループ単位で参照できます。

サイトリンクのデータを取得するには次のようにします。

// Account-level stats
// Get a sitelink in the account.
const sitelinkIterator = AdsApp.extensions().sitelinks().get();
const sitelink = sitelinkIterator.next();
const sitelinkStats = sitelink.getStatsFor("LAST_30_DAYS");
console.log(sitelinkStats.getClicks());

// Campaign-level stats.
// Get a sitelink in a campaign.
const campaignSitelinkIterator = campaign.extensions().sitelinks().get();
const campaignSitelink = campaignSitelinkIterator.next();
const campaignSitelinkStats = campaignSitelink.getStatsFor("LAST_30_DAYS");
console.log(campaignSitelinkStats.getClicks());

// Ad-group-level stats.
// Get a sitelink in an ad group.
const adGroupSitelinkIterator = adGroup.extensions().sitelinks().get();
const adGroupSitelink = adGroupSitelinkIterator.next();
const adGroupSitelinkStats = adGroupSitelink.getStatsFor("LAST_30_DAYS");
console.log(adGroupSitelinkStats.getClicks());

その他サポートされている広告表示オプションの掲載結果データも、同様の方法で利用できます。

広告表示オプションを変更する

サポートされている既存の広告表示オプションを、Google 広告 スクリプトを使って変更することができます。たとえば次のコードでは、既存のサイトリンクが変更されます。

// Get a sitelink in the account.
const sitelinkIterator = AdsApp.extensions().sitelinks().get();
const sitelink = sitelinkIterator.next();
console.log(sitelink.getLinkText()); // "original text"

// Get a sitelink from a campaign. Assume it's the same one as above.
const campaignSitelinkIterator = campaign.extensions().sitelinks().get();
const campaignSitelink = campaignSitelinkIterator.next();
console.log(campaignSitelink.getLinkText()); // "original text"

// Get a sitelink from an ad group. Assume it's the same one as above.
const adGroupSitelinkIterator = adGroup.extensions().sitelinks().get();
const adGroupSitelink = adGroupSitelinkIterator.next();
console.log(adGroupSitelink.getLinkText()); // "original text"

// Change the sitelink's link text. This change will affect all the campaigns
// and ad groups to which the sitelink belongs.
campaignSitelink.setLinkText("new link text");

// Same text!
console.log(campaignSitelink.getLinkText()); // "new link text"
console.log(adGroupSitelink.getLinkText()); // "new link text"
console.log(sitelink.getLinkText()); // "new link text"

その他サポートされている広告表示オプションについても同様です。

広告グループ単位の広告表示オプションにアクセスする

Google 広告スクリプトを使用すると、広告グループ単位の広告表示オプションにアクセスできます。次のメソッド呼び出しでは、広告グループに明示的に追加された電話番号が返されます。広告グループが属するキャンペーンに追加された電話番号は、その広告グループから配信される広告に電話番号が表示されていても、次のメソッド呼び出しでは返されないことに注意してください。

// This will return phone numbers that have been explicitly added to this
// ad group.
const adGroupPhoneNumberIterator = adGroup.extensions().phoneNumbers().get();

サポートされている他の広告表示オプションにも、同様の方法で広告グループ単位でアクセスできます。

アカウント単位の広告表示オプションにアクセスする

Google 広告スクリプトを使用すると、アカウント単位の広告表示オプションにアクセスできます。コールアウト、モバイルアプリ、レビューはアカウント単位の広告表示オプションとして追加できますが、アカウント単位のサイトリンクと電話番号は使用できません。次のメソッド呼び出しは、アカウントに明示的に追加されたコールアウトを返します。

// This will return callouts that have been explicitly added to your account.
const accountCalloutIterator =
    AdsApp.currentAccount().extensions().callouts().get();

アカウント単位のモバイルアプリやレビューにも、同様の方法でアクセスできます。

アカウント単位の広告表示オプションも、キャンペーン単位や広告グループ単位の広告表示オプションと同様の方法で追加できます。次の例は、アカウント単位のコールアウト表示オプションを追加する方法を示しています。

// Create a new callout in the account. Without adding the new callout as an ad
// group, campaign or account extension, it won't actually serve.
const calloutBuilder = AdsApp.extensions().newCalloutBuilder();
const newCallout = calloutBuilder.withText("Sample Text").build().getResult();

// Add the new callout as an account-level extension. This enables it to serve
// for all campaigns in the account.
AdsApp.currentAccount().addCallout(newCallout);

アカウント単位のモバイルアプリやレビューも、同様の方法で追加できます。

キャンペーン、広告グループ、アカウントの広告表示オプションを削除する

サポートされている広告表示オプションを、キャンペーンや広告グループからアカウント単位で削除できます。Google 広告 スクリプトでは、広告表示オプションをアカウントから一度に削除することはできません。

// Get a mobile app from a campaign.
const campaignMobileAppIterator = campaign.extensions().mobileApps().get();
const campaignMobileApp = campaignMobileAppIterator.next();

// Remove the mobile app.
campaign.removeMobileApp(campaignMobileApp);

// The mobile app still exists in the account and will be returned in the
// following iterator.
const mobileAppIterator = AdsApp.extensions().mobileApps().get();

同様に、広告グループやアカウント単位のモバイルアプリを削除する方法は次のとおりです。

// Get a mobile app from an ad group.
const adGroupMobileAppIterator = adGroup.extensions().mobileApps().get();
const adGroupMobileApp = adGroupMobileAppIterator.next();

// Remove the mobile app.
adGroup.removeMobileApp(adGroupMobileApp);

// Get an account-level mobile app.
const accountMobileAppIterator =
    AdsApp.currentAccount().extensions().mobileApps().get();
const accountMobileApp = accountMobileAppIterator.next();

// Remove the mobile app.
// Note that this removes the mobile app from the account level, so it will
// not serve as an account-level extension, but it will still exist in the
// account. It can still be added to an AdGroup or Campaign, or again as an
// account-level extension in the future.
AdsApp.currentAccount().removeMobileApp(accountMobileApp);

キャンペーンからすべてのモバイルアプリを削除すると、そのキャンペーンにはモバイル アプリリンク表示オプションが含まれなくなります。キャンペーンからすべてのモバイルアプリを削除するには、そのキャンペーンのモバイルアプリのリストを取得し、1 つずつ削除する必要があります。この手順は、その他のサポートされている広告表示オプションの場合も同様です。