Skip to content

Commit

Permalink
added basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix committed Jun 4, 2017
1 parent e4a00da commit 1ac605e
Showing 1 changed file with 38 additions and 5 deletions.
43 changes: 38 additions & 5 deletions README.md
Expand Up @@ -14,7 +14,7 @@
This package can be installed through Composer.

``` bash
$ composer require schulzefelix/laravel-adwords
$ composer require schulzefelix/laravel-adwords-targeting-idea-service
```

You must install this service provider.
Expand Down Expand Up @@ -46,13 +46,46 @@ php artisan vendor:publish --provider="SchulzeFelix\AdWords\AdWordsServiceProvid
```

## Usage
All methods will return an `Illuminate\Support\Collection`-instance.

- [Introduction](#introduction)
Here are two basic example to retrieve search volumes for several keywords and new keyword ideas for a given word.
### Search Volumes

```php
$searchVolumes = AdWords::searchVolumes(['cheesecake', 'coffee']);
```

### Keyword Ideas

```php
$keywordIdeas = AdWords::keywordIdeas('coffee');
```

## Provided fluent configuration

### Set Location
For Criteria ID see [https://developers.google.com/adwords/api/docs/appendix/geotargeting](https://developers.google.com/adwords/api/docs/appendix/geotargeting)
```php
AdWords::location(2276)->searchVolumes(['cheesecake', 'coffee']);
```

### Set Language
For Criteria ID see [https://developers.google.com/adwords/api/docs/appendix/codes-formats#languages](https://developers.google.com/adwords/api/docs/appendix/codes-formats#languages)
```php
AdWords::location(2276)->language(1001)->searchVolumes(['cheesecake', 'coffee']);
```

### Include Targeted Monthly Searches
```php
AdWords::withTargetedMonthlySearches()->searchVolumes(['cheesecake', 'coffee']);
```

### Include And Exclude Words For Keyword Ideas
```php
AdWords::location(2642)->withTargetedMonthlySearches()->exclude(['iphone'])->include(['apple'])->keywordIdeas('iphone')
```


<a name="introduction"></a>
## Introduction
Coming Soon

## Change log

Expand Down

0 comments on commit 1ac605e

Please sign in to comment.