Merge pull request #2 from googleads/release-stage

Added support for v0_2.
googleads · Jun 15, 2018 · 79f1910 · 79f1910
2 parents ac8563c + 673e9a2
commit 79f1910
Show file tree

Hide file tree

Showing 65 changed files with 811 additions and 271 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 0.2.0
+
+*   Added support for V0_2 of Google Ads API, which includes the Percent CPC
+    bidding strategy.
+
 ## 0.1.0
 
 *   Initial release with support for V0_1 of Google Ads API.
diff --git a/composer.json b/composer.json
@@ -1,6 +1,5 @@
 {
   "name": "googleads/google-ads-php",
-  "version": "0.1.0",
   "author": "Google LLC",
   "url": "https://github.com/googleads/google-ads-php",
   "description": "Google Ads API client for PHP",

diff --git a/examples/AccountManagement/GetAccountInformation.php b/examples/AccountManagement/GetAccountInformation.php
@@ -43,7 +43,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT
         ]);
 

diff --git a/examples/AdvancedOperations/AddExpandedTextAdWithUpgradedUrls.php b/examples/AdvancedOperations/AddExpandedTextAdWithUpgradedUrls.php
@@ -50,7 +50,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT
         ]);

diff --git a/examples/AdvancedOperations/UsePortfolioBiddingStrategy.php b/examples/AdvancedOperations/UsePortfolioBiddingStrategy.php
@@ -58,7 +58,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments(
+        $options = (new ArgumentParser())->parseCommandArguments(
             [
                 ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
                 ArgumentNames::CAMPAIGN_BUDGET_ID => GetOpt::OPTIONAL_ARGUMENT

diff --git a/examples/BasicOperations/AddAdGroups.php b/examples/BasicOperations/AddAdGroups.php
@@ -46,7 +46,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CAMPAIGN_ID => GetOpt::REQUIRED_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/AddCampaigns.php b/examples/BasicOperations/AddCampaigns.php
@@ -51,7 +51,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT
         ]);
 

diff --git a/examples/BasicOperations/AddExpandedTextAds.php b/examples/BasicOperations/AddExpandedTextAds.php
@@ -48,7 +48,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/AddKeywords.php b/examples/BasicOperations/AddKeywords.php
@@ -48,7 +48,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::KEYWORD_TEXT => GetOpt::OPTIONAL_ARGUMENT

diff --git a/examples/BasicOperations/GetAdGroups.php b/examples/BasicOperations/GetAdGroups.php
@@ -43,7 +43,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CAMPAIGN_ID => GetOpt::OPTIONAL_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/GetArtifactMetadata.php b/examples/BasicOperations/GetArtifactMetadata.php
@@ -47,7 +47,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::ARTIFACT_NAME => GetOpt::REQUIRED_ARGUMENT
         ]);
 

diff --git a/examples/BasicOperations/GetCampaigns.php b/examples/BasicOperations/GetCampaigns.php
@@ -40,7 +40,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT
         ]);
 

diff --git a/examples/BasicOperations/GetExpandedTextAds.php b/examples/BasicOperations/GetExpandedTextAds.php
@@ -43,7 +43,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::OPTIONAL_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/GetKeywords.php b/examples/BasicOperations/GetKeywords.php
@@ -43,7 +43,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::OPTIONAL_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/PauseAd.php b/examples/BasicOperations/PauseAd.php
@@ -47,7 +47,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_ID => GetOpt::REQUIRED_ARGUMENT

diff --git a/examples/BasicOperations/RemoveAd.php b/examples/BasicOperations/RemoveAd.php
@@ -45,7 +45,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_ID => GetOpt::REQUIRED_ARGUMENT

diff --git a/examples/BasicOperations/RemoveAdGroup.php b/examples/BasicOperations/RemoveAdGroup.php
@@ -45,7 +45,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/RemoveCampaign.php b/examples/BasicOperations/RemoveCampaign.php
@@ -44,7 +44,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CAMPAIGN_ID => GetOpt::REQUIRED_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/RemoveKeyword.php b/examples/BasicOperations/RemoveKeyword.php
@@ -47,7 +47,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CRITERION_ID => GetOpt::REQUIRED_ARGUMENT

diff --git a/examples/BasicOperations/UpdateAdGroup.php b/examples/BasicOperations/UpdateAdGroup.php
@@ -49,7 +49,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CPC_BID_MICRO_AMOUNT => GetOpt::REQUIRED_ARGUMENT

diff --git a/examples/BasicOperations/UpdateCampaign.php b/examples/BasicOperations/UpdateCampaign.php
@@ -47,7 +47,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CAMPAIGN_ID => GetOpt::REQUIRED_ARGUMENT
         ]);

diff --git a/examples/BasicOperations/UpdateKeyword.php b/examples/BasicOperations/UpdateKeyword.php
@@ -50,7 +50,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CRITERION_ID => GetOpt::REQUIRED_ARGUMENT

diff --git a/examples/HotelAds/AddHotelAd.php b/examples/HotelAds/AddHotelAd.php
@@ -29,6 +29,7 @@
 use Google\Ads\GoogleAds\V0\Common\Ad;
 use Google\Ads\GoogleAds\V0\Common\HotelAdInfo;
 use Google\Ads\GoogleAds\V0\Common\ManualCpc;
+use Google\Ads\GoogleAds\V0\Common\PercentCpc;
 use Google\Ads\GoogleAds\V0\Enums\AdGroupAdStatusEnum_AdGroupAdStatus;
 use Google\Ads\GoogleAds\V0\Enums\AdGroupStatusEnum_AdGroupStatus;
 use Google\Ads\GoogleAds\V0\Enums\AdGroupTypeEnum_AdGroupType;
@@ -66,14 +67,18 @@ class AddHotelAds
     // This ID is the same account ID that you use in API requests to the Travel Partner APIs
     // (https://developers.google.com/hotels/hotel-ads/api-reference/).
     const HOTEL_CENTER_ACCOUNT_ID = 'INSERT_HOTEL_CENTER_ACCOUNT_ID_HERE';
+    // Specify maximum bid limit that can be set when creating a campaign using the Percent CPC
+    // bidding strategy.
+    const CPC_BID_CEILING_MICRO_AMOUNT = 20000000;
 
     public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
-            ArgumentNames::HOTEL_CENTER_ACCOUNT_ID => GetOpt::REQUIRED_ARGUMENT
+            ArgumentNames::HOTEL_CENTER_ACCOUNT_ID => GetOpt::REQUIRED_ARGUMENT,
+            ArgumentNames::CPC_BID_CEILING_MICRO_AMOUNT => GetOpt::OPTIONAL_ARGUMENT
         ]);
 
         // Generate a refreshable OAuth2 credential for authentication.
@@ -89,7 +94,9 @@ public static function main()
             self::runExample(
                 $googleAdsClient,
                 $options[ArgumentNames::CUSTOMER_ID] ?: self::CUSTOMER_ID,
-                $options[ArgumentNames::HOTEL_CENTER_ACCOUNT_ID] ?: self::HOTEL_CENTER_ACCOUNT_ID
+                $options[ArgumentNames::HOTEL_CENTER_ACCOUNT_ID] ?: self::HOTEL_CENTER_ACCOUNT_ID,
+                $options[ArgumentNames::CPC_BID_CEILING_MICRO_AMOUNT]
+                    ?: self::CPC_BID_CEILING_MICRO_AMOUNT
             );
         } catch (GoogleAdsException $googleAdsException) {
             printf(
@@ -122,11 +129,13 @@ public static function main()
      * @param GoogleAdsClient $googleAdsClient the Google Ads API client
      * @param int $customerId the client customer ID without hyphens
      * @param int $hotelCenterAccountId the Hotel Center account ID
+     * @param int $cpcBidCeilingMicroAmount the CPC bid ceiling micro amount
      */
     public static function runExample(
         GoogleAdsClient $googleAdsClient,
         $customerId,
-        $hotelCenterAccountId
+        $hotelCenterAccountId,
+        $cpcBidCeilingMicroAmount
     ) {
         // Creates a budget to be used by the campaign that will be created below.
         $budgetResourceName = self::addCampaignBudget($googleAdsClient, $customerId);
@@ -135,7 +144,8 @@ public static function runExample(
             $googleAdsClient,
             $customerId,
             $budgetResourceName,
-            $hotelCenterAccountId
+            $hotelCenterAccountId,
+            $cpcBidCeilingMicroAmount
         );
         // Creates a hotel ad group.
         $adGroupResourceName =
@@ -196,14 +206,16 @@ private static function addCampaignBudget(GoogleAdsClient $googleAdsClient, $cus
      * @param int $customerId the client customer ID
      * @param string $budgetResourceName the resource name of budget for a new campaign
      * @param int $hotelCenterAccountId the Hotel Center account ID
+     * @param int $cpcBidCeilingMicroAmount the CPC bid ceiling micro amount
      * @return string the resource name of the newly created campaign
      */
     // [START addHotelCampaign]
     private static function addHotelCampaign(
         GoogleAdsClient $googleAdsClient,
         $customerId,
         $budgetResourceName,
-        $hotelCenterAccountId
+        $hotelCenterAccountId,
+        $cpcBidCeilingMicroAmount
     ) {
         // Creates a campaign.
         $campaign = new Campaign();
@@ -227,8 +239,13 @@ private static function addHotelCampaign(
         // the ads from immediately serving. Set to ENABLED once you've added
         // targeting and the ads are ready to serve.
         $campaign->setStatus(CampaignStatusEnum_CampaignStatus::PAUSED);
-        // Sets the bidding strategy. Only Manual CPC can be used for hotel campaigns.
-        $campaign->setManualCpc(new ManualCpc());
+        // Sets the bidding strategy to PercentCpc. Only Manual CPC and Percent CPC can be used for
+        // hotel campaigns.
+        $percentCpc = new PercentCpc();
+        $wrappedCpcBidCeilingMicros = new Int64Value();
+        $wrappedCpcBidCeilingMicros->setValue($cpcBidCeilingMicroAmount);
+        $percentCpc->setCpcBidCeilingMicros($wrappedCpcBidCeilingMicros);
+        $campaign->setPercentCpc($percentCpc);
 
         // Sets the budget.
         $wrappedBudgetResourceName = new StringValue();

diff --git a/examples/HotelAds/AddHotelAdGroupBidModifiers.php b/examples/HotelAds/AddHotelAdGroupBidModifiers.php
@@ -63,7 +63,7 @@ public static function main()
     {
         // Either pass the required parameters for this example on the command line, or insert them
         // into the constants above.
-        $options = ArgumentParser::parseCommandArguments([
+        $options = (new ArgumentParser())->parseCommandArguments([
             ArgumentNames::CUSTOMER_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::AD_GROUP_ID => GetOpt::REQUIRED_ARGUMENT,
             ArgumentNames::CHECK_IN_DAY_CRITERION_ID => GetOpt::OPTIONAL_ARGUMENT