Aplikasi Pertama Anda: Prasyarat
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Sebelum dapat memulai coding aplikasi klien pertama Anda, ada beberapa hal yang
perlu dilakukan, jika Anda belum melakukannya.
Membuat Akun Google dan mendapatkan izin Search Ads 360
Untuk menggunakan Search Ads 360 API, Anda memerlukan Akun Google dan izin yang sesuai
yang diberikan ke akun tersebut dari Search Ads 360:
Jika Anda belum memiliki Akun Google,
buat akun.
Minta Pengelola Agensi Search Ads 360 untuk
membuat pengguna Search Ads 360 untuk Akun Google Anda.
Untuk mendownload laporan, Anda memerlukan izin lihat untuk pengiklan
yang akan bekerja sama dengan Anda.
Untuk menambahkan atau mengedit konversi, Anda memerlukan izin edit untuk pengiklan
yang akan bekerja sama dengan Anda. Dalam konfigurasi Floodlight bersama, Anda memerlukan izin edit untuk setiap pengiklan turunan yang ingin Anda upload konversinya.
Anda tidak memerlukan akses ke pengiklan induk, dan Anda juga tidak memerlukan akses ke pengiklan turunan jika konversi tidak diupload ke akun tersebut. Jika Anda menggunakan ID klik untuk
mengatribusikan
konversi ke kunjungan, pastikan Anda memiliki akses edit ke pengiklan yang membuat
ID klik. Jika Anda menentukan ID klik dari pengiklan yang akses editnya tidak Anda miliki,
permintaan tidak akan berhasil.
Pengelola Agensi dapat menyiapkan akun Anda sebagai Pengguna pengiklan dengan akses ke pengiklan tertentu, atau menyiapkan akun Anda dengan tingkat akses yang lebih tinggi seperti Pengguna agensi dengan akses ke semua pengiklan di agensi.
Aktifkan Layanan Konversi API
Jika Anda ingin mengupload data tentang konversi, pengguna Search Ads 360 dengan hak istimewa Agency
Manager harus login ke UI Search Ads 360 dan
mengaktifkan layanan konversi API. Lihat
pusat bantuan
Search Ads 360 untuk mendapatkan petunjuk.
Membuat project Konsol API Google dan kredensial OAuth untuk klien Anda
- Mulai
alat penyiapan Konsol API Google.
Alat penyiapan memandu Anda membuat project (atau menggunakan project yang ada),
mengaktifkan Search Ads 360 API, dan membuat kredensial OAuth 2.0.
- Pada halaman Register your application, pilih project yang sudah ada atau pilih Create a project. Selanjutnya, klik Lanjutkan.
- Setelah Konsol API Google mengaktifkan Search Ads 360 API, klik tombol Go to credentials.
- Di halaman Create credentials, masukkan informasi berikut:
-
API mana yang Anda gunakan?: Search Ads 360 API
-
Data apa yang akan Anda akses?: Data pengguna
- Klik tombol Berikutnya.
Alat penyiapan kini menawarkan untuk membantu Anda membuat client ID OAuth 2.0.
- Ikuti langkah-langkah lainnya di alat penyiapan.
Menginstal sa360Api.py
Search Ads 360 menyediakan skrip utilitas untuk memfasilitasi proses penyiapan
otorisasi. Anda juga dapat menggunakan skrip ini untuk mengirim dan menerima data dalam format JSON,
jika ingin mencoba mengirim dan menerima data sebelum mendesain dan menulis aplikasi
lengkap. Anda dapat menyalin banyak contoh JSON di situs dokumentasi ini dan memasukkannya langsung ke skrip.
Untuk menginstal skrip:
- Instal Python 2.7.
Skrip tidak berfungsi dengan Python 3.x.
- Instal cURL.
- Download sa360Api.zip.
- Ekstrak
sa360Api.py
dari sa360Api.zip
.
- Jadikan
sa360Api.py
dapat dieksekusi.
Mempelajari dasar-dasar REST
Ada dua cara untuk memanggil API:
- Menggunakan library klien.
- Mengirim permintaan HTTP dan mengurai respons.
Jika memutuskan untuk tidak menggunakan library klien, Anda harus memahami dasar-dasar REST.
REST adalah gaya arsitektur software yang memberikan pendekatan yang praktis dan konsisten untuk meminta dan memodifikasi data.
Istilah REST adalah singkatan dari "Representational State Transfer". Dalam konteks Google API, REST merujuk pada penggunaan kata kerja HTTP untuk mengambil dan memodifikasi representasi data yang disimpan oleh Google.
Dalam sistem RESTful, resource disimpan di penyimpanan data; klien mengirim permintaan agar server melakukan tindakan tertentu (seperti membuat, mengambil, memperbarui, atau menghapus resource), dan server melakukan tindakan dan mengirim respons, sering kali dalam bentuk representasi resource yang ditentukan.
Di RESTful API Google, klien menentukan tindakan menggunakan kata kerja HTTP seperti POST
, GET
, PUT
, atau DELETE
. Kata kerja ini menentukan resource berdasarkan URI yang unik secara global untuk form berikut:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Karena semua resource API memiliki URI unik yang dapat diakses HTTP, REST memungkinkan caching data dan dioptimalkan untuk berfungsi dengan infrastruktur terdistribusi web.
Anda dapat memperoleh manfaat dari definisi metode dalam dokumentasi standar HTTP 1.1; dokumentasi tersebut menyertakan spesifikasi untuk GET
, POST
, PUT
, dan DELETE
.
REST di Search Ads 360 API
Operasi Search Ads 360 API dipetakan langsung ke kata kerja HTTP REST.
Format khusus untuk URI Search Ads 360 API adalah:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
Kumpulan lengkap URI yang digunakan untuk setiap operasi yang didukung dalam API diringkas dalam Referensi API.
Mempelajari dasar-dasar JSON
Jika menggunakan REST, Anda harus menggunakan format JSON untuk isi permintaan. Anda dapat menentukan respons dalam format JSON atau CSV.
JSON (JavaScript Object Notation) adalah format data umum independen bahasa yang memberikan representasi teks sederhana untuk struktur data arbitrer. Untuk informasi selengkapnya, lihat json.org.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2024-11-07 UTC.
[null,null,["Terakhir diperbarui pada 2024-11-07 UTC."],[[["\u003cp\u003eBefore using the Search Ads 360 API, ensure you have a Google Account with the necessary Search Ads 360 permissions, which may include view or edit access to specific advertisers.\u003c/p\u003e\n"],["\u003cp\u003eTo upload conversion data, the API Conversion Service must be activated by a Search Ads 360 user with Agency Manager privileges.\u003c/p\u003e\n"],["\u003cp\u003eSet up a Google API Console project and obtain OAuth credentials for your client application to authenticate and authorize API access.\u003c/p\u003e\n"],["\u003cp\u003eInstall the provided \u003ccode\u003esa360Api.py\u003c/code\u003e utility script and familiarize yourself with REST and JSON basics if you plan to interact with the API directly without client libraries.\u003c/p\u003e\n"]]],["To start coding, create a Google Account and request Search Ads 360 permissions from an Agency Manager, who will grant view or edit access to advertisers. Activate the API conversion service via the Search Ads 360 UI. Next, create a Google API Console project and OAuth 2.0 credentials. Install Python 2.7, cURL, and the `sa360Api.py` utility script. Finally, understand REST basics and JSON formatting, crucial for interacting with the API using HTTP requests.\n"],null,["# Your First App: Prerequisites\n\nBefore you can start coding your first client application, there are a few things you\nneed to do, if you haven't done them already.\n\nCreate a Google Account and get Search Ads 360 permissions\n----------------------------------------------------------\n\nTo use the Search Ads 360 API, you need a Google Account and appropriate permissions\ngranted to that account from Search Ads 360:\n\n1. If you don't already have a Google Account, [create one](https://support.google.com/accounts/answer/27441).\n\n2. Ask a Search Ads 360 **Agency Manager** to [create a Search Ads 360 user](https://support.google.com/searchads/answer/6051717) for your Google Account.\n\n To download reports, you'll need **view permission** for the advertisers\n you'll be working with.\n\n To add or edit conversions, you'll need **edit permission** for the advertisers\n you'll be working with. In a\n [shared Floodlight configuration](https://support.google.com/searchads/answer/2458167),\n you need edit permission for each child advertiser you want to upload conversions into.\n You don't need access to the parent advertiser, nor do you need access to child advertisers\n that you're not uploading conversions into. If you use click IDs to\n [attribute\n conversions to visits](/search-ads/v2/how-tos/conversions/insert#attribute-a-conversion-to-a-specific-visit), make sure you have edit access to the advertiser that generated\n the click ID. If you specify a click ID from an advertiser you don't have edit access to,\n the request will not succeed.\n\n The Agency Manager can set up your account as an **Advertiser user** with\n access to specific advertisers,\n or set up your account with a higher level of access such as **Agency user**\n with access to all advertisers in the agency.\n\nActivate the API Conversion Service\n-----------------------------------\n\n\nIf you want to upload data about conversions, a Search Ads 360 user with **Agency\nManager** privileges needs to sign in to the Search Ads 360 UI and\n**activate the API conversion service** . See the\n[Search Ads 360\nhelp center](https://support.google.com/searchads/answer/2604604#activate) for instructions.\n\nCreate a Google API Console project and OAuth credentials for your client\n-------------------------------------------------------------------------\n\n1. Start the Google API Console [setup tool](https://console.cloud.google.com/start/api?id=doubleclicksearch&credential=client_key). \n The setup tool guides you through creating a project (or using an existing project), enabling the Search Ads 360 API, and creating OAuth 2.0 credentials.\n2. On the **Register your application** page, select an existing project or select **Create a project** . Then click **Continue**.\n3. After the Google API Console enables the Search Ads 360 API, click the **Go to credentials** button.\n4. On the **Create credentials** page, enter the following information:\n - **Which API are you using?**: Search Ads 360 API\n - **What data will you be accessing?**: User data\n5. Click the **Next** button.\n\n The setup tool now offers to help you create an **OAuth 2.0 client ID**.\n6. Follow the rest of the steps in the setup tool.\n\nInstall sa360Api.py\n-------------------\n\nSearch Ads 360 provides a utility script to facilitate the process of setting up\nauthorization. You can also use this script to send and receive data in the JSON format,\nif you want to try sending and receiving data before you design and write a full\napplication. You can copy many of the JSON examples in this documentation site and input\nthem directly to the script.\n\nTo install the script:\n\n1. [Install Python](http://www.python.org/getit/) 2.7. \n The script does not work with Python 3.x.\n2. [Install cURL](http://curl.haxx.se/download.html).\n3. [Download sa360Api.zip](https://www.google.com/help/hc/downloads/sa360/sa360Api.zip).\n4. Extract `sa360Api.py` from `sa360Api.zip`.\n5. Make `sa360Api.py` executable.\n\nLearn REST basics\n-----------------\n\nThere are two ways to invoke the API:\n\n- Using [client libraries](/search-ads/v2/libraries).\n- Sending HTTP requests and parsing the responses.\n\nIf you decide not to use client libraries, you'll need to understand the basics of\nREST.\n\nREST is a style of software architecture that provides a convenient and consistent approach to requesting and modifying data.\n\nThe term REST is short for \"[Representational State Transfer](https://en.wikipedia.org/wiki/Representational_state_transfer).\" In the context of Google APIs, it refers to using HTTP verbs to retrieve and modify representations of data stored by Google.\n\nIn a RESTful system, resources are stored in a data store; a client sends a request that the server perform a particular action (such as creating, retrieving, updating, or deleting a resource), and the server performs the action and sends a response, often in the form of a representation of the specified resource.\n\nIn Google's RESTful APIs, the client specifies an action using an HTTP verb such as `POST`, `GET`, `PUT`, or `DELETE`. It specifies a resource by a globally-unique URI of the following form: \n\n```\nhttps://www.googleapis.com/apiName/apiVersion/resourcePath?parameters\n```\n\nBecause all API resources have unique HTTP-accessible URIs, REST enables data caching and is optimized to work with the web's distributed infrastructure.\n\nYou may find the [method definitions](https://tools.ietf.org/html/rfc7231#section-4.3) in the HTTP 1.1 standards documentation useful; they include specifications for `GET`, `POST`, `PUT`, and `DELETE`.\n\n### REST in the Search Ads 360 API\n\nThe Search Ads 360 API operations map directly to REST HTTP verbs.\n\nThe specific format for Search Ads 360 API URIs is: \n\n```\nhttps://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters\n```\n\n\nThe full set of URIs used for each supported operation in the API is summarized in the [API Reference](/search-ads/v2/reference).\n\nLearn JSON basics\n-----------------\n\nIf you use REST, you'll need to use the JSON format for the request bodies. You can\nspecify that the responses be either in the JSON or CSV format.\n\n\n[JSON](http://en.wikipedia.org/wiki/JSON) (JavaScript Object Notation) is a common, language-independent data format that provides a simple text representation of arbitrary data structures. For more information, see [json.org](http://www.json.org/).\n\n\u003cbr /\u003e"]]