ชื่อทรัพยากรชั่วคราว
GoogleAdsService.Mutate
รองรับ
ชื่อทรัพยากรชั่วคราวที่ใช้อ้างอิงในภายหลังได้
ในคำขอเดียวกัน เช่น คุณสามารถสร้างแคมเปญและ
กลุ่มโฆษณา โฆษณา คีย์เวิร์ด ฯลฯ ที่เกี่ยวข้องทั้งหมดภายในคำขอเดียว
ซึ่งทำได้โดยการระบุ resource_name
ของทรัพยากรใหม่เพื่อใช้
รหัสเชิงลบ เช่น หากคุณสร้างแคมเปญและระบุชื่อทรัพยากรของแคมเปญ
เป็น customers/<YOUR_CUSTOMER_ID>/campaigns/-1
เมื่อคุณสร้าง
กลุ่มโฆษณาในการดำเนินการในภายหลัง
คุณสามารถอ้างอิงโดยใช้ชื่อทรัพยากรนั้น
-1
ที่คุณระบุจะถูกแทนที่ด้วยรหัสจริงของแคมเปญที่สร้าง
โดยอัตโนมัติ
ต่อไปนี้คือสิ่งที่ควรทราบเมื่อใช้ชื่อทรัพยากรชั่วคราว
- ชื่อทรัพยากรชั่วคราวจะใช้ได้หลังจากได้รับการกำหนดใน ทรัพยากร ในตัวอย่างด้านล่าง การทำงานของกลุ่มโฆษณาจะต้องปรากฏ หลังจากดำเนินการแคมเปญในรายการการดำเนินการ
- ระบบจะไม่จำชื่อทรัพยากรชั่วคราวในงานหรือคำขอเปลี่ยนแปลง เพื่ออ้างอิงทรัพยากรที่สร้างในงานก่อนหน้าหรือคำขอเปลี่ยนแปลง ให้ใช้ ชื่อทรัพยากรจริง
- สำหรับงานเดียวหรือคำขอเปลี่ยนแปลง ชื่อทรัพยากรชั่วคราวแต่ละรายการต้องใช้ จำนวนติดลบที่ไม่ซ้ำกัน แม้ว่าจะมาจากประเภททรัพยากรที่ต่างกันก็ตาม ถ้า มีการใช้รหัสชั่วคราวซ้ำในงานเดียวหรือคำขอเปลี่ยนแปลง แล้วจึงเกิดข้อผิดพลาด
ตัวอย่าง
ยกตัวอย่างที่เป็นรูปธรรมมากขึ้นสำหรับสถานการณ์ที่กล่าวถึงข้างต้น สมมติว่าคุณ ต้องการเพิ่มแคมเปญ กลุ่มโฆษณา และโฆษณาในคําขอ API รายการเดียว คุณ จะสร้างโครงสร้างสำหรับคำขอของคุณในลักษณะเดียวกันกับรายการต่อไปนี้
mutate_operations: [
{
campaign_operation: {
create: {
resource_name: "customers/<YOUR_CUSTOMER_ID>/campaigns/-1",
...
}
}
},
{
ad_group_operation: {
create: {
resource_name: "customers/<YOUR_CUSTOMER_ID>/adGroups/-2",
campaign: "customers/<YOUR_CUSTOMER_ID>/campaigns/-1"
...
}
}
},
{
ad_group_ad_operation: {
create: {
ad_group: "customers/<YOUR_CUSTOMER_ID>/adGroups/-2"
...
}
}
},
]
โปรดสังเกตว่ามีการใช้รหัสชั่วคราวใหม่สำหรับกลุ่มโฆษณา เนื่องจากเราไม่สามารถนำมาใช้ใหม่ได้
-1
ที่เราใช้สำหรับแคมเปญ และเรายังอ้างอิงกลุ่มโฆษณานี้เมื่อ
สร้างโฆษณาระดับกลุ่มโฆษณา ตัวกลุ่มโฆษณาเองก็อ้างอิงถึงชื่อทรัพยากรที่เรา
เกิดขึ้นในแคมเปญในการดำเนินการก่อนหน้านี้ในคำขอ ในขณะที่
ไม่จำเป็นต้องระบุ resource_name
ใน ad_group_ad_operation
เนื่องจากไม่มีการเชื่อมโยง
การอ้างอิง
จัดกลุ่มการดำเนินการประเภทเดียวกัน
เมื่อใช้ GoogleAdsService.Mutate
จะสำคัญต่อการดำเนินการกลุ่ม
ด้วยกันตามทรัพยากรในอาร์เรย์การดำเนินการที่ซ้ำกัน ช่วงเวลานี้
Mutate Method คือวิธีในการเรียกใช้ตามลำดับโดยอัตโนมัติ
เมธอด Mutate ของทรัพยากรแต่ละรายการของตัวเอง โดยจะอ่านในการดำเนินการ
จนกว่าจะพบเทมเพลต
สำหรับทรัพยากรประเภทอื่น
การดำเนินการประเภทเดียวกันไว้ด้วยกันในคำขอเดียว
เช่น ถ้าคุณมีแคมเปญ 5 รายการ ตามด้วยกลุ่มโฆษณา 10 กลุ่ม
ในฟิลด์ operations
ที่ซ้ำในการเรียก Mutate
ของคุณ จากนั้น
ระบบจะดำเนินการเรียกทั้งหมด 2 ครั้งในแบ็กเอนด์ รายการหนึ่งไปยัง
CampaignService
สำหรับ 5 การดำเนินการ และถัดจาก AdGroupService
สำหรับการดำเนินการ 10 รายการ
แต่ถ้าคุณจะจัดกลุ่มให้แตกต่างกัน ประสิทธิภาพที่ได้อาจสูง
แย่ลง หากคุณสร้างแคมเปญเพียง 2 รายการ และกลุ่มโฆษณา 2 กลุ่ม แต่รวมกลุ่มโฆษณาไว้ เพื่อให้
จะเรียงลำดับการดำเนินการเป็น [แคมเปญ, กลุ่มโฆษณา, แคมเปญ, กลุ่มโฆษณา] จากนั้น
จะทำให้เกิดการเรียกทั้งหมด 4 ครั้งในแบ็กเอนด์ การดำเนินการนี้จะทำให้ API ทำงานช้าลง
และในกรณีที่มีประสิทธิภาพสูงสุด ก็อาจทำให้ถึงระยะหมดเวลาได้
ดึงข้อมูลแอตทริบิวต์ที่เปลี่ยนแปลงได้จากการตอบกลับ
หากคุณตั้งค่า response_content_type
ของคำขอเปลี่ยนแปลงเป็น
MUTABLE_RESOURCE
,
การตอบกลับจะมีค่าของช่องเปลี่ยนแปลงได้ทั้งหมดสำหรับทุกออบเจ็กต์
สร้างหรืออัปเดตตามคำขอ ใช้ฟีเจอร์นี้เพื่อหลีกเลี่ยง
search
หรือ searchStream
หลังคำขอเปลี่ยนแปลงแต่ละรายการ
หากคุณไม่ตั้งค่า response_content_type
ค่าเริ่มต้นของ Google Ads API จะเป็น
RESOURCE_NAME_ONLY
และการตอบกลับจะมีเฉพาะชื่อทรัพยากรของ
ทรัพยากรที่สร้างหรืออัปเดตแต่ละรายการ
ตัวอย่างการดึงข้อมูลทรัพยากรที่เปลี่ยนแปลงได้จากการเรียก API มีดังนี้
Java
private String createExperimentArms( GoogleAdsClient googleAdsClient, long customerId, long campaignId, String experiment) { List<ExperimentArmOperation> operations = new ArrayList<>(); operations.add( ExperimentArmOperation.newBuilder() .setCreate( // The "control" arm references an already-existing campaign. ExperimentArm.newBuilder() .setControl(true) .addCampaigns(ResourceNames.campaign(customerId, campaignId)) .setExperiment(experiment) .setName("control arm") .setTrafficSplit(40) .build()) .build()); operations.add( ExperimentArmOperation.newBuilder() .setCreate( // The non-"control" arm, also called a "treatment" arm, will automatically // generate draft campaigns that you can modify before starting the experiment. ExperimentArm.newBuilder() .setControl(false) .setExperiment(experiment) .setName("experiment arm") .setTrafficSplit(60) .build()) .build()); try (ExperimentArmServiceClient experimentArmServiceClient = googleAdsClient.getLatestVersion().createExperimentArmServiceClient()) { // Constructs the mutate request. MutateExperimentArmsRequest mutateRequest = MutateExperimentArmsRequest.newBuilder() .setCustomerId(Long.toString(customerId)) .addAllOperations(operations) // We want to fetch the draft campaign IDs from the treatment arm, so the easiest way to do // that is to have the response return the newly created entities. .setResponseContentType(ResponseContentType.MUTABLE_RESOURCE) .build(); // Sends the mutate request. MutateExperimentArmsResponse response = experimentArmServiceClient.mutateExperimentArms(mutateRequest); // Results always return in the order that you specify them in the request. Since we created // the treatment arm last, it will be the last result. If you don't remember which arm is the // treatment arm, you can always filter the query in the next section with // `experiment_arm.control = false`. MutateExperimentArmResult controlArmResult = response.getResults(0); MutateExperimentArmResult treatmentArmResult = response.getResults( response.getResultsCount() - 1); System.out.printf("Created control arm with resource name '%s'%n", controlArmResult.getResourceName()); System.out.printf("Created treatment arm with resource name '%s'%n", treatmentArmResult.getResourceName()); return treatmentArmResult.getExperimentArm().getInDesignCampaigns(0); } }
C#
/// <summary> /// Creates the experiment arms. /// </summary> /// <param name="client">The Google Ads client.</param> /// <param name="customerId">The customer ID for which the call is made.</param> /// <param name="baseCampaignId">ID of the campaign for which the control arm is /// created.</param> /// <param name="experimentResourceName">Resource name of the experiment.</param> /// <returns>The control and treatment arms.</returns> private static (MutateExperimentArmResult, MutateExperimentArmResult) CreateExperimentArms(GoogleAdsClient client, long customerId, long baseCampaignId, string experimentResourceName) { // Get the ExperimentArmService. ExperimentArmServiceClient experimentService = client.GetService( Services.V17.ExperimentArmService); // Create the control arm. The control arm references an already-existing campaign. ExperimentArmOperation controlArmOperation = new ExperimentArmOperation() { Create = new ExperimentArm() { Control = true, Campaigns = { ResourceNames.Campaign(customerId, baseCampaignId) }, Experiment = experimentResourceName, Name = "Control Arm", TrafficSplit = 40 } }; // Create the non-control arm. The non-"control" arm, also called a "treatment" arm, // will automatically generate draft campaigns that you can modify before starting the // experiment. ExperimentArmOperation treatmentArmOperation = new ExperimentArmOperation() { Create = new ExperimentArm() { Control = false, Experiment = experimentResourceName, Name = "Experiment Arm", TrafficSplit = 60 } }; // We want to fetch the draft campaign IDs from the treatment arm, so the // easiest way to do that is to have the response return the newly created // entities. MutateExperimentArmsRequest request = new MutateExperimentArmsRequest { CustomerId = customerId.ToString(), Operations = { controlArmOperation, treatmentArmOperation }, ResponseContentType = ResponseContentType.MutableResource }; MutateExperimentArmsResponse response = experimentService.MutateExperimentArms( request ); // Results always return in the order that you specify them in the request. // Since we created the treatment arm last, it will be the last result. MutateExperimentArmResult controlArm = response.Results.First(); MutateExperimentArmResult treatmentArm = response.Results.Last(); Console.WriteLine($"Created control arm with resource name " + $"'{controlArm.ResourceName}."); Console.WriteLine($"Created treatment arm with resource name" + $" '{treatmentArm.ResourceName}'."); return (controlArm, treatmentArm); }
PHP
private static function createExperimentArms( GoogleAdsClient $googleAdsClient, int $customerId, int $campaignId, string $experimentResourceName ): string { $operations = []; $experimentArm1 = new ExperimentArm([ // The "control" arm references an already-existing campaign. 'control' => true, 'campaigns' => [ResourceNames::forCampaign($customerId, $campaignId)], 'experiment' => $experimentResourceName, 'name' => 'control arm', 'traffic_split' => 40 ]); $operations[] = new ExperimentArmOperation(['create' => $experimentArm1]); $experimentArm2 = new ExperimentArm([ // The non-"control" arm, also called a "treatment" arm, will automatically // generate draft campaigns that you can modify before starting the // experiment. 'control' => false, 'experiment' => $experimentResourceName, 'name' => 'experiment arm', 'traffic_split' => 60 ]); $operations[] = new ExperimentArmOperation(['create' => $experimentArm2]); // Issues a request to create the experiment arms. $experimentArmServiceClient = $googleAdsClient->getExperimentArmServiceClient(); $response = $experimentArmServiceClient->mutateExperimentArms( MutateExperimentArmsRequest::build($customerId, $operations) // We want to fetch the draft campaign IDs from the treatment arm, so the easiest // way to do that is to have the response return the newly created entities. ->setResponseContentType(ResponseContentType::MUTABLE_RESOURCE) ); // Results always return in the order that you specify them in the request. // Since we created the treatment arm last, it will be the last result. $controlArmResourceName = $response->getResults()[0]->getResourceName(); $treatmentArm = $response->getResults()[count($operations) - 1]; print "Created control arm with resource name '$controlArmResourceName'" . PHP_EOL; print "Created treatment arm with resource name '{$treatmentArm->getResourceName()}'" . PHP_EOL; return $treatmentArm->getExperimentArm()->getInDesignCampaigns()[0]; }
Python
def create_experiment_arms(client, customer_id, base_campaign_id, experiment): """Creates a control and treatment experiment arms. Args: client: an initialized GoogleAdsClient instance. customer_id: a client customer ID. base_campaign_id: the campaign ID to associate with the control arm of the experiment. experiment: the resource name for an experiment. Returns: the resource name for the new treatment experiment arm. """ operations = [] campaign_service = client.get_service("CampaignService") # The "control" arm references an already-existing campaign. operation_1 = client.get_type("ExperimentArmOperation") exa_1 = operation_1.create exa_1.control = True exa_1.campaigns.append( campaign_service.campaign_path(customer_id, base_campaign_id) ) exa_1.experiment = experiment exa_1.name = "control arm" exa_1.traffic_split = 40 operations.append(operation_1) # The non-"control" arm, also called a "treatment" arm, will automatically # generate draft campaigns that you can modify before starting the # experiment. operation_2 = client.get_type("ExperimentArmOperation") exa_2 = operation_2.create exa_2.control = False exa_2.experiment = experiment exa_2.name = "experiment arm" exa_2.traffic_split = 60 operations.append(operation_2) experiment_arm_service = client.get_service("ExperimentArmService") request = client.get_type("MutateExperimentArmsRequest") request.customer_id = customer_id request.operations = operations # We want to fetch the draft campaign IDs from the treatment arm, so the # easiest way to do that is to have the response return the newly created # entities. request.response_content_type = ( client.enums.ResponseContentTypeEnum.MUTABLE_RESOURCE ) response = experiment_arm_service.mutate_experiment_arms(request=request) # Results always return in the order that you specify them in the request. # Since we created the treatment arm second, it will be the second result. control_arm_result = response.results[0] treatment_arm_result = response.results[1] print( f"Created control arm with resource name {control_arm_result.resource_name}" ) print( f"Created treatment arm with resource name {treatment_arm_result.resource_name}" ) return treatment_arm_result.experiment_arm.in_design_campaigns[0]
Ruby
def create_experiment_arms(client, customer_id, base_campaign_id, experiment) operations = [] operations << client.operation.create_resource.experiment_arm do |ea| # The "control" arm references an already-existing campaign. ea.control = true ea.campaigns << client.path.campaign(customer_id, base_campaign_id) ea.experiment = experiment ea.name = 'control arm' ea.traffic_split = 40 end operations << client.operation.create_resource.experiment_arm do |ea| # The non-"control" arm, also called a "treatment" arm, will automatically # generate draft campaigns that you can modify before starting the # experiment. ea.control = false ea.experiment = experiment ea.name = 'experiment arm' ea.traffic_split = 60 end response = client.service.experiment_arm.mutate_experiment_arms( customer_id: customer_id, operations: operations, # We want to fetch the draft campaign IDs from the treatment arm, so the # easiest way to do that is to have the response return the newly created # entities. response_content_type: :MUTABLE_RESOURCE, ) # Results always return in the order that you specify them in the request. # Since we created the treatment arm last, it will be the last result. control_arm_result = response.results.first treatment_arm_result = response.results.last puts "Created control arm with resource name #{control_arm_result.resource_name}." puts "Created treatment arm with resource name #{treatment_arm_result.resource_name}." treatment_arm_result.experiment_arm.in_design_campaigns.first end
Perl
sub create_experiment_arms { my ($api_client, $customer_id, $base_campaign_id, $experiment) = @_; my $operations = []; push @$operations, Google::Ads::GoogleAds::V17::Services::ExperimentArmService::ExperimentArmOperation ->new({ create => Google::Ads::GoogleAds::V17::Resources::ExperimentArm->new({ # The "control" arm references an already-existing campaign. control => "true", campaigns => [ Google::Ads::GoogleAds::V17::Utils::ResourceNames::campaign( $customer_id, $base_campaign_id ) ], experiment => $experiment, name => "control arm", trafficSplit => 40 })}); push @$operations, Google::Ads::GoogleAds::V17::Services::ExperimentArmService::ExperimentArmOperation ->new({ create => Google::Ads::GoogleAds::V17::Resources::ExperimentArm->new({ # The non-"control" arm, also called a "treatment" arm, will automatically # generate draft campaigns that you can modify before starting the # experiment. control => "false", experiment => $experiment, name => "experiment arm", trafficSplit => 60 })}); my $response = $api_client->ExperimentArmService()->mutate({ customerId => $customer_id, operations => $operations, # We want to fetch the draft campaign IDs from the treatment arm, so the # easiest way to do that is to have the response return the newly created # entities. responseContentType => MUTABLE_RESOURCE }); # Results always return in the order that you specify them in the request. # Since we created the treatment arm last, it will be the last result. my $control_arm_result = $response->{results}[0]; my $treatment_arm_result = $response->{results}[1]; printf "Created control arm with resource name '%s'.\n", $control_arm_result->{resourceName}; printf "Created treatment arm with resource name '%s'.\n", $treatment_arm_result->{resourceName}; return $treatment_arm_result->{experimentArm}{inDesignCampaigns}[0]; }