Instalar una biblioteca cliente

A continuación, se explica cómo instalar y configurar una biblioteca cliente o REST.

Requisitos previos

Antes de instalar una biblioteca cliente, completa los pasos que se indican en Configura el acceso a la API, incluida la configuración de las credenciales predeterminadas de la aplicación (ADC).

Pasos de instalación

En tu máquina local, instala la biblioteca cliente que prefieras:

REST

  1. Actualiza los marcadores de posición del siguiente ejemplo, como OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID, y AUDIENCE_ID, con los valores de tu cuenta y destino.
  2. Reemplaza PROJECT_ID por el ID de tu Google Cloud.
  3. Copia el ejemplo en la línea de comandos para enviar la solicitud. Solo usa el ejemplo de Socio de datos si accedes a la cuenta operativa a través de un vínculo de socio. De lo contrario, usa el ejemplo de Anunciante.

    Anunciante

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so this sample falls back to the command
    # without the --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
    gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If you
    # get scope-related errors when you send the request in the next step,
    # verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
    --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
    --header "x-goog-user-project: PROJECT_ID" \
    --header "Content-Type: application/json" \
    --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

    Socio de datos

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so this sample falls back to the command
    # without the --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
    gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If
    # you get scope-related errors when you send the request in the next
    # step, verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
    --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
    --header "x-goog-user-project: PROJECT_ID" \
    --header "Content-Type: application/json" \
    --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "accountType": "LINKED_ACCOUNT_TYPE",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

.NET

Instala la biblioteca cliente

Sigue las instrucciones de la guía de instalación de la biblioteca cliente de.NET para agregar una dependencia a la biblioteca cliente en tu proyecto.

Opcional: Obtén la biblioteca de utilidades y las muestras de código.

  1. Clona el repositorio de GitHub.

    git clone https://github.com/googleads/data-manager-dotnet.git
    
  2. En tu proyecto de .NET, declara una dependencia ProjectReference en la biblioteca de utilidades. Reemplaza PATH_TO_UTILITY_LIBRARY por la ubicación en la que clonaste el data-manager-dotnet repositorio.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
    
  3. Para dar formato a los datos, usa la utilidad Formatter en tu proyecto de .NET.

  4. Explora las muestras de código en el samples subdirectorio o en GitHub.

    Cambia al directorio samples y usa dotnet run para obtener la lista de muestras disponibles.

    dotnet run
    

    Pasa el argumento --help cuando ejecutes una muestra para imprimir una declaración de uso con los parámetros esperados.

    dotnet run -- ingest-audience-members --help
    

    Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en samples/sampledata/audience_members_1.csv.

Java

Instala la biblioteca cliente

Sigue las instrucciones de la guía de instalación de la biblioteca cliente de Java para agregar una dependencia a la biblioteca cliente en tu proyecto.

Opcional: Obtén la biblioteca de utilidades y las muestras de código.

  1. Clona el repositorio de GitHub.

    git clone https://github.com/googleads/data-manager-java.git
    
  2. Navega al directorio data-manager-java.

  3. Compila y publica la biblioteca de utilidades en tu repositorio local de Maven.

    ./gradlew data-manager-util:install
    
  4. En tu proyecto de Java, declara una dependencia en la biblioteca de utilidades.

    Gradle:

    implementation 'com.google.api-ads:data-manager-util:0.2.0'
    

    Maven:

    <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>data-manager-util</artifactId>
       <version>0.2.0</version>
    </dependency>
    
  5. Para dar formato a los datos y encriptarlos, usa las utilidades UserDataFormatter y Encrypter en tu proyecto de Java.

  6. Explora las muestras de código en el data-manager-samples subdirectorio o en GitHub. Para ejecutar una muestra desde la línea de comandos, usa la tarea run de Gradle.

    Por ejemplo, el siguiente comando ejecuta la muestra IngestAudienceMembers e imprime una declaración de uso:

    ./gradlew data-manager-samples:run \
       --args='IngestAudienceMembers --help'
    

    Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.

Node.js

Instala la biblioteca cliente

Sigue las instrucciones de la guía de instalación de la biblioteca cliente de Node.js para agregar una dependencia a la @google-ads/datamanager biblioteca cliente en tu proyecto.

Opcional: Obtén la biblioteca de utilidades y las muestras de código.

  1. Clona el repositorio de GitHub.

    git clone https://github.com/googleads/data-manager-node.git
    
  2. Navega al directorio data-manager-node.

  3. Ejecuta el siguiente comando para instalar las dependencias.

    npm install
    
  4. Cambia al directorio util.

    cd util
    
  5. Ejecuta el siguiente comando para compilar y empaquetar la biblioteca de utilidades en un archivo .tgz para usar con npm.

    npm pack
    

    El comando genera un archivo llamado google-ads-datamanager-util-0.2.0.tgz. Toma nota de la ubicación del archivo para poder usarlo en los próximos pasos.

  6. En tu proyecto de Node.js, declara una dependencia en la biblioteca de utilidades de la API de Data Manager agregando una entrada dependencies para la ruta de acceso completa y el nombre de archivo del archivo google-ads-datamanager-util-0.2.0.tgz.

    {
       "dependencies": {
          ...
          "@google-ads/data-manager-util": "file:PATH_TO_UTILITY_LIBRARY/google-ads-datamanager-util-0.2.0.tgz",
          ...
       }
    }
    

    Para dar formato a los datos, usa la utilidad UserDataFormatter en tu proyecto de Node.js.

  7. Explora las muestras de código en el samples subdirectorio o en GitHub. Ejecuta las muestras con los siguientes pasos:

    1. Navega al directorio data-manager-node.

    2. Ejecuta las muestras y pasa los argumentos requeridos. Pasa el argumento --help cuando ejecutes una muestra para imprimir una declaración de uso con los parámetros esperados.

      Por ejemplo, el siguiente comando ejecuta la muestra ingest_audience_members e imprime una declaración de uso:

      npm run ingest-audience-members -w samples -- --help
      

    Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en samples/sampledata/audience_members_1.csv.

PHP

Instala la biblioteca cliente

Sigue las instrucciones de la guía de instalación de la biblioteca cliente de PHP para agregar una dependencia a la googleads/data-manager biblioteca cliente en tu proyecto.

Opcional: Obtén la biblioteca de utilidades y las muestras de código.

  1. Clona el repositorio de GitHub.

    git clone https://github.com/googleads/data-manager-php.git
    
  2. Navega al directorio data-manager-php.

  3. Ejecuta el siguiente comando para resolver las dependencias de la biblioteca:

    composer update --prefer-dist
    
  4. En el archivo composer.json de tu proyecto de PHP en el mismo host, declara una dependencia en la biblioteca de utilidades con los siguientes pasos:

    1. Agrega una entrada en la sección repositories que apunte a la ubicación del directorio data-manager-php.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_UTILITY_LIBRARY"
         }
      ]
      
    2. Declara una dependencia en la biblioteca de utilidades.

      "require": {
         "googleads/data-manager-util": "@dev"
      }
      

    Para dar formato a los datos, usa la utilidad Formatter en tu proyecto de PHP.

  5. Explora las muestras de código en el samples subdirectorio o en GitHub. Ejecuta las muestras con los siguientes pasos:

    1. Navega al directorio samples.

    2. Ejecuta el siguiente comando para resolver las dependencias de la biblioteca:

      composer update --prefer-dist
      
    3. Ejecuta las muestras y pasa los argumentos requeridos. Pasa el argumento --help cuando ejecutes una muestra para imprimir una declaración de uso con los parámetros esperados.

    Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en samples/sampledata/audience_members_1.csv.

Python

Instala la biblioteca cliente

Sigue las instrucciones de la guía de instalación de la biblioteca cliente de Python para agregar una dependencia a la google-ads-datamanager biblioteca cliente en tu proyecto.

Opcional: Obtén la biblioteca de utilidades y las muestras de código.

  1. Clona el repositorio de GitHub.

    git clone https://github.com/googleads/data-manager-python.git
    
  2. Navega al directorio data-manager-python.

  3. Para instalar la biblioteca de utilidades en tu entorno de Python, ejecuta el siguiente comando:

    pip install .
    
  4. En tu proyecto de Python, declara una dependencia en la biblioteca de utilidades. Por ejemplo, si usas un archivo requirements.txt en tu proyecto, agrega la siguiente línea al archivo:

    google-ads-datamanager-util=0.2.0
    
  5. Para dar formato a los datos y encriptarlos, usa las utilidades Formatter y Encrypter en tu proyecto de Python.

  6. Explora las muestras de código en el samples subdirectorio o en GitHub. Para ejecutar muestras, instala las dependencias necesarias:

    pip install .[samples]
    

    Pasa el argumento --help cuando ejecutes una muestra para imprimir una declaración de uso con los parámetros esperados.

    Para ayudarte a comenzar con algunos datos de muestra, usa el archivo en samples/sampledata/audience_members_1.csv.

Ruby

Instala la biblioteca cliente

Sigue las instrucciones de la guía de instalación de la biblioteca cliente de Ruby para agregar una dependencia a la biblioteca cliente en tu proyecto.

Próximos pasos