बदलाव करने के सबसे सही तरीके

अस्थायी संसाधन के नाम

GoogleAdsService.Mutate में, संसाधन के ऐसे अस्थायी नाम इस्तेमाल किए जा सकते हैं जिनका रेफ़रंस बाद में उसी अनुरोध में दिया जा सकता है. उदाहरण के लिए, इसकी सहायता से आप एक ही अनुरोध में कैंपेन और उससे संबंधित विज्ञापन समूह, विज्ञापन, कीवर्ड वगैरह बना सकते हैं.

ऐसा करने के लिए, नए संसाधन के resource_name का इस्तेमाल करके नेगेटिव आईडी इस्तेमाल करें. उदाहरण के लिए, अगर आपने कोई कैंपेन बनाया है और उसके संसाधन का नाम customers/<YOUR_CUSTOMER_ID>/campaigns/-1 के तौर पर बताया है, तो बाद की किसी कार्रवाई में विज्ञापन ग्रुप बनाते समय, उस संसाधन के नाम से उसका रेफ़रंस दिया जा सकता है. आपने जो -1 बताया है वह अपने-आप, बनाए गए कैंपेन के असली आईडी से बदल जाएगा.

रिसॉर्स के अस्थायी नाम इस्तेमाल करते समय इन बातों का ध्यान रखें:

• किसी संसाधन का अस्थायी नाम, किसी संसाधन में तय होने के बाद ही इस्तेमाल किया जा सकता है. नीचे दिए गए उदाहरण में, विज्ञापन समूह कार्रवाई को कार्रवाइयों की सूची में कैंपेन कार्रवाई के बाद दिखना चाहिए.
• जॉब या बदले जाने वाले अनुरोधों में अस्थायी संसाधन के नामों को याद नहीं रखा जाता; पिछले जॉब में बनाए गए संसाधन का रेफ़रंस देने या अनुरोध में बदलाव करने के लिए, संसाधन के असली नाम का इस्तेमाल करें.
• किसी एक जॉब या बदलाव के अनुरोध के लिए, हर अस्थायी संसाधन के नाम में एक यूनीक नेगेटिव नंबर का इस्तेमाल होना चाहिए. भले ही, वे अलग-अलग तरह के रिसॉर्स से हों. अगर किसी एक जॉब या बदलाव के अनुरोध में अस्थायी आईडी का फिर से इस्तेमाल किया जाता है, तो गड़बड़ी दिखती है.

उदाहरण

ऊपर दी गई स्थिति का बेहतर उदाहरण देने के लिए, मान लें कि आपको एक ही एपीआई अनुरोध में एक कैंपेन, विज्ञापन ग्रुप, और विज्ञापन जोड़ना है. आपको अपने अनुरोध के लिए, नीचे दी गई चीज़ों के हिसाब से एक स्ट्रक्चर बनाना होगा:

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 का फिर से इस्तेमाल नहीं किया जा सकता. साथ ही, कोई विज्ञापन समूह का विज्ञापन बनाते समय इस विज्ञापन समूह का संदर्भ भी दिया जाता है. विज्ञापन ग्रुप उस संसाधन के नाम का इस्तेमाल करता है जो हमने कैंपेन के लिए, अनुरोध में पहले की कार्रवाई में तय किया था. वहीं, ad_group_ad_operation में resource_name की ज़रूरत नहीं है, क्योंकि किसी और कार्रवाई में इसका इस्तेमाल नहीं किया जाता.

एक ही टाइप की कार्रवाइयों का ग्रुप बनाएं

GoogleAdsService.Mutate का इस्तेमाल करते समय, कई कार्रवाइयों को एक साथ ग्रुप करना ज़रूरी है. ऐसा उनके संसाधन के हिसाब से, दोहराए जाने वाले ऑपरेशन के अरे में किया जाता है. यह बदलाव करने का तरीका, हर संसाधन के खुद के बदलने के तरीके को अपने-आप एक क्रम में कॉल करने का एक तरीका है. ऐसा करने के लिए, यह तब तक कार्रवाइयों में पढ़ता है जब तक कि उसे अलग तरह के संसाधनों के लिए कोई टूल नहीं मिल जाता. इसके बाद, एक अनुरोध में सभी समान तरह की कार्रवाइयों को एक साथ बैच करता है.

उदाहरण के लिए, अगर आपके पास 5 कैंपेन हैं और उसके बाद आपके Mutate कॉल के दोहराए गए operations फ़ील्ड में 10 विज्ञापन ग्रुप हैं, तो सिस्टम बैकएंड में कुल दो कॉल करेगा. इसमें से एक कॉल, पांच कार्रवाइयों के लिए, CampaignService पर, और 10 कार्रवाइयों के लिए AdGroupService के बगल में होगा. हालांकि, अगर आप इन्हें अलग-अलग ग्रुप में रखें, तो परफ़ॉर्मेंस बहुत खराब हो सकती है. अगर आपने सिर्फ़ दो कैंपेन और दो विज्ञापन ग्रुप बनाए हैं, लेकिन उन्हें इस तरह जोड़ा कि ऑपरेशन [कैंपेन, विज्ञापन ग्रुप, कैंपेन, विज्ञापन ग्रुप] के तौर पर क्रम से लगाए गए हैं, तो बैकएंड को कुल चार कॉल मिलेंगे. इस वजह से, एपीआई की परफ़ॉर्मेंस धीमी हो जाती है और कुछ मामलों में टाइम आउट भी हो सकता है.

अहम जानकारी: अपने GoogleAdsService.Mutate कॉल में, एक ही तरह के संसाधन पर की जाने वाली सभी कार्रवाइयों का ग्रुप बनाएं.

जवाब से बदले जा सकने वाले एट्रिब्यूट वापस पाएं

अगर बदलाव करने के response_content_type अनुरोध को MUTABLE_RESOURCE पर सेट किया जाता है, तो अनुरोध के हिसाब से बनाए गए या अपडेट किए गए हर ऑब्जेक्ट के लिए, रिस्पॉन्स में सभी म्यूटेबल फ़ील्ड की वैल्यू शामिल होंगी. बदलाव करने के हर अनुरोध के बाद, search या searchStream के अलग से अनुरोध से बचने के लिए, इस सुविधा का इस्तेमाल करें.

ध्यान दें: MUTABLE_RESOURCE रिस्पॉन्स टाइप का अनुरोध करने पर मिलने वाली अतिरिक्त जानकारी से, रिस्पॉन्स पेलोड का साइज़ बढ़ जाएगा. इस सुविधा का इस्तेमाल सिर्फ़ तब करें, जब आपके ऐप्लिकेशन को ज़्यादा जानकारी लौटाने की ज़रूरत हो.

अगर response_content_type को सेट नहीं किया जाता है, तो Google Ads API डिफ़ॉल्ट रूप से RESOURCE_NAME_ONLY पर सेट होता है. रिस्पॉन्स में, हर बनाए गए या अपडेट किए गए संसाधन का नाम ही शामिल होगा.

एपीआई कॉल से, बदले जा सकने वाले रिसॉर्स को वापस पाने का उदाहरण यहां दिया गया है:

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);
  }
}
CreateExperiment.java
      

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.V16.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);
}
CreateExperiment.cs
      

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];
}
CreateExperiment.php
      

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]
create_experiment.py
      

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
create_experiment.rb
      

Perl

sub create_experiment_arms {
  my ($api_client, $customer_id, $base_campaign_id, $experiment) = @_;

  my $operations = [];
  push @$operations,
    Google::Ads::GoogleAds::V16::Services::ExperimentArmService::ExperimentArmOperation
    ->new({
      create => Google::Ads::GoogleAds::V16::Resources::ExperimentArm->new({
          # The "control" arm references an already-existing campaign.
          control   => "true",
          campaigns => [
            Google::Ads::GoogleAds::V16::Utils::ResourceNames::campaign(
              $customer_id, $base_campaign_id
            )
          ],
          experiment   => $experiment,
          name         => "control arm",
          trafficSplit => 40
        })});

  push @$operations,
    Google::Ads::GoogleAds::V16::Services::ExperimentArmService::ExperimentArmOperation
    ->new({
      create => Google::Ads::GoogleAds::V16::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];
}
create_experiment.pl