スマート アシスト キャンペーンは SmartCampaignSetting
というリソースに依存しています。このリソースには、メインの Campaign
リソースでは利用できない追加の設定オプションが含まれます。
スマート アシスト キャンペーンはキャンペーンと紐づいていないと存在できません。そのため、同じ変更リクエストで 2 つのオブジェクトを作成するのがおすすめです。
キャンペーンを作成する
スマート アシスト キャンペーンは主に Google の広告技術で自動的に管理されるため、多くのフィールドを設定する必要はありません。
スマート アシスト キャンペーンの主な要件:
- 固有の
CampaignBudget
が必要です。 advertising_channel_type
をAdvertisingChannelTypeEnum.SMART
に設定する必要があります。advertising_channel_sub_type
をAdvertisingChannelTypeSubEnum.SMART_CAMPAIGN
に設定する必要があります。
このキャンペーンのリソース名の値は、一時リソース名を使用して設定されていることに注意してください。これにより、キャンペーンがバックエンドに存在する前に、変換リクエスト内の他のオブジェクトによってキャンペーンを参照できるようになります。
Java
private MutateOperation createSmartCampaignOperation(long customerId) { MutateOperation.Builder builder = MutateOperation.newBuilder(); builder .getCampaignOperationBuilder() .getCreateBuilder() .setName("Smart campaign " + CodeSampleHelper.getShortPrintableDateTime()) .setStatus(CampaignStatus.PAUSED) .setAdvertisingChannelType(AdvertisingChannelType.SMART) .setAdvertisingChannelSubType(AdvertisingChannelSubType.SMART_CAMPAIGN) // Assigns the resource name with a temporary ID. .setResourceName(ResourceNames.campaign(customerId, SMART_CAMPAIGN_TEMPORARY_ID)) .setCampaignBudget(ResourceNames.campaignBudget(customerId, BUDGET_TEMPORARY_ID)); return builder.build(); }
C#
/// <summary> /// Creates a MutateOperation that creates a new Smart campaign. /// A temporary ID will be assigned to this campaign so that it can be referenced by other /// objects being created in the same Mutate request. /// </summary> /// <param name="customerId">The Google Ads customer ID.</param> /// <returns>A MutateOperation that creates a campaign.</returns> private MutateOperation CreateSmartCampaignOperation(long customerId) { return new MutateOperation { CampaignOperation = new CampaignOperation { Create = new Campaign { Name = $"Smart campaign #{ExampleUtilities.GetRandomString()}", // Set the campaign status as PAUSED. The campaign is the only entity in // the mutate request that should have its status set. Status = CampaignStatus.Paused, // AdvertisingChannelType must be SMART. AdvertisingChannelType = AdvertisingChannelType.Smart, // AdvertisingChannelSubType must be SMART_CAMPAIGN. AdvertisingChannelSubType = AdvertisingChannelSubType.SmartCampaign, // Assign the resource name with a temporary ID. ResourceName = ResourceNames.Campaign(customerId, SMART_CAMPAIGN_TEMPORARY_ID), // Set the budget using the given budget resource name. CampaignBudget = ResourceNames.CampaignBudget(customerId, BUDGET_TEMPORARY_ID) } } }; }
PHP
private static function createSmartCampaignOperation(int $customerId): MutateOperation { // Creates the campaign object. $campaign = new Campaign([ 'name' => "Smart campaign #" . Helper::getPrintableDatetime(), // Sets the campaign status as PAUSED. The campaign is the only entity in the mutate // request that should have its' status set. 'status' => CampaignStatus::PAUSED, // The advertising channel type is required to be SMART. 'advertising_channel_type' => AdvertisingChannelType::SMART, // The advertising channel sub type is required to be SMART_CAMPAIGN. 'advertising_channel_sub_type' => AdvertisingChannelSubType::SMART_CAMPAIGN, // Assigns the resource name with a temporary ID. 'resource_name' => ResourceNames::forCampaign($customerId, self::SMART_CAMPAIGN_TEMPORARY_ID), // Sets the budget using the given budget resource name. 'campaign_budget' => ResourceNames::forCampaignBudget($customerId, self::BUDGET_TEMPORARY_ID) ]); // Creates the MutateOperation that creates the campaign. return new MutateOperation([ 'campaign_operation' => new CampaignOperation(['create' => $campaign]) ]); }
Python
def create_smart_campaign_operation(client, customer_id): """Creates a MutateOperation that creates a new Smart campaign. A temporary ID will be assigned to this campaign so that it can be referenced by other objects being created in the same Mutate request. Args: client: an initialized GoogleAdsClient instance. customer_id: a client customer ID. Returns: a MutateOperation that creates a campaign. """ mutate_operation = client.get_type("MutateOperation") campaign = mutate_operation.campaign_operation.create campaign.name = f"Smart campaign #{uuid4()}" # Set the campaign status as PAUSED. The campaign is the only entity in # the mutate request that should have its' status set. campaign.status = client.enums.CampaignStatusEnum.PAUSED # Campaign.AdvertisingChannelType is required to be SMART. campaign.advertising_channel_type = ( client.enums.AdvertisingChannelTypeEnum.SMART ) # Campaign.AdvertisingChannelSubType is required to be SMART_CAMPAIGN. campaign.advertising_channel_sub_type = ( client.enums.AdvertisingChannelSubTypeEnum.SMART_CAMPAIGN ) # Assign the resource name with a temporary ID. campaign_service = client.get_service("CampaignService") campaign.resource_name = campaign_service.campaign_path( customer_id, _SMART_CAMPAIGN_TEMPORARY_ID ) # Set the budget using the given budget resource name. campaign.campaign_budget = campaign_service.campaign_budget_path( customer_id, _BUDGET_TEMPORARY_ID ) return mutate_operation
Ruby
# Creates a mutate_operation that creates a new Smart campaign. # A temporary ID will be assigned to this campaign so that it can # be referenced by other objects being created in the same mutate request. def create_smart_campaign_operation( client, customer_id) mutate_operation = client.operation.mutate do |m| m.campaign_operation = client.operation.create_resource.campaign do |c| c.name = "Smart campaign ##{(Time.new.to_f * 1000).to_i}" # Sets the campaign status as PAUSED. The campaign is the only entity in # the mutate request that should have its' status set. c.status = :PAUSED # campaign.advertising_channel_type is required to be SMART. c.advertising_channel_type = :SMART # campaign.advertising_channel_sub_type is required to be SMART_CAMPAIGN. c.advertising_channel_sub_type = :SMART_CAMPAIGN # Assigns the resource name with a temporary ID. c.resource_name = client.path.campaign(customer_id, SMART_CAMPAIGN_TEMPORARY_ID) c.campaign_budget = client.path.campaign_budget(customer_id, BUDGET_TEMPORARY_ID) end end mutate_operation end
Perl
# Creates a MutateOperation that creates a new Smart campaign. # A temporary ID will be assigned to this campaign so that it can be referenced # by other objects being created in the same Mutate request. sub _create_smart_campaign_operation { my ($customer_id) = @_; return Google::Ads::GoogleAds::V16::Services::GoogleAdsService::MutateOperation-> new({ campaignOperation => Google::Ads::GoogleAds::V16::Services::CampaignService::CampaignOperation ->new({ create => Google::Ads::GoogleAds::V16::Resources::Campaign->new({ name => "Smart campaign #" . uniqid(), # Set the campaign status as PAUSED. The campaign is the only # entity in the mutate request that should have its status set. status => PAUSED, # AdvertisingChannelType must be SMART. advertisingChannelType => SMART, # AdvertisingChannelSubType must be SMART_CAMPAIGN. advertisingChannelSubType => Google::Ads::GoogleAds::V16::Enums::AdvertisingChannelSubTypeEnum::SMART_CAMPAIGN, # Assign the resource name with a temporary ID. resourceName => Google::Ads::GoogleAds::V16::Utils::ResourceNames::campaign( $customer_id, SMART_CAMPAIGN_TEMPORARY_ID ), # Set the budget using the given budget resource name. campaignBudget => Google::Ads::GoogleAds::V16::Utils::ResourceNames::campaign_budget( $customer_id, BUDGET_TEMPORARY_ID )})})}); }
スマート アシスト キャンペーンの設定を作成する
SmartCampaignSetting
リソースは、スマート アシスト キャンペーンを設定する目的にのみ使用され、参照可能なスマート アシスト キャンペーンがすでに存在していないと作成できません。スマート アシスト キャンペーンの設定はこの点で特に独自性があり、メインの Campaign
リソースの拡張と考えることができます。
スマート アシスト キャンペーンの設定はキャンペーンと密接に関連しているため、create
オペレーションを使って作成することはできません。代わりに update
オペレーションを使って作成する必要があります。
属するキャンペーンを指定する campaign
フィールドを持つ AdGroup
オブジェクトのようなリソースとは異なり、スマート アシスト キャンペーンの設定では、キャンペーンと同じ ID を使用してリソース名を直接更新する必要があります。新しいスマート アシスト キャンペーンの設定は、別のリソースを使って既存のキャンペーンを更新するだけだと考えてください。
スマート アシスト キャンペーンの設定の主な要件:
- 参照可能な既存の
Campaign
が必要です。 Campaign
との関係は、campaign
フィールドではなくresource_name
で定義されます。business_profile_location
またはfinal_url
とbusiness_name
を設定する必要があります。- 新しいスマート アシスト キャンペーンの設定を作成する場合も、オペレーションに
update_mask
をupdate
追加する必要があります。 - すべてのスマート アシスト キャンペーンにはランディング ページが必要です。ランディング ページを設定するには、
final_url
を使用するか、自動ランディング ページ(自動ランディング ページ)を有効にして、指定されたbusiness_profile_location
の情報を使用してキャンペーンのランディング ページを作成します。
Java
private MutateOperation createSmartCampaignSettingOperation( long customerId, String businessProfileLocation, String businessName) { MutateOperation.Builder builder = MutateOperation.newBuilder(); SmartCampaignSetting.Builder settingBuilder = builder .getSmartCampaignSettingOperationBuilder() .getUpdateBuilder() // Sets a temporary ID in the campaign setting's resource name to associate it with // the campaign created in the previous step. .setResourceName( ResourceNames.smartCampaignSetting(customerId, SMART_CAMPAIGN_TEMPORARY_ID)); // Configures the SmartCampaignSetting using many of the same details used to // generate a budget suggestion. settingBuilder .setFinalUrl(LANDING_PAGE_URL) .setAdvertisingLanguageCode(LANGUAGE_CODE) .getPhoneNumberBuilder() .setCountryCode(COUNTRY_CODE) .setPhoneNumber(PHONE_NUMBER); // It's required that either a business profile location resource name or a business name is // added to the SmartCampaignSetting. if (businessProfileLocation != null) { settingBuilder.setBusinessProfileLocation(businessProfileLocation); } else { settingBuilder.setBusinessName(businessName); } builder .getSmartCampaignSettingOperationBuilder() .setUpdateMask(FieldMasks.allSetFieldsOf(settingBuilder.build())); return builder.build(); }
C#
/// <summary> /// Creates a MutateOperation to create a new SmartCampaignSetting. SmartCampaignSettings /// are unique in that they only support UPDATE operations, which are used to update and /// create them. Below we will use a temporary ID in the resource name to associate it with /// the campaign created in the previous step. /// </summary> /// <param name="customerId">The Google Ads customer ID.</param> /// <param name="businessProfileLocation">The identifier of a Business Profile location.</param> /// <param name="businessName">The name of a Business Profile business.</param> /// <returns>A MutateOperation that creates a SmartCampaignSetting.</returns> private MutateOperation CreateSmartCampaignSettingOperation(long customerId, string businessProfileLocation, string businessName) { SmartCampaignSetting smartCampaignSetting = new SmartCampaignSetting { // Set a temporary ID in the campaign setting's resource name to associate it with // the campaign created in the previous step. ResourceName = ResourceNames.SmartCampaignSetting(customerId, SMART_CAMPAIGN_TEMPORARY_ID), // Below we configure the SmartCampaignSetting using many of the same details used // to generate a budget suggestion. PhoneNumber = new SmartCampaignSetting.Types.PhoneNumber { CountryCode = COUNTRY_CODE, PhoneNumber_ = PHONE_NUMBER }, FinalUrl = LANDING_PAGE_URL, AdvertisingLanguageCode = LANGUAGE_CODE }; // Either a business profile location or a business name must be added to the // SmartCampaignSetting. if (!string.IsNullOrEmpty(businessProfileLocation)) { // Transform Google Business Location ID to a compatible format before // passing it onto the API. smartCampaignSetting.BusinessProfileLocation = businessProfileLocation; } else { smartCampaignSetting.BusinessName = businessName; } return new MutateOperation { SmartCampaignSettingOperation = new SmartCampaignSettingOperation { Update = smartCampaignSetting, // Set the update mask on the operation. This is required since the smart // campaign setting is created in an UPDATE operation. Here the update mask // will be a list of all the fields that were set on the SmartCampaignSetting. UpdateMask = FieldMasks.AllSetFieldsOf(smartCampaignSetting) } }; }
PHP
private static function createSmartCampaignSettingOperation( int $customerId, ?string $businessProfileLocationResourceName, ?string $businessName ): MutateOperation { // Creates the smart campaign setting object. $smartCampaignSetting = new SmartCampaignSetting([ // Sets a temporary ID in the campaign setting's resource name to associate it with // the campaign created in the previous step. 'resource_name' => ResourceNames::forSmartCampaignSetting( $customerId, self::SMART_CAMPAIGN_TEMPORARY_ID ), // Below we configure the SmartCampaignSetting using many of the same details used to // generate a budget suggestion. 'phone_number' => new PhoneNumber([ 'country_code' => self::COUNTRY_CODE, 'phone_number' => self::PHONE_NUMBER ]), 'final_url' => self::LANDING_PAGE_URL, 'advertising_language_code' => self::LANGUAGE_CODE, ]); // It's required that either a business profile location resource name or a business name is // added to the SmartCampaignSetting. if ($businessProfileLocationResourceName) { $smartCampaignSetting->setBusinessProfileLocation($businessProfileLocationResourceName); } else { $smartCampaignSetting->setBusinessName($businessName); } // Creates the MutateOperation that creates the smart campaign setting with an update. return new MutateOperation([ 'smart_campaign_setting_operation' => new SmartCampaignSettingOperation([ 'update' => $smartCampaignSetting, // Sets the update mask on the operation. This is required since the smart campaign // setting is created in an UPDATE operation. Here the update mask will be a list // of all the fields that were set on the SmartCampaignSetting. 'update_mask' => FieldMasks::allSetFieldsOf($smartCampaignSetting) ]) ]); }
Python
def create_smart_campaign_setting_operation( client, customer_id, business_profile_location, business_name ): """Creates a MutateOperation to create a new SmartCampaignSetting. SmartCampaignSettings are unique in that they only support UPDATE operations, which are used to update and create them. Below we will use a temporary ID in the resource name to associate it with the campaign created in the previous step. Args: client: an initialized GoogleAdsClient instance. customer_id: a client customer ID. business_profile_location: the resource name of a Business Profile location. business_name: the name of a Business Profile. Returns: a MutateOperation that creates a SmartCampaignSetting. """ mutate_operation = client.get_type("MutateOperation") smart_campaign_setting = ( mutate_operation.smart_campaign_setting_operation.update ) # Set a temporary ID in the campaign setting's resource name to associate it # with the campaign created in the previous step. smart_campaign_setting.resource_name = client.get_service( "SmartCampaignSettingService" ).smart_campaign_setting_path(customer_id, _SMART_CAMPAIGN_TEMPORARY_ID) # Below we configure the SmartCampaignSetting using many of the same # details used to generate a budget suggestion. smart_campaign_setting.phone_number.country_code = _COUNTRY_CODE smart_campaign_setting.phone_number.phone_number = _PHONE_NUMBER smart_campaign_setting.final_url = _LANDING_PAGE_URL smart_campaign_setting.advertising_language_code = _LANGUAGE_CODE # Set either of the business_profile_location or business_name, depending on # whichever is provided. if business_profile_location: smart_campaign_setting.business_profile_location = ( business_profile_location ) else: smart_campaign_setting.business_name = business_name # Set the update mask on the operation. This is required since the smart # campaign setting is created in an UPDATE operation. Here the update # mask will be a list of all the fields that were set on the # SmartCampaignSetting. client.copy_from( mutate_operation.smart_campaign_setting_operation.update_mask, protobuf_helpers.field_mask(None, smart_campaign_setting._pb), ) return mutate_operation
Ruby
# Creates a mutate_operation to create a new smart_campaign_setting. # smart_campaign_settings are unique in that they only support UPDATE # operations, which are used to update and create them. Below we will # use a temporary ID in the resource name to associate it with the # campaign created in the previous step. def create_smart_campaign_setting_operation( client, customer_id, business_profile_location, business_name) mutate_operation = client.operation.mutate do |m| m.smart_campaign_setting_operation = client.operation.update_resource.smart_campaign_setting( # Sets a temporary ID in the campaign setting's resource name to # associate it with the campaign created in the previous step. client.path.smart_campaign_setting( customer_id, SMART_CAMPAIGN_TEMPORARY_ID) ) do |scs| # Below we configure the smart_campaign_setting using many of the same # details used to generate a budget suggestion. scs.phone_number = client.resource.phone_number do |p| p.country_code = COUNTRY_CODE p.phone_number = PHONE_NUMBER end scs.final_url = LANDING_PAGE_URL scs.advertising_language_code = LANGUAGE_CODE # It's required that either a business location ID or a business name is # added to the smart_campaign_setting. if business_profile_location scs.business_profile_location = business_profile_location else scs.business_name = business_name end end end mutate_operation end
Perl
# Creates a MutateOperation to create a new SmartCampaignSetting. # SmartCampaignSettings are unique in that they only support UPDATE operations, # which are used to update and create them. Below we will use a temporary ID in # the resource name to associate it with the campaign created in the previous step. sub _create_smart_campaign_setting_operation { my ($customer_id, $business_profile_location, $business_name) = @_; my $smart_campaign_setting = Google::Ads::GoogleAds::V16::Resources::SmartCampaignSetting->new({ # Set a temporary ID in the campaign setting's resource name to associate it # with the campaign created in the previous step. resourceName => Google::Ads::GoogleAds::V16::Utils::ResourceNames::smart_campaign_setting( $customer_id, SMART_CAMPAIGN_TEMPORARY_ID ), # Below we configure the SmartCampaignSetting using many of the same # details used to generate a budget suggestion. phoneNumber => Google::Ads::GoogleAds::V16::Resources::PhoneNumber->new({ countryCode => COUNTRY_CODE, phoneNumber => PHONE_NUMBER } ), finalUrl => LANDING_PAGE_URL, advertisingLanguageCode => LANGUAGE_CODE }); # It's required that either a business profile location or a business name is # added to the SmartCampaignSetting. if (defined $business_profile_location) { $smart_campaign_setting->{businessProfileLocation} = $business_profile_location; } else { $smart_campaign_setting->{businessName} = $business_name; } return Google::Ads::GoogleAds::V16::Services::GoogleAdsService::MutateOperation-> new({ smartCampaignSettingOperation => Google::Ads::GoogleAds::V16::Services::SmartCampaignSettingService::SmartCampaignSettingOperation ->new({ update => $smart_campaign_setting, # Set the update mask on the operation. This is required since the # smart campaign setting is created in an UPDATE operation. Here the # update mask will be a list of all the fields that were set on the # SmartCampaignSetting. updateMask => all_set_fields_of($smart_campaign_setting)})}); }
ランディング ページ
スマート アシスト キャンペーンには、視聴者を誘導するランディング ページが必要です。final_url
を指定して既存のウェブサイトを使用することも、ランディング ページの自動作成を有効にしてランディング ページを自動的に作成することもできます。新しいランディング ページには、ビジネス プロフィールの情報が使用されます。
キャンペーンのランディング ページを生成するには、business_profile_location
識別子を指定して、ad_optimized_business_profile_setting
フィールドを空の AdOptimizedBusinessProfileSetting
インスタンスに設定する必要があります。例を次に示します。
Java
SmartCampaignSetting smartCampaignSetting =
SmartCampaignSetting.newBuilder()
.setBusinessProfileLocation(businessProfileLocation)
// Sets the ad optimized business profile setting to an empty
// instance of AdOptimizedBusinessProfileSetting.
.setAdOptimizedBusinessProfileSetting(
AdOptimizedBusinessProfileSetting.newBuilder().build())
.build();
C#
SmartCampaignSetting smartCampaignSetting = new SmartCampaignSetting()
{
BusinessProfileLocation = businessProfileLocation,
/// Sets the ad optimized business profile setting to an empty
/// instance of AdOptimizedBusinessProfileSetting.
AdOptimizedBusinessProfileSetting =
new SmartCampaignSetting.Types.AdOptimizedBusinessProfileSetting()
};
PHP
$smartCampaignSetting = new SmartCampaignSetting([
'business_profile_location' => business_profile_location,
// Sets the ad optimized business profile setting to an empty instance
// of AdOptimizedBusinessProfileSetting.
'ad_optimized_business_profile_setting' => new AdOptimizedBusinessProfileSetting(),
]);
Python
smart_campaign_setting = client.get_type("SmartCampaignSetting")
smart_campaign_setting.business_profile_location = business_profile_location
# Sets the ad optimized business profile setting to an empty instance of
# AdOptimizedBusinessProfileSetting.
client.copy_from(
smart_campaign_setting.ad_optimized_business_profile_setting,
client.get_type("AdOptimizedBusinessProfileSetting")
)
Ruby
smart_campaign_setting = client.resource.smart_campaign_setting do |s|
s.business_profile_location = business_profile_location
# Sets the ad optimized business profile setting to an empty instance of
# AdOptimizedBusinessProfileSetting.
s.ad_optimized_business_profile_setting = client.resource.ad_optimized_business_profile_setting
end
Perl
my $campaign = Google::Ads::GoogleAds::V16::Resources::Campaign->new({
businessProfileLocation => $business_profile_location,
# Sets the ad optimized business profile setting to an empty instance of
# AdOptimizedBusinessProfileSetting.
adOptimizedBusinessProfileSetting =>
Google::Ads::GoogleAds::V16::Common::AdOptimizedBusinessProfileSetting->new()
});
さらに、include_lead_form
フィールドを使用すると、生成されたランディング ページにリードフォームを含めるかどうかを指定できます。これにより、見込み顧客がフォームに記入して直接連絡できるようになります。有効にする方法の例を次に示します。
Java
SmartCampaignSetting smartCampaignSetting =
SmartCampaignSetting.newBuilder()
.setBusinessProfileLocation(businessProfileLocation)
// Sets the AdOptimizedBusinessProfileSetting.include_lead_form field to true.
.setAdOptimizedBusinessProfileSetting(
AdOptimizedBusinessProfileSetting.newBuilder().setIncludeLeadForm(true).build())
.build();
C#
SmartCampaignSetting smartCampaignSetting = new SmartCampaignSetting()
{
BusinessProfileLocation = businessProfileLocation,
/// Sets the AdOptimizedBusinessProfileSetting.include_lead_form
/// field to true.
AdOptimizedBusinessProfileSetting =
new SmartCampaignSetting.Types.AdOptimizedBusinessProfileSetting
{
IncludeLeadForm = true
}
};
PHP
$smartCampaignSetting = new SmartCampaignSetting([
'business_profile_location' => business_profile_location,
// Sets the AdOptimizedBusinessProfileSetting.include_lead_form field
// to true.
'ad_optimized_business_profile_setting' => new AdOptimizedBusinessProfileSetting([
'include_lead_form' => true
]),
]);
Python
smart_campaign_setting = client.get_type("SmartCampaignSetting")
smart_campaign_setting.business_profile_location = business_profile_location
# Sets the AdOptimizedBusinessProfileSetting.include_lead_form field to
# true.
smart_campaign_setting.ad_optimized_business_profile_setting.include_lead_form = True
Ruby
smart_campaign_setting = client.resource.smart_campaign_setting do |s|
s.business_profile_location = business_profile_location
# Sets the AdOptimizedBusinessProfileSetting.include_lead_form field to
# true.
s.ad_optimized_business_profile_setting = client.resource.ad_optimized_business_profile_setting do |a|
a.include_lead_form = true
end
end
Perl
my $campaign = Google::Ads::GoogleAds::V16::Resources::Campaign->new({
businessProfileLocation => $business_profile_location,
# Sets the AdOptimizedBusinessProfileSetting.include_lead_form field to
# true.
adOptimizedBusinessProfileSetting =>
Google::Ads::GoogleAds::V16::Common::AdOptimizedBusinessProfileSetting->new({
includeLeadForm => "true"
})
});