このページは Cloud Translation API によって翻訳されました。

Mutate

Google 広告スクリプトは、Google Ads API で利用可能な汎用の変更をサポートしています。GoogleAdsService.mutate から実行できるほとんどの操作は、Google 広告スクリプトでも実行できます（キャンペーンの作成や管理など）。

この機能を使用すると、Google Ads API の大部分にアクセスできるため、この機能を使用するには、Google Ads API の規則を基本レベルで理解しておくことが重要です。デベロッパートークンや認可など、多くの要素は Google 広告スクリプトによって処理されるためスキップできますが、有効な変更リクエストを作成する必要があります。

このガイドに進む前に、Google Ads API REST インターフェースに関する次の基本的なリソースをよく理解しておく必要があります。

基本的な例

この機能を説明するために、キャンペーンの予算を作成する次の基本的な例について考えてみましょう。

const budgetResult = AdsApp.mutate({
    campaignBudgetOperation: {
      create: {
        amountMicros: 10000000,
        explicitlyShared: false
      }
    }
  });

AdsApp.mutate を呼び出すと、単一の MutateOperation を表す JSON オブジェクトが使用されます。このオブジェクト内で、実行するオペレーションの種類（この場合は campaignBudgetOperation）を指定します。次に、create、remove、または update と updateMask の両方を指定します。create と update 内の特定のフィールドは、操作するリソースの特定のタイプによって異なります。

オペレーションを作成する

有効なオペレーションを構築するために使用できる戦略はいくつかあります。キャンペーンの予算の例に倣い、キャンペーン予算の REST リファレンスドキュメントを参照して、有効なフィールドの一覧を確認してから、適切なフィールドに入力します。または、スクリプトにカスタム JavaScript コードを記述して、適切なオブジェクトを構築することもできます。

または、キャンペーン予算の「試してみる」機能を使用してオペレーションを動的に作成することもできます。これにより、追加するフィールドを選択して動的にリクエスト本文を作成できます。生成された結果からオペレーションの内容を抽出し、オペレーションタイプを指定した後、mutate 呼び出しに追加できます。

オペレーションタイプ

作成

オペレーションで create を指定し、作成するリソースのオブジェクト表現を渡します。

create オペレーションの例については、上記をご覧ください。

削除

オペレーションで remove を指定し、削除するリソースのリソース名を渡します。次に例を示します。

AdsApp.mutate({
    adGroupOperation: {
        remove: "customers/[CUSTOMER_ID]/adGroups/[AD_GROUP_ID]"
    }
});

エンティティのリソース名がわからない場合は、Adsapp.search リクエストを使用して取得できます。

更新

オペレーションで update を指定し、指定したリソース名のオブジェクトを渡すことで、更新するオブジェクトをシステムが判断できるようになります。また、値を更新するフィールドに入力し、このリクエストで変更するフィールドを明確に示す updateMask を指定します。更新マスクにリソース名を含めないでください。

update オペレーションの例:

const campaignResult = AdsApp.mutate({
    campaignOperation: {
        update: {
            resourceName: "customers/[CUSTOMER_ID]/campaigns/[CAMPAIGN_ID]",
            status: "PAUSED",
            name: "[Paused] My campaign"
        },
        updateMask: "name,status"
    }
});

結果の処理

オペレーションのタイプに関係なく、戻り値は MutateResult です。返されたリソース名を使用して、変更後のリソースの現在の状態をクエリし、オペレーションが成功したかどうか、エラーが発生した場合はどのようなエラーが発生したかを確認できます。

結果を確認してログに情報を出力する基本的なフローを示した例を次に示します。

const result = AdsApp.mutate( ... );
if (result.isSuccessful()) {
    console.log(`Resource ${result.getResourceName()} successfully mutated.`);
} else {
    console.log("Errors encountered:");
    for (const error of result.getErrorMessages()) {
        console.log(error);
    }
}

複数のオペレーション

Google 広告スクリプトでは、AdsApp.mutateAll メソッドを使用して、1 つのリクエストで複数のオペレーションを変更することもできます。1 つのリクエストで、キャンペーン階層全体など、相互に依存するエンティティを作成できます。オプションで、オペレーションのセット全体をアトミックにすることもできます。これにより、1 つでも失敗しても何も実行されません。

戻り値は、指定したオペレーションごとに 1 つずつ、初期オペレーションと同じ順序で並べられた MutateResult オブジェクトの配列です。

この機能は Google Ads API の機能と同じように機能するため、一時 ID などの考慮事項について詳しくは、Google Ads API のベストプラクティスガイドをご覧ください。なお、このガイドではフィールド名を snake_case で表していますが、Google 広告スクリプトのドキュメントでは lowerCamelCase を使用しています。どちらの場合も Google 広告のスクリプトで使用できるため、そのガイドからコードを直接コピーできます。

1 つのリクエストで複数のオペレーションを行うには、すべてのオペレーションを配列に収集してから AdsApp.mutateAll を呼び出します。mutateAll 呼び出しは、演算の配列を 1 つ目の引数として、またオプションの 2 つ目の引数として、次のオプションを取ります。

apiVersion: スクリプトのデフォルト以外のバージョンを使用する場合は、V18 などのカスタム API バージョンを指定できます。公開されているバージョンであれば、どのバージョンでも使用できます。
partialFailure: このフィールドはデフォルトの true です。true に設定すると、有効なオペレーションが実行され、失敗したオペレーションはエラーを返します。false に設定すると、オペレーションのいずれかが失敗した場合、オペレーションは実行されず、このオペレーションセットは実質的にアトミックになります。

以下は、アトミックリクエストでキャンペーン予算、キャンペーン、広告グループを作成する複数のオペレーションの例です。

const operations = [];
const customerId = 'INSERT_CUSTOMER_ID_HERE';
const budgetId = `customers/${customerId}/campaignBudgets/-1`;
const campaignId = `customers/${customerId}/campaigns/-2`;
operations.push({
    campaignBudgetOperation: {
      create: {
        resourceName: budgetId,
        amountMicros: 10000000,
        explicitlyShared: false
      }
    }
  });
operations.push({
    campaignOperation: {
      create: {
        resourceName: campaignId,
        name: 'New Campaign ' + new Date(),
        advertisingChannelType: 'SEARCH',
        manualCpc: {},
        campaignBudget: budgetId,
        advertisingChannelType: 'DISPLAY',
        networkSettings: {
          targetContentNetwork: true
        }
      }
    }
  });
operations.push({
    adGroupOperation: {
      create: {
        campaign: campaignId,
        name: 'New AdGroup ' + new Date(),
        optimizedTargetingEnabled: true
      }
    }
  });
const results = AdsApp.mutateAll(
    operations, {partialFailure: false});