google-adwords-api 0.20.0 → 0.20.1

data/test/templates/v201601/basic_operations_get_campaigns.def

@@ -0,0 +1,116 @@
+def setup_mocks()
+  $api_config = {
+    :service => {:environment => 'PRODUCTION'},
+    :authentication => {
+      :method => 'OAuth2',
+      :oauth2_client_id => 'client_id123',
+      :oauth2_client_secret => 'client_secret123',
+      :developer_token => 'dev_token123',
+      :client_customer_id => '123-456-7890',
+      :user_agent => 'ruby-tests',
+      :oauth2_token => {
+        :refresh_token => 'refresh_token123'
+      }
+    }
+  }
+
+  stub_request(:post, "https://accounts.google.com/o/oauth2/auth").
+    with(:body => {"client_id"=>"client_id123", "client_secret"=>"client_secret123", "refresh_token"=>"refresh_token123", "grant_type"=>"refresh_token"}).
+    to_return(:status => 200, :body => '{"access_token":"access_token123","token_type":"Bearer","expires_in":"3600"}\n', :headers => {})
+
+  stub_request(:post, "https://adwords.google.com/api/adwords/cm/v201601/CampaignService").
+    with(
+      :body =>
+      # autogenerated code
+        {"env:Envelope"=>
+          {"env:Header"=>
+            {"wsdl:RequestHeader"=>
+              {"userAgent"=>/ruby-tests.*AwApi\-Ruby.*Common\-Ruby/,
+               "developerToken"=>"dev_token123",
+               "clientCustomerId"=>"123-456-7890",
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201601"}},
+           "env:Body"=>
+            {"get"=>
+              {"serviceSelector"=>
+                {"fields"=>["Id", "Name", "Status"],
+                 "ordering"=>{"field"=>"Name", "sortOrder"=>"ASCENDING"},
+                 "paging"=>{"startIndex"=>"0", "numberResults"=>"5"}},
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201601"}},
+           "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+           "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+           "xmlns:wsdl"=>"https://adwords.google.com/api/adwords/cm/v201601",
+           "xmlns:env"=>"http://schemas.xmlsoap.org/soap/envelope/"}},
+      # end of auto-generated code.
+      :headers => {
+        'SOAPAction' => '"get"',
+        'Content-Type' => 'text/xml;charset=UTF-8'
+      }
+    ).
+    to_return(
+      :status => 200,
+      :body => '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+                <soap:Header>
+                  <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201601">
+                    <requestId>0004c</requestId>
+                    <serviceName>CampaignService</serviceName>
+                    <methodName>get</methodName>
+                    <operations>42</operations>
+                    <responseTime>84</responseTime>
+                    <units>42</units>
+                  </ResponseHeader>
+                </soap:Header>
+                <soap:Body>
+                  <getResponse xmlns="https://adwords.google.com/api/adwords/cm/v201601">
+                    <rval>
+                      <totalNumEntries>2</totalNumEntries>
+                      <Page.Type>CampaignPage</Page.Type>
+                      <totalBudget>
+                        <period>DAILY</period><amount><ComparableValue.Type>Money</ComparableValue.Type>
+                        <microAmount>0</microAmount></amount>
+                      </totalBudget>
+                      <entries>
+                        <id>15</id><name>Campaign name 1</name><status>PAUSED</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>0</impressions></frequencyCap>
+                      </entries>
+                      <entries>
+                        <id>16</id><name>Campaign name 2</name><status>ACTIVE</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>150</impressions></frequencyCap>
+                      </entries>
+                    </rval>
+                  </getResponse>
+                </soap:Body>
+                </soap:Envelope>',
+      :headers => {'content-type' => 'text/xml;'}
+    )
+end
+
+def run_asserts()
+  assert_equal(2, $latest_result[:total_num_entries])
+  assert_equal('CampaignPage', $latest_result[:page_type])
+  entries = $latest_result[:entries]
+  assert_equal(2, entries.size)
+
+  if entries[0][:id] == 15
+    assert_campaign_15(entries[0])
+    assert_campaign_16(entries[1])
+  else
+    assert_campaign_15(entries[1])
+    assert_campaign_16(entries[0])
+  end
+end
+
+def assert_campaign_15(entry)
+  assert_equal(15, entry[:id])
+  assert_equal('Campaign name 1', entry[:name])
+  assert_equal('PAUSED', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>0}, entry[:frequency_cap])
+end
+
+def assert_campaign_16(entry)
+  assert_equal(16, entry[:id])
+  assert_equal('Campaign name 2', entry[:name])
+  assert_equal('ACTIVE', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>150}, entry[:frequency_cap])
+end

data/test/templates/v201601/basic_operations_update_keyword.def

@@ -0,0 +1,125 @@
+def setup_mocks()
+  $api_config = {
+    :service => {:environment => 'PRODUCTION'},
+    :authentication => {
+      :method => 'OAuth2',
+      :oauth2_client_id => 'client_id123',
+      :oauth2_client_secret => 'client_secret123',
+      :developer_token => 'dev_token123',
+      :client_customer_id => '123-456-7890',
+      :user_agent => 'ruby-tests',
+      :oauth2_token => {
+        :refresh_token => 'refresh_token123'
+      }
+    }
+  }
+
+  stub_request(:post, "https://accounts.google.com/o/oauth2/auth").
+    with(:body => {"client_id"=>"client_id123", "client_secret"=>"client_secret123", "refresh_token"=>"refresh_token123", "grant_type"=>"refresh_token"}).
+    to_return(:status => 200, :body => '{"access_token":"access_token123","token_type":"Bearer","expires_in":"3600"}\n', :headers => {})
+
+  stub_request(:post, "https://adwords.google.com/api/adwords/cm/v201601/AdGroupCriterionService").
+    with(
+      :body =>
+      # autogenerated code
+        {"env:Envelope"=>
+          {"env:Header"=>
+            {"wsdl:RequestHeader"=>
+              {"userAgent"=>/ruby-tests.*AwApi\-Ruby.*Common\-Ruby/,
+               "developerToken"=>"dev_token123",
+               "clientCustomerId"=>"123-456-7890",
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201601"}},
+           "env:Body"=>
+            {"mutate"=>
+              {"operations"=>
+                {"operator"=>"SET",
+                 "operand"=>
+                  {"adGroupId"=>"0",
+                   "criterion"=>{"id"=>"0"},
+                   "biddingStrategyConfiguration"=>
+                    {"bids"=>
+                      {"bid"=>{"microAmount"=>"1000000"}, "xsi:type"=>"CpcBid"}},
+                   "xsi:type"=>"BiddableAdGroupCriterion"}},
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201601"}},
+           "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+           "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+           "xmlns:wsdl"=>"https://adwords.google.com/api/adwords/cm/v201601",
+           "xmlns:env"=>"http://schemas.xmlsoap.org/soap/envelope/"}},
+      # end of auto-generated code.
+      :headers => {
+        'SOAPAction' => '"mutate"',
+        'Content-Type' => 'text/xml;charset=UTF-8'
+      }
+    ).
+    to_return(
+      :status => 200,
+      :body => '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+                <soap:Header>
+                  <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201601">
+                    <requestId>0004c</requestId>
+                    <serviceName>AdGroupCriterionService</serviceName>
+                    <methodName>mutate</methodName>
+                    <operations>1</operations>
+                    <responseTime>102</responseTime>
+                  </ResponseHeader>
+                </soap:Header>
+                <soap:Body>
+                  <mutateResponse xmlns="https://adwords.google.com/api/adwords/cm/v201601">
+                    <rval>
+                      <ListReturnValue.Type>AdGroupCriterionReturnValue</ListReturnValue.Type>
+                      <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="BiddableAdGroupCriterion">
+                        <adGroupId>1234</adGroupId>
+                        <criterion xsi:type="Keyword">
+                          <id>5678</id>
+                          <type>KEYWORD</type>
+                          <Criterion.Type>Keyword</Criterion.Type>
+                          <text>test text</text>
+                          <matchType>BROAD</matchType>
+                        </criterion>
+                        <AdGroupCriterion.Type>BiddableAdGroupCriterion</AdGroupCriterion.Type>
+                        <userStatus>PAUSED</userStatus>
+                        <systemServingStatus>ELIGIBLE</systemServingStatus>
+                        <approvalStatus>PENDING_REVIEW</approvalStatus>
+                        <biddingStrategyConfiguration>
+                          <biddingStrategyType>MANUAL_CPC</biddingStrategyType>
+                          <biddingStrategySource>CAMPAIGN</biddingStrategySource>
+                          <biddingScheme xsi:type="ManualCpcBiddingScheme">
+                            <BiddingScheme.Type>ManualCpcBiddingScheme</BiddingScheme.Type>
+                            <enhancedCpcEnabled>false</enhancedCpcEnabled>
+                          </biddingScheme>
+                          <bids xsi:type="CpcBid">
+                            <Bids.Type>CpcBid</Bids.Type>
+                            <bid>
+                              <ComparableValue.Type>Money</ComparableValue.Type>
+                              <microAmount>1000000</microAmount>
+                            </bid>
+                            <cpcBidSource>CRITERION</cpcBidSource>
+                          </bids>
+                          <bids xsi:type="CpmBid">
+                            <Bids.Type>CpmBid</Bids.Type>
+                            <bid>
+                              <ComparableValue.Type>Money</ComparableValue.Type>
+                              <microAmount>10000</microAmount>
+                            </bid>
+                            <cpmBidSource>ADGROUP</cpmBidSource>
+                          </bids>
+                        </biddingStrategyConfiguration>
+                        <finalUrls>
+                          <urls>http://example.com/mars</urls>
+                        </finalUrls>
+                      </value>
+                    </rval>
+                  </mutateResponse>
+                </soap:Body>
+                </soap:Envelope>',
+      :headers => {'content-type' => 'text/xml;'}
+    )
+end
+
+def run_asserts()
+  assert_equal(1, $latest_result[:value].size)
+  ad_group_criterion = $latest_result[:value].first
+  assert_equal(1234, ad_group_criterion[:ad_group_id])
+  assert_equal(5678, ad_group_criterion[:criterion][:id])
+  assert_equal("test text", ad_group_criterion[:criterion][:text])
+end

data/test/templates/v201601/misc_use_oauth2_jwt.def

@@ -0,0 +1,131 @@
+def setup_mocks()
+  file_name = 'privatekey.p12'
+  file_contents = 'file contents'
+  key_secret = 'not-secret'
+
+  $api_config = {
+    :service => {:environment => 'PRODUCTION'},
+    :authentication => {
+      :method => 'OAUTH2_SERVICE_ACCOUNT',
+      :oauth2_issuer => 'not-valid@developer.gserviceaccount.com',
+      :oauth2_secret => key_secret,
+      :oauth2_keyfile => file_name,
+      :developer_token => 'dev_token123',
+      :client_customer_id => '123-456-7890',
+      :user_agent => 'ruby-tests'
+    }
+  }
+
+  stub(File).file?(file_name) { true }
+  stub.proxy(File).file?
+
+  stub(File).read(file_name) { file_contents }
+  stub.proxy(File).read
+
+  key = mock!.key { 'pkcs12 key' }
+  stub(OpenSSL::PKCS12).new.with(file_contents, key_secret) { key }
+
+  stub_request(:post, "https://accounts.google.com/o/oauth2/token").
+    with(:body => hash_including({"grant_type"=>"urn:ietf:params:oauth:grant-type:jwt-bearer"}),
+         :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Faraday v0.9.2'}).
+    with(:body => /assertion=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9/).
+    to_return(:status => 200,
+        :body => "{\n  \"access_token\" : \"ab01.CBEF2GHi3JKlMnOpqRstUvW4X-YzaBcdEFG5IjKLMNPPqRStuV\",\n  \"token_type\" : \"Bearer\",\n  \"expires_in\" : 3600\n}",
+        :headers => {"Content-Type"=>"application/json"})
+
+  stub_request(:post, "https://adwords.google.com/api/adwords/cm/v201601/CampaignService").
+    with(
+      :body =>
+      # autogenerated code
+        {"env:Envelope"=>
+          {"env:Header"=>
+            {"wsdl:RequestHeader"=>
+              {"userAgent"=>/ruby-tests.*AwApi\-Ruby.*Common\-Ruby/,
+               "developerToken"=>"dev_token123",
+               "clientCustomerId"=>"123-456-7890",
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201601"}},
+           "env:Body"=>
+            {"get"=>
+              {"serviceSelector"=>
+                {"fields"=>["Id", "Name", "Status"],
+                 "ordering"=>{"field"=>"Name", "sortOrder"=>"ASCENDING"}},
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201601"}},
+           "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+           "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+           "xmlns:wsdl"=>"https://adwords.google.com/api/adwords/cm/v201601",
+           "xmlns:env"=>"http://schemas.xmlsoap.org/soap/envelope/"}},
+      # end of auto-generated code.
+      :headers => {
+        'SOAPAction' => '"get"',
+        'Content-Type' => 'text/xml;charset=UTF-8',
+        'Authorization' => 'Bearer ab01.CBEF2GHi3JKlMnOpqRstUvW4X-YzaBcdEFG5IjKLMNPPqRStuV'
+      }
+    ).
+    to_return(
+      :status => 200,
+      :body => '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+                <soap:Header>
+                  <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201601">
+                    <requestId>0004c</requestId>
+                    <serviceName>CampaignService</serviceName>
+                    <methodName>get</methodName>
+                    <operations>42</operations>
+                    <responseTime>84</responseTime>
+                    <units>42</units>
+                  </ResponseHeader>
+                </soap:Header>
+                <soap:Body>
+                  <getResponse xmlns="https://adwords.google.com/api/adwords/cm/v201601">
+                    <rval>
+                      <totalNumEntries>2</totalNumEntries>
+                      <Page.Type>CampaignPage</Page.Type>
+                      <totalBudget>
+                        <period>DAILY</period><amount><ComparableValue.Type>Money</ComparableValue.Type>
+                        <microAmount>0</microAmount></amount>
+                      </totalBudget>
+                      <entries>
+                        <id>15</id><name>Campaign name 1</name><status>PAUSED</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>0</impressions></frequencyCap>
+                      </entries>
+                      <entries>
+                        <id>16</id><name>Campaign name 2</name><status>ACTIVE</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>150</impressions></frequencyCap>
+                      </entries>
+                    </rval>
+                  </getResponse>
+                </soap:Body>
+                </soap:Envelope>',
+      :headers => {'content-type' => 'text/xml;'}
+    )
+end
+
+def run_asserts()
+  assert_equal(2, $latest_result[:total_num_entries])
+  assert_equal('CampaignPage', $latest_result[:page_type])
+  entries = $latest_result[:entries]
+  assert_equal(2, entries.size)
+
+  if entries[0][:id] == 15
+    assert_campaign_15(entries[0])
+    assert_campaign_16(entries[1])
+  else
+    assert_campaign_15(entries[1])
+    assert_campaign_16(entries[0])
+  end
+end
+
+def assert_campaign_15(entry)
+  assert_equal(15, entry[:id])
+  assert_equal('Campaign name 1', entry[:name])
+  assert_equal('PAUSED', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>0}, entry[:frequency_cap])
+end
+
+def assert_campaign_16(entry)
+  assert_equal(16, entry[:id])
+  assert_equal('Campaign name 2', entry[:name])
+  assert_equal('ACTIVE', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>150}, entry[:frequency_cap])
+end

data/test/templates/v201603/basic_operations_get_campaigns.def

@@ -0,0 +1,116 @@
+def setup_mocks()
+  $api_config = {
+    :service => {:environment => 'PRODUCTION'},
+    :authentication => {
+      :method => 'OAuth2',
+      :oauth2_client_id => 'client_id123',
+      :oauth2_client_secret => 'client_secret123',
+      :developer_token => 'dev_token123',
+      :client_customer_id => '123-456-7890',
+      :user_agent => 'ruby-tests',
+      :oauth2_token => {
+        :refresh_token => 'refresh_token123'
+      }
+    }
+  }
+
+  stub_request(:post, "https://accounts.google.com/o/oauth2/auth").
+    with(:body => {"client_id"=>"client_id123", "client_secret"=>"client_secret123", "refresh_token"=>"refresh_token123", "grant_type"=>"refresh_token"}).
+    to_return(:status => 200, :body => '{"access_token":"access_token123","token_type":"Bearer","expires_in":"3600"}\n', :headers => {})
+
+  stub_request(:post, "https://adwords.google.com/api/adwords/cm/v201603/CampaignService").
+    with(
+      :body =>
+      # autogenerated code
+        {"env:Envelope"=>
+          {"env:Header"=>
+            {"wsdl:RequestHeader"=>
+              {"userAgent"=>/ruby-tests.*AwApi\-Ruby.*Common\-Ruby/,
+               "developerToken"=>"dev_token123",
+               "clientCustomerId"=>"123-456-7890",
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201603"}},
+           "env:Body"=>
+            {"get"=>
+              {"serviceSelector"=>
+                {"fields"=>["Id", "Name", "Status"],
+                 "ordering"=>{"field"=>"Name", "sortOrder"=>"ASCENDING"},
+                 "paging"=>{"startIndex"=>"0", "numberResults"=>"5"}},
+               "xmlns"=>"https://adwords.google.com/api/adwords/cm/v201603"}},
+           "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+           "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+           "xmlns:wsdl"=>"https://adwords.google.com/api/adwords/cm/v201603",
+           "xmlns:env"=>"http://schemas.xmlsoap.org/soap/envelope/"}},
+      # end of auto-generated code.
+      :headers => {
+        'SOAPAction' => '"get"',
+        'Content-Type' => 'text/xml;charset=UTF-8'
+      }
+    ).
+    to_return(
+      :status => 200,
+      :body => '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+                <soap:Header>
+                  <ResponseHeader xmlns="https://adwords.google.com/api/adwords/cm/v201603">
+                    <requestId>0004c</requestId>
+                    <serviceName>CampaignService</serviceName>
+                    <methodName>get</methodName>
+                    <operations>42</operations>
+                    <responseTime>84</responseTime>
+                    <units>42</units>
+                  </ResponseHeader>
+                </soap:Header>
+                <soap:Body>
+                  <getResponse xmlns="https://adwords.google.com/api/adwords/cm/v201603">
+                    <rval>
+                      <totalNumEntries>2</totalNumEntries>
+                      <Page.Type>CampaignPage</Page.Type>
+                      <totalBudget>
+                        <period>DAILY</period><amount><ComparableValue.Type>Money</ComparableValue.Type>
+                        <microAmount>0</microAmount></amount>
+                      </totalBudget>
+                      <entries>
+                        <id>15</id><name>Campaign name 1</name><status>PAUSED</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>0</impressions></frequencyCap>
+                      </entries>
+                      <entries>
+                        <id>16</id><name>Campaign name 2</name><status>ACTIVE</status><campaignStats><network>ALL</network>
+                        <Stats.Type>CampaignStats</Stats.Type></campaignStats><frequencyCap><impressions>150</impressions></frequencyCap>
+                      </entries>
+                    </rval>
+                  </getResponse>
+                </soap:Body>
+                </soap:Envelope>',
+      :headers => {'content-type' => 'text/xml;'}
+    )
+end
+
+def run_asserts()
+  assert_equal(2, $latest_result[:total_num_entries])
+  assert_equal('CampaignPage', $latest_result[:page_type])
+  entries = $latest_result[:entries]
+  assert_equal(2, entries.size)
+
+  if entries[0][:id] == 15
+    assert_campaign_15(entries[0])
+    assert_campaign_16(entries[1])
+  else
+    assert_campaign_15(entries[1])
+    assert_campaign_16(entries[0])
+  end
+end
+
+def assert_campaign_15(entry)
+  assert_equal(15, entry[:id])
+  assert_equal('Campaign name 1', entry[:name])
+  assert_equal('PAUSED', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>0}, entry[:frequency_cap])
+end
+
+def assert_campaign_16(entry)
+  assert_equal(16, entry[:id])
+  assert_equal('Campaign name 2', entry[:name])
+  assert_equal('ACTIVE', entry[:status])
+  assert_equal({:network=>"ALL", :stats_type=>"CampaignStats"}, entry[:campaign_stats])
+  assert_equal({:impressions=>150}, entry[:frequency_cap])
+end