• Stars
    star
    192
  • Rank 202,019 (Top 4 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created over 10 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Samples for the Content API for Shopping and the Manufacturer Center API

Samples for the Content API for Shopping and Manufacturer Center API

These code samples are organized by platform or language. Each language directory contains a README with more information about how to run the samples for that particular language. Here, we cover setting up authentication and the common configuration file used by all the samples.

For more information on the APIs, please refer to the documentation for the Content API for Shopping and the Manufacturer Center API.

Choose Your Method of Authentication

Before getting started, check the Getting Started section of the Content API for Shopping documentation. You may want to use service accounts instead to simplify the authentication flow. These samples also support using Google Application Default Credentials.

Setting up authentication for the Manufacturer Center API is similar to the Content API. Just make sure to select the Manufacturer Center API in the API Console. Both APIs can be selected if you wish to try samples for both APIs.

Setting up Authentication and Sample Configuration

  1. Create the directory $(HOME)/shopping-samples to store the configuration.

    If you are unsure where this will be located in your particular setup, then run the samples (following the language-specific README). Errors from the samples related to either this directory or necessary files not existing will provide the full path to the expected directory/files.

    Within this directory, also create the following subdirectories, depending on which API you would like to try:

    • content for the Content API for Shopping
    • manufacturers for the Manufacturer Center API

    Place the files described below in the appropriate subdirectory for the API you want to try.

  2. Set up your desired authentication method.

    If you are using Google Application Default Credentials:

    If you are using a service account:

    • Put the JSON file you downloaded when creating the service account to the file service-account.json in the appropriate API configuration subdirectories.

    If you are using an OAuth2 client ID:

    • Download your OAuth2 client credentials to the file client-secrets.json in the appropriate API configuration subdirectories.

      Note: The samples assume that you are using an OAuth2 client ID that can use a loopback IP address to retrieve tokens. If you are not or are unsure that you are, please visit the [OAuth2.0 for Mobile & Desktop Apps] (https://developers.google.com/identity/protocols/OAuth2InstalledApp) page and follow the instructions there to create a new OAuth2 client ID to use with the samples.

    You can set up multiple authentication methods to try out different flows, but note that the samples will always use the first credentials that can be loaded, in the order:

    1. Google Application Default Credentials
    2. Service accounts credentials
    3. OAuth2 client credentials
  3. Each set of samples uses a different configuration file. For the Content API for Shopping, take the example merchant-info.json from the repository root and copy it into $(HOME)/shopping-samples/content. Next, change its contents appropriately. It contains a JSON object with the following fields:

    Field Type Description
    merchantId number The Merchant Center ID to run samples against.
    accountSampleUser string If non-empty, the email address for the user to add/remove in samples for the Accounts service.
    accountSampleAdWordsCID number If non-zero, the AdWords Customer ID to link/unlink in samples for the Accounts service.

    For the Manufacturer Center API, take the example manufacturer-info.json from the repository root and copy it into $(HOME)/shopping-samples/manufacturers. Next, change its contents appropriately. It contains a JSON object with the following fields:

    Field Type Description
    manufacturerId number The Manufacturer Center ID to run samples against.
    websiteUrl string The URL (without trailing slash) associated with the Manufacturer Center account.

    If using OAuth2 client credentials, once you have authorized access, your token details will be stored in the stored-token.json file in the samples configuration directory. If you have any issues authenticating, remove this file and you will be asked to re-authorize access.

Try Out the Samples

Now that you've configured both the common sample configuration file and set up your authentication credentials, it's time to build and run any of the included samples. As mentioned before, there are language-specific instructions in the READMEs located in each language subdirectory. Have fun!

Possible Issues

  • When using the Content API for Shopping, if you haven't set up tax settings on your account, you may get an error when running certain samples. If you receive a "missing tax settings" error, set your tax settings in the Merchant Center before trying these samples. Selecting the "Don't charge taxes in the United States" setting is sufficient.

More Repositories

1

googleads-mobile-android-examples

googleads-mobile-android
Java
1,693
star
2

googleads-mobile-unity

Official Unity Plugin for the Google Mobile Ads SDK
C#
1,355
star
3

googleads-mobile-ios-examples

googleads-mobile-ios
Objective-C
953
star
4

googleads-python-lib

The Python client library for Google's Ads APIs
Python
678
star
5

googleads-php-lib

Google Ad Manager SOAP API Client Library for PHP
PHP
657
star
6

google-ads-python

Google Ads API Client Library for Python
Python
498
star
7

videojs-ima

IMA SDK Plugin for Video.js
JavaScript
449
star
8

googleads-mobile-flutter

A Flutter plugin for the Google Mobile Ads SDK
Java
341
star
9

google-api-ads-ruby

Ad Manager SOAP API Client Libraries for Ruby
Ruby
297
star
10

google-ads-php

Google Ads API Client Library for PHP
PHP
295
star
11

googleads-ima-html5

Samples for the HTML5 IMA SDK.
JavaScript
260
star
12

googleads-mobile-android-mediation

Sample Android project showcasing how to build a mediation adapter or custom event for the Google Mobile Ads SDK.
Java
240
star
13

googleads-java-lib

Google Ad Manager SOAP API Client Library for Java
Java
226
star
14

google-ads-java

Google Ads API Client Library for Java
Java
167
star
15

google-media-framework-android

[DEPRECATED] The Google Media Framework (GMF) is a lightweight media player designed to make video playback and integration with the Google IMA SDK on Android easier.
Java
155
star
16

googleads-adsense-examples

Samples for the AdSense Management API
Java
142
star
17

swift-package-manager-google-mobile-ads

Swift
133
star
18

googleads-mobile-ios-mediation

Objective-C
118
star
19

googleads-mobile-android-native-templates

Java
116
star
20

googleads-ima-android

Samples for the IMA Android SDK.
Java
114
star
21

googleads-dotnet-lib

Google Ad Manager SOAP API .NET client library
C#
108
star
22

googleads-dfa-reporting-samples

Samples for the DoubleClick for Advertisers Reporting and Trafficking API
C#
106
star
23

googleads-consent-sdk-android

Consent SDK
Java
101
star
24

publisher-ads-lighthouse-plugin

Publisher Ads Audits for Lighthouse is a tool to improve ad speed and overall quality through a series of automated audits. This tool will aid in resolving discovered problems, providing a tool to be used to evaluate effectiveness of iterative changes while suggesting actionable feedback.
JavaScript
98
star
25

google-media-framework-ios

The Google Media Framework (GMF) is a lightweight media player designed to make video playback and integration with the Google IMA SDK on iOS easier.
Objective-C
74
star
26

admob-ads-in-flutter

Dart
73
star
27

google-ads-dotnet

This project hosts the .NET client library for the Google Ads API.
C#
72
star
28

google-ads-ruby

Google Ads API Ruby Client Library
Ruby
70
star
29

googleads-ima-ios

Samples for the iOS IMA SDK.
Objective-C
57
star
30

googleads-bidmanager-examples

PHP
42
star
31

googleads-admob-api-samples

googleads-admob-api-samples
Java
40
star
32

admob-inline-ads-in-flutter

Dart
40
star
33

google-publisher-tag-samples

Google Publisher Tag (GPT) code samples.
TypeScript
36
star
34

googleads-adxbuyer-examples

Samples for the DoubleClick Ad Exchange Buyer REST API
C#
34
star
35

googleads-ima-html5-dai

JavaScript
33
star
36

google-ads-doctor

Go
31
star
37

googleads-consent-sdk-ios

Consent SDK
Objective-C
31
star
38

googleads-adxseller-examples

Samples for the DoubleClick Ad Exchange Seller REST API
Java
20
star
39

googleads-ima-roku-dai

Brightscript
15
star
40

google-ads-perl

Google Ads API Client Library for Perl
Perl
15
star
41

googleads-mobile-ios-native-templates

Objective-C
14
star
42

dfp-playground

JavaScript
14
star
43

googleads-ima-tvos-dai

Objective-C
11
star
44

adwords-scripts-linkchecker

App Engine-based link checker for AdWords Scripts and Apps Script
Java
11
star
45

googleads-ima-cast

Samples for the Chromecast IMA SDK
JavaScript
10
star
46

googleads-displayvideo-examples

Display & Video 360 (DV360) API code samples.
Java
10
star
47

angular-dfp

Semantic DoubleClick integration with AngularJS
JavaScript
10
star
48

authorized-buyers-rtb-api-samples

C#
9
star
49

googleads-dynamic-ad-insertion

JavaScript
9
star
50

googleads-dfp-java-dfp-playground

DFP API Playground
Java
9
star
51

googleads-viewability-insights-extension

A DevTools extension for inspecting the viewability of Ad Manager Ads.
JavaScript
9
star
52

app-conversion-solutions

App Conversion Solutions with Google Ads API
Java
8
star
53

google-publisher-tag-types

Automatically generated TypeScript type definitions for the Google Publisher Tag JavaScript API
TypeScript
8
star
54

mobilevsi-android

Java
7
star
55

googleads-ima-android-dai

Java
7
star
56

googleads-dfa-samples

Samples for the DoubleClick for Advertisers API
PHP
7
star
57

googleads-ima-cast-dai

JavaScript
6
star
58

admob-firebase-codelabs-android

Kotlin
6
star
59

googleads-ima-tvos-client-side

Objective-C
6
star
60

googleads-perl-lib

AdWords API Perl Client Library
Perl
5
star
61

googleads-ima-ios-dai

Objective-C
5
star
62

html5-to-dfp

Python
5
star
63

admob-firebase-codelabs-unity

C#
5
star
64

swift-package-manager-google-user-messaging-platform

Swift
5
star
65

googleads-pal-webapp

An app demonstrating PAL SDK
TypeScript
4
star
66

googleads-ima-tizen-dai

JavaScript
4
star
67

gpt-ad

A Polymer element for defining GPT Ads in Polymer apps.
HTML
4
star
68

swift-package-manager-google-programmatic-access-library-ios

Swift
4
star
69

admob-appopen-unity

C#
3
star
70

swift-package-manager-google-interactive-media-ads-tvos

Swift
3
star
71

gpt-light-ad

HTML
3
star
72

swift-package-manager-google-programmatic-access-library-tvos

Swift
2
star
73

authorized-buyers-marketplace-api-samples

C#
2
star
74

swift-package-manager-google-interactive-media-ads-ios

Swift
2
star
75

conf-data-processing-architecture-reference-sample

2
star
76

hbbtv-lshape-demo

JavaScript
2
star
77

googleads-pal

Java
2
star
78

search-campaign-setup-booster

Python
2
star
79

google-publisher-tag-playground

An interactive code playground for Google Publisher Tag (GPT) samples.
TypeScript
2
star
80

comparison-shopping-service-api-samples

Code samples for the Comparison Shopping Service API (CSS API)
Java
1
star
81

.allstar

1
star
82

.github

1
star