Esta biblioteca cliente simplifica el acceso a la API SOAP de Google Ad Manager. La biblioteca proporciona formas sencillas de almacenar su autenticación y crear clientes de servicios web SOAP. También contiene código de ejemplo para ayudarle a comenzar a integrarse con nuestras API.
Descargue e instale la biblioteca
setuptools es un requisito previo para instalar la biblioteca de Googleads
Se recomienda instalar la biblioteca y sus dependencias desde PyPI usando pip. Esto se puede lograr con un solo comando:
$ pip install googleads
Como alternativa, puede descargar la biblioteca como archivo tar. Para iniciar la instalación, navegue hasta el directorio que contiene la biblioteca cliente descomprimida descargada y ejecute el script "setup.py" de la siguiente manera:
$ python setup.py build install
Copie el archivo googleads.yaml a su directorio de inicio.
Esto se utilizará para almacenar credenciales y otras configuraciones que se pueden cargar para inicializar un cliente.
Configure sus credenciales de OAuth2
La API de Ad Manager utiliza OAuth2 como autenticación.
mecanismo. Siga la guía adecuada a continuación según su caso de uso.
Si accede a una API utilizando sus propias credenciales...
Si accede a una API en nombre de clientes...
Desarrollar una aplicación web (Ad Manager)
Usando el Administrador de anuncios
Puede encontrar ejemplos de código para las últimas versiones de Ad Manager en la página de lanzamientos.
Como alternativa, puede encontrar ejemplos de Ad Manager en el directorio de ejemplos de este repositorio.
Es posible almacenar en caché la información de autenticación de su API. La biblioteca incluye un archivo de muestra que muestra cómo hacer esto llamado googleads.yaml . Complete los campos de la API y las funciones que planea utilizar. Los métodos LoadFromStorage de la biblioteca buscan de forma predeterminada un archivo con este nombre en su directorio de inicio, pero puede pasar una ruta a cualquier archivo con el contenido yaml correcto.
# Utilice la ubicación predeterminada: su directorio de inicio:ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage()# Alternativamente, pase la ubicación del archivo:ad_manager_client = ad_manager.AdManagerClient.LoadFromStorage('C:MyDirectorygoogleads.yaml')Si tiene problemas directamente relacionados con la biblioteca cliente, utilice el rastreador de problemas.
Si tiene problemas relacionados con una API específica, utilice los foros de soporte del producto:
Administrador de anuncios
La biblioteca utiliza el marco de registro integrado de Python. Puede especificar su configuración a través del archivo de configuración; consulte googleads.yaml para ver un ejemplo.
Alternativamente, puede especificar manualmente su configuración de registro. Por ejemplo, si desea registrar sus interacciones SOAP en la salida estándar y está utilizando la biblioteca SOAP de Zeep, puede hacer lo siguiente:
logging.basicConfig(level=logging.INFO, format=googleads.util.LOGGER_FORMAT)logging.getLogger('googleads.soap').setLevel(logging.DEBUG)Si desea iniciar sesión en un archivo, deberá adjuntar un controlador de registro a esta fuente que esté configurado para escribir la salida en un archivo.
El complemento zeep utilizado para registrar elimina datos confidenciales de su salida. Si desea que estos datos se incluyan en los registros, deberá implementar su propio complemento de registro simple. Por ejemplo:
clase DangerousZeepLogger(zeep.Plugin): def ingreso(self, sobre, http_headers, operación):logging.debug('Respuesta entrante: n%s', etree.tostring(sobre, Pretty_print=True))retorno sobre, http_headers
def egress(self, sobre, http_headers, operación, vinculante_opciones):logging.debug('Respuesta entrante: n%s', etree.tostring(sobre, Pretty_print=True))sobre de retorno, http_headersad_manager_client.zeep_client.plugins.append(DangerousZeepLogger ())De forma predeterminada, los clientes se almacenan en caché porque leer y digerir el WSDL puede resultar costoso. Sin embargo, el método de almacenamiento en caché predeterminado requiere permiso para acceder a un sistema de archivos local que puede no estar disponible en determinados entornos de alojamiento, como App Engine.
Puede pasar una implementación de zeep.cache.Base al inicializador AdManagerClient para modificar el comportamiento de almacenamiento en caché predeterminado.
Por ejemplo, configurar una ubicación y duración diferentes del archivo de caché con zeep
doc_cache = zeep.cache.SqliteCache(ruta=cache_path)ad_manager_client = ad_manager.AdManagerClient( oauth2_client, nombre_aplicación, código_red=código_red, caché=doc_cache)
También puedes desactivar el almacenamiento en caché de manera similar con zeep.
ad_manager_client = ad_manager.AdManagerClient( oauth2_client, nombre_aplicación, código_red=código_red, caché=googleads.common.ZeepServiceProxy.NO_CACHE)
Esta biblioteca solo es compatible con Python 3.7+.
- httplib2 -- https://pypi.python.org/pypi/httplib2/ - oauth2client -- https://pypi.python.org/pypi/oauth2client/ - pysocks -- https://pypi.python.org/pypi/PySocks/ - pytz -- https://pypi.python.org/pypi/pytz - pyYAML -- https://pypi.python.org/pypi/pyYAML/ - xmltodict -- https://pypi.python.org/pypi/xmltodict/ - zeep -- https://pypi.python.org/pypi/zeep - mock -- https://pypi.python.org/pypi/mock (only needed to run unit tests) - pyfakefs -- https://pypi.python.org/pypi/pyfakefs (only needed to run unit tests)
Mark Saniscalchi David Wihl Ben Karl
